Class SearchFilesRequest.Builder (0.84.0)

public static final class SearchFilesRequest.Builder extends GeneratedMessage.Builder<SearchFilesRequest.Builder> implements SearchFilesRequestOrBuilder

Configuration containing file search request parameters.

Protobuf type google.cloud.dataform.v1.SearchFilesRequest

Static Methods

getDescriptor()

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

Methods

build()

public SearchFilesRequest build()
Returns
Type Description
SearchFilesRequest

buildPartial()

public SearchFilesRequest buildPartial()
Returns
Type Description
SearchFilesRequest

clear()

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

clearFilter()

public SearchFilesRequest.Builder clearFilter()

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

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

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.

clearPageSize()

public SearchFilesRequest.Builder clearPageSize()

Optional. Maximum number of search results 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
SearchFilesRequest.Builder

This builder for chaining.

clearPageToken()

public SearchFilesRequest.Builder clearPageToken()

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

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

This builder for chaining.

clearWorkspace()

public SearchFilesRequest.Builder clearWorkspace()

Required. The workspace's name.

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

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchFilesRequest getDefaultInstanceForType()
Returns
Type Description
SearchFilesRequest

getDescriptorForType()

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

getFilter()

public String getFilter()

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

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

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

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

Returns
Type Description
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Optional. Maximum number of search results 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 SearchFilesRequest call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchFilesRequest, 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 SearchFilesRequest call. Provide this to retrieve the subsequent page.

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

getWorkspace()

public String getWorkspace()

Required. The workspace's name.

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

Returns
Type Description
String

The workspace.

getWorkspaceBytes()

public ByteString getWorkspaceBytes()

Required. The workspace's name.

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

Returns
Type Description
ByteString

The bytes for workspace.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchFilesRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setFilter(String value)

public SearchFilesRequest.Builder setFilter(String value)

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

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

Parameter
Name Description
value String

The filter to set.

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public SearchFilesRequest.Builder setFilterBytes(ByteString value)

Optional. Optional filter for the returned list in filtering format. Filtering is only currently supported on the path field. See https://google.aip.dev/160 for details.

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

Parameter
Name Description
value ByteString

The bytes for filter to set.

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.

setPageSize(int value)

public SearchFilesRequest.Builder setPageSize(int value)

Optional. Maximum number of search results 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
SearchFilesRequest.Builder

This builder for chaining.

setPageToken(String value)

public SearchFilesRequest.Builder setPageToken(String value)

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

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

This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchFilesRequest.Builder setPageTokenBytes(ByteString value)

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

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

This builder for chaining.

setWorkspace(String value)

public SearchFilesRequest.Builder setWorkspace(String value)

Required. The workspace's name.

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

Parameter
Name Description
value String

The workspace to set.

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.

setWorkspaceBytes(ByteString value)

public SearchFilesRequest.Builder setWorkspaceBytes(ByteString value)

Required. The workspace's name.

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

Parameter
Name Description
value ByteString

The bytes for workspace to set.

Returns
Type Description
SearchFilesRequest.Builder

This builder for chaining.