Class CreateDataStoreRequest.Builder (0.48.0)

public static final class CreateDataStoreRequest.Builder extends GeneratedMessageV3.Builder<CreateDataStoreRequest.Builder> implements CreateDataStoreRequestOrBuilder

Request for DataStoreService.CreateDataStore method.

Protobuf type google.cloud.discoveryengine.v1.CreateDataStoreRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public CreateDataStoreRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

build()

public CreateDataStoreRequest build()
Returns
Type Description
CreateDataStoreRequest

buildPartial()

public CreateDataStoreRequest buildPartial()
Returns
Type Description
CreateDataStoreRequest

clear()

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

clearCreateAdvancedSiteSearch()

public CreateDataStoreRequest.Builder clearCreateAdvancedSiteSearch()

A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

bool create_advanced_site_search = 4;

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

clearDataStore()

public CreateDataStoreRequest.Builder clearDataStore()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateDataStoreRequest.Builder

clearDataStoreId()

public CreateDataStoreRequest.Builder clearDataStoreId()

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public CreateDataStoreRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public CreateDataStoreRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

clearParent()

public CreateDataStoreRequest.Builder clearParent()

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

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

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

clearSkipDefaultSchemaCreation()

public CreateDataStoreRequest.Builder clearSkipDefaultSchemaCreation()

A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

If set to true, you must manually create a schema for the data store before any documents can be ingested.

This flag cannot be specified if data_store.starting_schema is specified.

bool skip_default_schema_creation = 7;

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

clone()

public CreateDataStoreRequest.Builder clone()
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

getCreateAdvancedSiteSearch()

public boolean getCreateAdvancedSiteSearch()

A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

bool create_advanced_site_search = 4;

Returns
Type Description
boolean

The createAdvancedSiteSearch.

getDataStore()

public DataStore getDataStore()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStore

The dataStore.

getDataStoreBuilder()

public DataStore.Builder getDataStoreBuilder()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStore.Builder

getDataStoreId()

public String getDataStoreId()

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The dataStoreId.

getDataStoreIdBytes()

public ByteString getDataStoreIdBytes()

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for dataStoreId.

getDataStoreOrBuilder()

public DataStoreOrBuilder getDataStoreOrBuilder()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DataStoreOrBuilder

getDefaultInstanceForType()

public CreateDataStoreRequest getDefaultInstanceForType()
Returns
Type Description
CreateDataStoreRequest

getDescriptorForType()

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

getParent()

public String getParent()

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

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

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

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

Returns
Type Description
ByteString

The bytes for parent.

getSkipDefaultSchemaCreation()

public boolean getSkipDefaultSchemaCreation()

A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

If set to true, you must manually create a schema for the data store before any documents can be ingested.

This flag cannot be specified if data_store.starting_schema is specified.

bool skip_default_schema_creation = 7;

Returns
Type Description
boolean

The skipDefaultSchemaCreation.

hasDataStore()

public boolean hasDataStore()

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the dataStore field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDataStore(DataStore value)

public CreateDataStoreRequest.Builder mergeDataStore(DataStore value)

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DataStore
Returns
Type Description
CreateDataStoreRequest.Builder

mergeFrom(CreateDataStoreRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final CreateDataStoreRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

setCreateAdvancedSiteSearch(boolean value)

public CreateDataStoreRequest.Builder setCreateAdvancedSiteSearch(boolean value)

A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

bool create_advanced_site_search = 4;

Parameter
Name Description
value boolean

The createAdvancedSiteSearch to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

setDataStore(DataStore value)

public CreateDataStoreRequest.Builder setDataStore(DataStore value)

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value DataStore
Returns
Type Description
CreateDataStoreRequest.Builder

setDataStore(DataStore.Builder builderForValue)

public CreateDataStoreRequest.Builder setDataStore(DataStore.Builder builderForValue)

Required. The DataStore to create.

.google.cloud.discoveryengine.v1.DataStore data_store = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue DataStore.Builder
Returns
Type Description
CreateDataStoreRequest.Builder

setDataStoreId(String value)

public CreateDataStoreRequest.Builder setDataStoreId(String value)

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The dataStoreId to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

setDataStoreIdBytes(ByteString value)

public CreateDataStoreRequest.Builder setDataStoreIdBytes(ByteString value)

Required. The ID to use for the DataStore, which will become the final component of the DataStore's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

string data_store_id = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for dataStoreId to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public CreateDataStoreRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

setParent(String value)

public CreateDataStoreRequest.Builder setParent(String value)

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

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public CreateDataStoreRequest.Builder setParentBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

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

public CreateDataStoreRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides

setSkipDefaultSchemaCreation(boolean value)

public CreateDataStoreRequest.Builder setSkipDefaultSchemaCreation(boolean value)

A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case.

If set to true, you must manually create a schema for the data store before any documents can be ingested.

This flag cannot be specified if data_store.starting_schema is specified.

bool skip_default_schema_creation = 7;

Parameter
Name Description
value boolean

The skipDefaultSchemaCreation to set.

Returns
Type Description
CreateDataStoreRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final CreateDataStoreRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
CreateDataStoreRequest.Builder
Overrides