- 0.63.0 (latest)
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class DataStore.Builder extends GeneratedMessageV3.Builder<DataStore.Builder> implements DataStoreOrBuilderDataStore captures global settings and configs at the DataStore level.
Protobuf type google.cloud.discoveryengine.v1.DataStore
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DataStore.BuilderImplements
DataStoreOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllSolutionTypes(Iterable<? extends SolutionType> values)
public DataStore.Builder addAllSolutionTypes(Iterable<? extends SolutionType> values)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.cloud.discoveryengine.v1.SolutionType>The solutionTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
addAllSolutionTypesValue(Iterable<Integer> values)
public DataStore.Builder addAllSolutionTypesValue(Iterable<Integer> values)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for solutionTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public DataStore.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
addSolutionTypes(SolutionType value)
public DataStore.Builder addSolutionTypes(SolutionType value)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
SolutionTypeThe solutionTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
addSolutionTypesValue(int value)
public DataStore.Builder addSolutionTypesValue(int value)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for solutionTypes to add. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
build()
public DataStore build()| Returns | |
|---|---|
| Type | Description |
DataStore |
|
buildPartial()
public DataStore buildPartial()| Returns | |
|---|---|
| Type | Description |
DataStore |
|
clear()
public DataStore.Builder clear()| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearAclEnabled()
public DataStore.Builder clearAclEnabled() Immutable. Whether data in the
DataStore has ACL information.
If set to true, the source data must have ACL. ACL will be ingested when
data is ingested by
DocumentService.ImportDocuments
methods.
When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.
Currently ACL is only supported in GENERIC industry vertical with
non-PUBLIC_WEBSITE content config.
bool acl_enabled = 24 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearAdvancedSiteSearchConfig()
public DataStore.Builder clearAdvancedSiteSearchConfig()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearBillingEstimation()
public DataStore.Builder clearBillingEstimation()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearCmekConfig()
public DataStore.Builder clearCmekConfig()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearContentConfig()
public DataStore.Builder clearContentConfig()Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearCreateTime()
public DataStore.Builder clearCreateTime()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearDefaultSchemaId()
public DataStore.Builder clearDefaultSchemaId()Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearDisplayName()
public DataStore.Builder clearDisplayName()Required. The data store display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearDocumentProcessingConfig()
public DataStore.Builder clearDocumentProcessingConfig()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public DataStore.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearHealthcareFhirConfig()
public DataStore.Builder clearHealthcareFhirConfig() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearIdentityMappingStore()
public DataStore.Builder clearIdentityMappingStore() Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with THIRD_PARTY or
GSUITE IdP. Format:
projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearIndustryVertical()
public DataStore.Builder clearIndustryVertical()Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearKmsKeyName()
public DataStore.Builder clearKmsKeyName()Input only. The KMS key to be used to protect this DataStore at creation time.
Must be set for requests that need to comply with CMEK Org Policy protections.
If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearName()
public DataStore.Builder clearName() Immutable. Identifier. The full resource name of the data store.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public DataStore.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearSolutionTypes()
public DataStore.Builder clearSolutionTypes()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
clearStartingSchema()
public DataStore.Builder clearStartingSchema()The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clearWorkspaceConfig()
public DataStore.Builder clearWorkspaceConfig()Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
clone()
public DataStore.Builder clone()| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
getAclEnabled()
public boolean getAclEnabled() Immutable. Whether data in the
DataStore has ACL information.
If set to true, the source data must have ACL. ACL will be ingested when
data is ingested by
DocumentService.ImportDocuments
methods.
When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.
Currently ACL is only supported in GENERIC industry vertical with
non-PUBLIC_WEBSITE content config.
bool acl_enabled = 24 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
boolean |
The aclEnabled. |
getAdvancedSiteSearchConfig()
public AdvancedSiteSearchConfig getAdvancedSiteSearchConfig()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfig |
The advancedSiteSearchConfig. |
getAdvancedSiteSearchConfigBuilder()
public AdvancedSiteSearchConfig.Builder getAdvancedSiteSearchConfigBuilder()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfig.Builder |
|
getAdvancedSiteSearchConfigOrBuilder()
public AdvancedSiteSearchConfigOrBuilder getAdvancedSiteSearchConfigOrBuilder()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
AdvancedSiteSearchConfigOrBuilder |
|
getBillingEstimation()
public DataStore.BillingEstimation getBillingEstimation()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.BillingEstimation |
The billingEstimation. |
getBillingEstimationBuilder()
public DataStore.BillingEstimation.Builder getBillingEstimationBuilder()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.BillingEstimation.Builder |
|
getBillingEstimationOrBuilder()
public DataStore.BillingEstimationOrBuilder getBillingEstimationOrBuilder()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
DataStore.BillingEstimationOrBuilder |
|
getCmekConfig()
public CmekConfig getCmekConfig()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmekConfig |
The cmekConfig. |
getCmekConfigBuilder()
public CmekConfig.Builder getCmekConfigBuilder()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmekConfig.Builder |
|
getCmekConfigOrBuilder()
public CmekConfigOrBuilder getCmekConfigOrBuilder()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
CmekConfigOrBuilder |
|
getContentConfig()
public DataStore.ContentConfig getContentConfig()Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
DataStore.ContentConfig |
The contentConfig. |
getContentConfigValue()
public int getContentConfigValue()Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for contentConfig. |
getCreateTime()
public Timestamp getCreateTime()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public DataStore getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DataStore |
|
getDefaultSchemaId()
public String getDefaultSchemaId()Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultSchemaId. |
getDefaultSchemaIdBytes()
public ByteString getDefaultSchemaIdBytes()Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultSchemaId. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Required. The data store display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Required. The data store display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getDocumentProcessingConfig()
public DocumentProcessingConfig getDocumentProcessingConfig()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DocumentProcessingConfig |
The documentProcessingConfig. |
getDocumentProcessingConfigBuilder()
public DocumentProcessingConfig.Builder getDocumentProcessingConfigBuilder()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DocumentProcessingConfig.Builder |
|
getDocumentProcessingConfigOrBuilder()
public DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
DocumentProcessingConfigOrBuilder |
|
getHealthcareFhirConfig()
public HealthcareFhirConfig getHealthcareFhirConfig() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HealthcareFhirConfig |
The healthcareFhirConfig. |
getHealthcareFhirConfigBuilder()
public HealthcareFhirConfig.Builder getHealthcareFhirConfigBuilder() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HealthcareFhirConfig.Builder |
|
getHealthcareFhirConfigOrBuilder()
public HealthcareFhirConfigOrBuilder getHealthcareFhirConfigOrBuilder() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
HealthcareFhirConfigOrBuilder |
|
getIdentityMappingStore()
public String getIdentityMappingStore() Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with THIRD_PARTY or
GSUITE IdP. Format:
projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The identityMappingStore. |
getIdentityMappingStoreBytes()
public ByteString getIdentityMappingStoreBytes() Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with THIRD_PARTY or
GSUITE IdP. Format:
projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for identityMappingStore. |
getIndustryVertical()
public IndustryVertical getIndustryVertical()Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
IndustryVertical |
The industryVertical. |
getIndustryVerticalValue()
public int getIndustryVerticalValue()Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for industryVertical. |
getKmsKeyName()
public String getKmsKeyName()Input only. The KMS key to be used to protect this DataStore at creation time.
Must be set for requests that need to comply with CMEK Org Policy protections.
If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The kmsKeyName. |
getKmsKeyNameBytes()
public ByteString getKmsKeyNameBytes()Input only. The KMS key to be used to protect this DataStore at creation time.
Must be set for requests that need to comply with CMEK Org Policy protections.
If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for kmsKeyName. |
getName()
public String getName() Immutable. Identifier. The full resource name of the data store.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public ByteString getNameBytes() Immutable. Identifier. The full resource name of the data store.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getSolutionTypes(int index)
public SolutionType getSolutionTypes(int index)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
SolutionType |
The solutionTypes at the given index. |
getSolutionTypesCount()
public int getSolutionTypesCount()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The count of solutionTypes. |
getSolutionTypesList()
public List<SolutionType> getSolutionTypesList()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
List<SolutionType> |
A list containing the solutionTypes. |
getSolutionTypesValue(int index)
public int getSolutionTypesValue(int index)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of solutionTypes at the given index. |
getSolutionTypesValueList()
public List<Integer> getSolutionTypesValueList()The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for solutionTypes. |
getStartingSchema()
public Schema getStartingSchema()The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
Schema |
The startingSchema. |
getStartingSchemaBuilder()
public Schema.Builder getStartingSchemaBuilder()The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
getStartingSchemaOrBuilder()
public SchemaOrBuilder getStartingSchemaOrBuilder()The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
getWorkspaceConfig()
public WorkspaceConfig getWorkspaceConfig()Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
WorkspaceConfig |
The workspaceConfig. |
getWorkspaceConfigBuilder()
public WorkspaceConfig.Builder getWorkspaceConfigBuilder()Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
WorkspaceConfig.Builder |
|
getWorkspaceConfigOrBuilder()
public WorkspaceConfigOrBuilder getWorkspaceConfigOrBuilder()Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
WorkspaceConfigOrBuilder |
|
hasAdvancedSiteSearchConfig()
public boolean hasAdvancedSiteSearchConfig()Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the advancedSiteSearchConfig field is set. |
hasBillingEstimation()
public boolean hasBillingEstimation()Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the billingEstimation field is set. |
hasCmekConfig()
public boolean hasCmekConfig()Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the cmekConfig field is set. |
hasCreateTime()
public boolean hasCreateTime()Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasDocumentProcessingConfig()
public boolean hasDocumentProcessingConfig()Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the documentProcessingConfig field is set. |
hasHealthcareFhirConfig()
public boolean hasHealthcareFhirConfig() Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the healthcareFhirConfig field is set. |
hasStartingSchema()
public boolean hasStartingSchema()The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the startingSchema field is set. |
hasWorkspaceConfig()
public boolean hasWorkspaceConfig()Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the workspaceConfig field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAdvancedSiteSearchConfig(AdvancedSiteSearchConfig value)
public DataStore.Builder mergeAdvancedSiteSearchConfig(AdvancedSiteSearchConfig value)Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSiteSearchConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeBillingEstimation(DataStore.BillingEstimation value)
public DataStore.Builder mergeBillingEstimation(DataStore.BillingEstimation value)Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStore.BillingEstimation |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeCmekConfig(CmekConfig value)
public DataStore.Builder mergeCmekConfig(CmekConfig value)Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CmekConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeCreateTime(Timestamp value)
public DataStore.Builder mergeCreateTime(Timestamp value)Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeDocumentProcessingConfig(DocumentProcessingConfig value)
public DataStore.Builder mergeDocumentProcessingConfig(DocumentProcessingConfig value)Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
DocumentProcessingConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeFrom(DataStore other)
public DataStore.Builder mergeFrom(DataStore other)| Parameter | |
|---|---|
| Name | Description |
other |
DataStore |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public DataStore.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public DataStore.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeHealthcareFhirConfig(HealthcareFhirConfig value)
public DataStore.Builder mergeHealthcareFhirConfig(HealthcareFhirConfig value) Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
HealthcareFhirConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeStartingSchema(Schema value)
public DataStore.Builder mergeStartingSchema(Schema value)The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
Schema |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DataStore.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
mergeWorkspaceConfig(WorkspaceConfig value)
public DataStore.Builder mergeWorkspaceConfig(WorkspaceConfig value)Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
WorkspaceConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setAclEnabled(boolean value)
public DataStore.Builder setAclEnabled(boolean value) Immutable. Whether data in the
DataStore has ACL information.
If set to true, the source data must have ACL. ACL will be ingested when
data is ingested by
DocumentService.ImportDocuments
methods.
When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments.
Currently ACL is only supported in GENERIC industry vertical with
non-PUBLIC_WEBSITE content config.
bool acl_enabled = 24 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe aclEnabled to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setAdvancedSiteSearchConfig(AdvancedSiteSearchConfig value)
public DataStore.Builder setAdvancedSiteSearchConfig(AdvancedSiteSearchConfig value)Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
AdvancedSiteSearchConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setAdvancedSiteSearchConfig(AdvancedSiteSearchConfig.Builder builderForValue)
public DataStore.Builder setAdvancedSiteSearchConfig(AdvancedSiteSearchConfig.Builder builderForValue)Optional. Configuration for advanced site search.
.google.cloud.discoveryengine.v1.AdvancedSiteSearchConfig advanced_site_search_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
AdvancedSiteSearchConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setBillingEstimation(DataStore.BillingEstimation value)
public DataStore.Builder setBillingEstimation(DataStore.BillingEstimation value)Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStore.BillingEstimation |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setBillingEstimation(DataStore.BillingEstimation.Builder builderForValue)
public DataStore.Builder setBillingEstimation(DataStore.BillingEstimation.Builder builderForValue)Output only. Data size estimation for billing.
.google.cloud.discoveryengine.v1.DataStore.BillingEstimation billing_estimation = 23 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DataStore.BillingEstimation.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setCmekConfig(CmekConfig value)
public DataStore.Builder setCmekConfig(CmekConfig value)Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
CmekConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setCmekConfig(CmekConfig.Builder builderForValue)
public DataStore.Builder setCmekConfig(CmekConfig.Builder builderForValue)Output only. CMEK-related information for the DataStore.
.google.cloud.discoveryengine.v1.CmekConfig cmek_config = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CmekConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setContentConfig(DataStore.ContentConfig value)
public DataStore.Builder setContentConfig(DataStore.ContentConfig value)Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
DataStore.ContentConfigThe contentConfig to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setContentConfigValue(int value)
public DataStore.Builder setContentConfigValue(int value)Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.
.google.cloud.discoveryengine.v1.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for contentConfig to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public DataStore.Builder setCreateTime(Timestamp value)Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setCreateTime(Timestamp.Builder builderForValue)
public DataStore.Builder setCreateTime(Timestamp.Builder builderForValue)Output only. Timestamp the DataStore was created at.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setDefaultSchemaId(String value)
public DataStore.Builder setDefaultSchemaId(String value)Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe defaultSchemaId to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setDefaultSchemaIdBytes(ByteString value)
public DataStore.Builder setDefaultSchemaIdBytes(ByteString value)Output only. The id of the default Schema associated to this data store.
string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for defaultSchemaId to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setDisplayName(String value)
public DataStore.Builder setDisplayName(String value)Required. The data store display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public DataStore.Builder setDisplayNameBytes(ByteString value)Required. The data store display name.
This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setDocumentProcessingConfig(DocumentProcessingConfig value)
public DataStore.Builder setDocumentProcessingConfig(DocumentProcessingConfig value)Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
DocumentProcessingConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setDocumentProcessingConfig(DocumentProcessingConfig.Builder builderForValue)
public DataStore.Builder setDocumentProcessingConfig(DocumentProcessingConfig.Builder builderForValue)Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1.DocumentProcessingConfig document_processing_config = 27;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DocumentProcessingConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public DataStore.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setHealthcareFhirConfig(HealthcareFhirConfig value)
public DataStore.Builder setHealthcareFhirConfig(HealthcareFhirConfig value) Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
HealthcareFhirConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setHealthcareFhirConfig(HealthcareFhirConfig.Builder builderForValue)
public DataStore.Builder setHealthcareFhirConfig(HealthcareFhirConfig.Builder builderForValue) Optional. Configuration for HEALTHCARE_FHIR vertical.
.google.cloud.discoveryengine.v1.HealthcareFhirConfig healthcare_fhir_config = 29 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
HealthcareFhirConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setIdentityMappingStore(String value)
public DataStore.Builder setIdentityMappingStore(String value) Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with THIRD_PARTY or
GSUITE IdP. Format:
projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe identityMappingStore to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setIdentityMappingStoreBytes(ByteString value)
public DataStore.Builder setIdentityMappingStoreBytes(ByteString value) Immutable. The fully qualified resource name of the associated
IdentityMappingStore.
This field can only be set for acl_enabled DataStores with THIRD_PARTY or
GSUITE IdP. Format:
projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}.
string identity_mapping_store = 31 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for identityMappingStore to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setIndustryVertical(IndustryVertical value)
public DataStore.Builder setIndustryVertical(IndustryVertical value)Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
IndustryVerticalThe industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setIndustryVerticalValue(int value)
public DataStore.Builder setIndustryVerticalValue(int value)Immutable. The industry vertical that the data store registers.
.google.cloud.discoveryengine.v1.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for industryVertical to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setKmsKeyName(String value)
public DataStore.Builder setKmsKeyName(String value)Input only. The KMS key to be used to protect this DataStore at creation time.
Must be set for requests that need to comply with CMEK Org Policy protections.
If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setKmsKeyNameBytes(ByteString value)
public DataStore.Builder setKmsKeyNameBytes(ByteString value)Input only. The KMS key to be used to protect this DataStore at creation time.
Must be set for requests that need to comply with CMEK Org Policy protections.
If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field.
string kms_key_name = 32 [(.google.api.field_behavior) = INPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for kmsKeyName to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setName(String value)
public DataStore.Builder setName(String value) Immutable. Identifier. The full resource name of the data store.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public DataStore.Builder setNameBytes(ByteString value) Immutable. Identifier. The full resource name of the data store.
Format:
projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.
This field must be a UTF-8 encoded string with a length limit of 1024 characters.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = IDENTIFIER];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public DataStore.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setSolutionTypes(int index, SolutionType value)
public DataStore.Builder setSolutionTypes(int index, SolutionType value)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
SolutionTypeThe solutionTypes to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setSolutionTypesValue(int index, int value)
public DataStore.Builder setSolutionTypesValue(int index, int value)The solutions that the data store enrolls. Available solutions for each industry_vertical:
MEDIA:SOLUTION_TYPE_RECOMMENDATIONandSOLUTION_TYPE_SEARCH.SITE_SEARCH:SOLUTION_TYPE_SEARCHis automatically enrolled. Other solutions cannot be enrolled.
repeated .google.cloud.discoveryengine.v1.SolutionType solution_types = 5;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for solutionTypes to set. |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
This builder for chaining. |
setStartingSchema(Schema value)
public DataStore.Builder setStartingSchema(Schema value)The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
Schema |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setStartingSchema(Schema.Builder builderForValue)
public DataStore.Builder setStartingSchema(Schema.Builder builderForValue)The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used.
This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead.
The provided schema will be validated against certain rules on schema. Learn more from this doc.
.google.cloud.discoveryengine.v1.Schema starting_schema = 28;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Schema.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final DataStore.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setWorkspaceConfig(WorkspaceConfig value)
public DataStore.Builder setWorkspaceConfig(WorkspaceConfig value)Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
WorkspaceConfig |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|
setWorkspaceConfig(WorkspaceConfig.Builder builderForValue)
public DataStore.Builder setWorkspaceConfig(WorkspaceConfig.Builder builderForValue)Config to store data store type configuration for workspace data. This must be set when DataStore.content_config is set as DataStore.ContentConfig.GOOGLE_WORKSPACE.
.google.cloud.discoveryengine.v1.WorkspaceConfig workspace_config = 25;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
WorkspaceConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
DataStore.Builder |
|