Interface QueryTeamFolderContentsRequestOrBuilder (0.84.0)

public interface QueryTeamFolderContentsRequestOrBuilder 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.

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), create_time, last_modified_time. 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()

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), create_time, last_modified_time. Examples:

  • 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 QueryTeamFolderContents call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to QueryTeamFolderContents, 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()

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

When paginating, all other parameters provided to QueryTeamFolderContents, 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
ByteString

The bytes for pageToken.

getTeamFolder()

public abstract String getTeamFolder()

Required. Name of the team_folder whose contents to list. Format: projects/*/locations/*/teamFolders/*.

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

Returns
Type Description
String

The teamFolder.

getTeamFolderBytes()

public abstract ByteString getTeamFolderBytes()

Required. Name of the team_folder whose contents to list. Format: projects/*/locations/*/teamFolders/*.

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

Returns
Type Description
ByteString

The bytes for teamFolder.