Interface QueryUserRootContentsRequestOrBuilder (0.84.0)

public interface QueryUserRootContentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String getFilter()

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

filter="display_name="MyFolder""

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

Optional. Optional filtering for the returned list. Filtering is currently only supported on the display_name field.

Example:

filter="display_name="MyFolder""

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for filter.

getLocation()

public abstract String getLocation()

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The location.

getLocationBytes()

public abstract ByteString getLocationBytes()

Required. Location of the user root folder whose contents to list. Format: projects/*/locations/*

string location = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for location.

getOrderBy()

public abstract String getOrderBy()

Optional. Field to additionally sort results by. Will order Folders before Repositories, and then by order_by in ascending order. Supported keywords: display_name (default), created_at, last_modified_at. Examples:

orderBy="display_name"
orderBy="display_name desc"

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

orderBy="display_name"
orderBy="display_name desc"

string order_by = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

Optional. Maximum number of paths to return. The server may return fewer items than requested. If unspecified, the server will pick an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. Page token received from a previous QueryUserRootContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryUserRootFolderContents, with the exception of page_size, must match the call that provided the page token.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()