Class SearchTeamFoldersRequest.Builder (0.84.0)

public static final class SearchTeamFoldersRequest.Builder extends GeneratedMessage.Builder<SearchTeamFoldersRequest.Builder> implements SearchTeamFoldersRequestOrBuilder

SearchTeamFolders request message.

Protobuf type google.cloud.dataform.v1beta1.SearchTeamFoldersRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public SearchTeamFoldersRequest build()
Returns
Type Description
SearchTeamFoldersRequest

buildPartial()

public SearchTeamFoldersRequest buildPartial()
Returns
Type Description
SearchTeamFoldersRequest

clear()

public SearchTeamFoldersRequest.Builder clear()
Returns
Type Description
SearchTeamFoldersRequest.Builder
Overrides

clearFilter()

public SearchTeamFoldersRequest.Builder clearFilter()

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
SearchTeamFoldersRequest.Builder

This builder for chaining.

clearLocation()

public SearchTeamFoldersRequest.Builder clearLocation()

Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

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

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

clearOrderBy()

public SearchTeamFoldersRequest.Builder clearOrderBy()

Optional. Field to additionally sort results by. 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
SearchTeamFoldersRequest.Builder

This builder for chaining.

clearPageSize()

public SearchTeamFoldersRequest.Builder clearPageSize()

Optional. Maximum number of TeamFolders 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
SearchTeamFoldersRequest.Builder

This builder for chaining.

clearPageToken()

public SearchTeamFoldersRequest.Builder clearPageToken()

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

When paginating, all other parameters provided to SearchTeamFolders, 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
SearchTeamFoldersRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchTeamFoldersRequest getDefaultInstanceForType()
Returns
Type Description
SearchTeamFoldersRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFilter()

public 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 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 String getLocation()

Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

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

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Required. Location in which to query TeamFolders. 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 String getOrderBy()

Optional. Field to additionally sort results by. 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 ByteString getOrderByBytes()

Optional. Field to additionally sort results by. 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 int getPageSize()

Optional. Maximum number of TeamFolders 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 String getPageToken()

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

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

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

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

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchTeamFoldersRequest other)

public SearchTeamFoldersRequest.Builder mergeFrom(SearchTeamFoldersRequest other)
Parameter
Name Description
other SearchTeamFoldersRequest
Returns
Type Description
SearchTeamFoldersRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchTeamFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchTeamFoldersRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchTeamFoldersRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchTeamFoldersRequest.Builder
Overrides

setFilter(String value)

public SearchTeamFoldersRequest.Builder setFilter(String value)

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];

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SearchTeamFoldersRequest.Builder setFilterBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setLocation(String value)

public SearchTeamFoldersRequest.Builder setLocation(String value)

Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

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

Parameter
Name Description
value String

The location to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public SearchTeamFoldersRequest.Builder setLocationBytes(ByteString value)

Required. Location in which to query TeamFolders. Format: projects/*/locations/*.

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

Parameter
Name Description
value ByteString

The bytes for location to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setOrderBy(String value)

public SearchTeamFoldersRequest.Builder setOrderBy(String value)

Optional. Field to additionally sort results by. 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];

Parameter
Name Description
value String

The orderBy to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setOrderByBytes(ByteString value)

public SearchTeamFoldersRequest.Builder setOrderByBytes(ByteString value)

Optional. Field to additionally sort results by. 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];

Parameter
Name Description
value ByteString

The bytes for orderBy to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchTeamFoldersRequest.Builder setPageSize(int value)

Optional. Maximum number of TeamFolders 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];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchTeamFoldersRequest.Builder setPageToken(String value)

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

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

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

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchTeamFoldersRequest.Builder setPageTokenBytes(ByteString value)

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

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

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

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
SearchTeamFoldersRequest.Builder

This builder for chaining.