Class ListDataStoresRequest.Builder (0.33.0)

public static final class ListDataStoresRequest.Builder extends GeneratedMessageV3.Builder<ListDataStoresRequest.Builder> implements ListDataStoresRequestOrBuilder

Request message for DataStoreService.ListDataStores method.

Protobuf type google.cloud.discoveryengine.v1alpha.ListDataStoresRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDataStoresRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

build()

public ListDataStoresRequest build()
Returns
TypeDescription
ListDataStoresRequest

buildPartial()

public ListDataStoresRequest buildPartial()
Returns
TypeDescription
ListDataStoresRequest

clear()

public ListDataStoresRequest.Builder clear()
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListDataStoresRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

clearFilter()

public ListDataStoresRequest.Builder clearFilter()

Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

string filter = 4;

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDataStoresRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

clearPageSize()

public ListDataStoresRequest.Builder clearPageSize()

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 2;

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

clearPageToken()

public ListDataStoresRequest.Builder clearPageToken()

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

clearParent()

public ListDataStoresRequest.Builder clearParent()

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list [DataStores][]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

clone()

public ListDataStoresRequest.Builder clone()
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

getDefaultInstanceForType()

public ListDataStoresRequest getDefaultInstanceForType()
Returns
TypeDescription
ListDataStoresRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getFilter()

public String getFilter()

Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

string filter = 4;

Returns
TypeDescription
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

string filter = 4;

Returns
TypeDescription
ByteString

The bytes for filter.

getPageSize()

public int getPageSize()

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list [DataStores][]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list [DataStores][]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListDataStoresRequest other)

public ListDataStoresRequest.Builder mergeFrom(ListDataStoresRequest other)
Parameter
NameDescription
otherListDataStoresRequest
Returns
TypeDescription
ListDataStoresRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDataStoresRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListDataStoresRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDataStoresRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListDataStoresRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

setFilter(String value)

public ListDataStoresRequest.Builder setFilter(String value)

Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

string filter = 4;

Parameter
NameDescription
valueString

The filter to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setFilterBytes(ByteString value)

public ListDataStoresRequest.Builder setFilterBytes(ByteString value)

Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

string filter = 4;

Parameter
NameDescription
valueByteString

The bytes for filter to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setPageSize(int value)

public ListDataStoresRequest.Builder setPageSize(int value)

Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50.

If this field is negative, an INVALID_ARGUMENT is returned.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListDataStoresRequest.Builder setPageToken(String value)

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListDataStoresRequest.Builder setPageTokenBytes(ByteString value)

A page token ListDataStoresResponse.next_page_token, received from a previous DataStoreService.ListDataStores call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DataStoreService.ListDataStores must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setParent(String value)

public ListDataStoresRequest.Builder setParent(String value)

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list [DataStores][]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListDataStoresRequest.Builder setParentBytes(ByteString value)

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.

If the caller does not have permission to list [DataStores][]s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListDataStoresRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListDataStoresRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDataStoresRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListDataStoresRequest.Builder
Overrides