com.google.cloud.discoveryengine.v1

Class ListDataStoresRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>

com.google.cloud.discoveryengine.v1.ListDataStoresRequest.Builder

All Implemented Interfaces:

ListDataStoresRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

ListDataStoresRequest

public static final class ListDataStoresRequest.Builder
extends com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>
implements ListDataStoresRequestOrBuilder

 Request message for
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 method.
 

Protobuf type google.cloud.discoveryengine.v1.ListDataStoresRequest

Method Summary

Modifier and Type	Method and Description
ListDataStoresRequest	build()
ListDataStoresRequest	buildPartial()
ListDataStoresRequest.Builder	clear()
ListDataStoresRequest.Builder	clearFilter() Filter by solution type .
ListDataStoresRequest.Builder	clearPageSize() Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s to return.
ListDataStoresRequest.Builder	clearPageToken() A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call.
ListDataStoresRequest.Builder	clearParent() Required.
ListDataStoresRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Filter by solution type .
com.google.protobuf.ByteString	getFilterBytes() Filter by solution type .
int	getPageSize() Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s to return.
String	getPageToken() A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call.
com.google.protobuf.ByteString	getPageTokenBytes() A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListDataStoresRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
ListDataStoresRequest.Builder	mergeFrom(ListDataStoresRequest other)
ListDataStoresRequest.Builder	mergeFrom(com.google.protobuf.Message other)
ListDataStoresRequest.Builder	setFilter(String value) Filter by solution type .
ListDataStoresRequest.Builder	setFilterBytes(com.google.protobuf.ByteString value) Filter by solution type .
ListDataStoresRequest.Builder	setPageSize(int value) Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s to return.
ListDataStoresRequest.Builder	setPageToken(String value) A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call.
ListDataStoresRequest.Builder	setPageTokenBytes(com.google.protobuf.ByteString value) A page token [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token], received from a previous [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores] call.
ListDataStoresRequest.Builder	setParent(String value) Required.
ListDataStoresRequest.Builder	setParentBytes(com.google.protobuf.ByteString value) Required.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>

clear

public ListDataStoresRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>

getDefaultInstanceForType

public ListDataStoresRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public ListDataStoresRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public ListDataStoresRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public ListDataStoresRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDataStoresRequest.Builder>

mergeFrom

public ListDataStoresRequest.Builder mergeFrom(ListDataStoresRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<ListDataStoresRequest.Builder>

mergeFrom

public ListDataStoresRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ListDataStoresRequest.Builder>

Throws:

IOException

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
 [DataStore][google.cloud.discoveryengine.v1.DataStore]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) = { ... }

Specified by:

getParent in interface ListDataStoresRequestOrBuilder

Returns:

The parent.

getParentBytes

public com.google.protobuf.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
 [DataStore][google.cloud.discoveryengine.v1.DataStore]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) = { ... }

Specified by:

getParentBytes in interface ListDataStoresRequestOrBuilder

Returns:

The bytes for parent.

setParent

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
 [DataStore][google.cloud.discoveryengine.v1.DataStore]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) = { ... }

Parameters:

value - The parent to set.

Returns:

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
 [DataStore][google.cloud.discoveryengine.v1.DataStore]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:

This builder for chaining.

setParentBytes

public ListDataStoresRequest.Builder setParentBytes(com.google.protobuf.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
 [DataStore][google.cloud.discoveryengine.v1.DataStore]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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

getPageSize

public int getPageSize()

 Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s
 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;

Specified by:

getPageSize in interface ListDataStoresRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListDataStoresRequest.Builder setPageSize(int value)

 Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s
 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;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListDataStoresRequest.Builder clearPageSize()

 Maximum number of [DataStore][google.cloud.discoveryengine.v1.DataStore]s
 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:

This builder for chaining.

getPageToken

public String getPageToken()

 A page token
 [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token],
 received from a previous
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Specified by:

getPageToken in interface ListDataStoresRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public com.google.protobuf.ByteString getPageTokenBytes()

 A page token
 [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token],
 received from a previous
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Specified by:

getPageTokenBytes in interface ListDataStoresRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListDataStoresRequest.Builder setPageToken(String value)

 A page token
 [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token],
 received from a previous
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListDataStoresRequest.Builder clearPageToken()

 A page token
 [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token],
 received from a previous
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Returns:

This builder for chaining.

setPageTokenBytes

public ListDataStoresRequest.Builder setPageTokenBytes(com.google.protobuf.ByteString value)

 A page token
 [ListDataStoresResponse.next_page_token][google.cloud.discoveryengine.v1.ListDataStoresResponse.next_page_token],
 received from a previous
 [DataStoreService.ListDataStores][google.cloud.discoveryengine.v1.DataStoreService.ListDataStores]
 call. Provide this to retrieve the subsequent page.

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

string page_token = 3;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

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

string filter = 4;

Specified by:

getFilter in interface ListDataStoresRequestOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

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

string filter = 4;

Specified by:

getFilterBytes in interface ListDataStoresRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListDataStoresRequest.Builder setFilter(String value)

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

string filter = 4;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListDataStoresRequest.Builder clearFilter()

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

string filter = 4;

Returns:

This builder for chaining.

setFilterBytes

public ListDataStoresRequest.Builder setFilterBytes(com.google.protobuf.ByteString value)

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

string filter = 4;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.