Class DataStore (0.44.0) 

public final class DataStore extends GeneratedMessageV3 implements DataStoreOrBuilder

DataStore captures global settings and configs at the DataStore level.

Protobuf type google.cloud.discoveryengine.v1alpha.DataStore

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DataStore

Implements

DataStoreOrBuilder

Static Fields

ACL_ENABLED_FIELD_NUMBER

public static final int ACL_ENABLED_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_CONFIG_FIELD_NUMBER

public static final int CONTENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_SCHEMA_ID_FIELD_NUMBER

public static final int DEFAULT_SCHEMA_ID_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_PROCESSING_CONFIG_FIELD_NUMBER

public static final int DOCUMENT_PROCESSING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

IDP_CONFIG_FIELD_NUMBER

public static final int IDP_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

INDUSTRY_VERTICAL_FIELD_NUMBER

public static final int INDUSTRY_VERTICAL_FIELD_NUMBER
Field Value
Type Description
int

LANGUAGE_INFO_FIELD_NUMBER

public static final int LANGUAGE_INFO_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SOLUTION_TYPES_FIELD_NUMBER

public static final int SOLUTION_TYPES_FIELD_NUMBER
Field Value
Type Description
int

STARTING_SCHEMA_FIELD_NUMBER

public static final int STARTING_SCHEMA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DataStore getDefaultInstance()
Returns
Type Description
DataStore

getDescriptor()

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

newBuilder()

public static DataStore.Builder newBuilder()
Returns
Type Description
DataStore.Builder

newBuilder(DataStore prototype)

public static DataStore.Builder newBuilder(DataStore prototype)
Parameter
Name Description
prototype DataStore
Returns
Type Description
DataStore.Builder

parseDelimitedFrom(InputStream input)

public static DataStore parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DataStore parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DataStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DataStore parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DataStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DataStore parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DataStore parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DataStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DataStore parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DataStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DataStore
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DataStore> parser()
Returns
Type Description
Parser<DataStore>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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.v1alpha.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.v1alpha.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.

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 asscociated 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 asscociated to this data store.

string default_schema_id = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for defaultSchemaId.

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.v1alpha.DocumentProcessingConfig document_processing_config = 27;

Returns
Type Description
DocumentProcessingConfig

The documentProcessingConfig.

getDocumentProcessingConfigOrBuilder()

public DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()

Configuration for Document understanding and enrichment.

.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig document_processing_config = 27;

Returns
Type Description
DocumentProcessingConfigOrBuilder

getIdpConfig()

public IdpConfig getIdpConfig()

Output only. Data store level identity provider config.

.google.cloud.discoveryengine.v1alpha.IdpConfig idp_config = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IdpConfig

The idpConfig.

getIdpConfigOrBuilder()

public IdpConfigOrBuilder getIdpConfigOrBuilder()

Output only. Data store level identity provider config.

.google.cloud.discoveryengine.v1alpha.IdpConfig idp_config = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IdpConfigOrBuilder

getIndustryVertical()

public IndustryVertical getIndustryVertical()

Immutable. The industry vertical that the data store registers.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
int

The enum numeric value on the wire for industryVertical.

getLanguageInfo()

public LanguageInfo getLanguageInfo()

Language info for DataStore.

.google.cloud.discoveryengine.v1alpha.LanguageInfo language_info = 14;

Returns
Type Description
LanguageInfo

The languageInfo.

getLanguageInfoOrBuilder()

public LanguageInfoOrBuilder getLanguageInfoOrBuilder()

Language info for DataStore.

.google.cloud.discoveryengine.v1alpha.LanguageInfo language_info = 14;

Returns
Type Description
LanguageInfoOrBuilder

getName()

public String getName()

Immutable. 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];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. 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];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<DataStore> getParserForType()
Returns
Type Description
Parser<DataStore>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSolutionTypes(int index)

public SolutionType getSolutionTypes(int index)

The solutions that the data store enrolls. Available solutions for each industry_vertical:

  • MEDIA: SOLUTION_TYPE_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

repeated .google.cloud.discoveryengine.v1alpha.SolutionType solution_types = 5;

Parameter
Name Description
index int

The 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_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

repeated .google.cloud.discoveryengine.v1alpha.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_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

repeated .google.cloud.discoveryengine.v1alpha.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_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

repeated .google.cloud.discoveryengine.v1alpha.SolutionType solution_types = 5;

Parameter
Name Description
index int

The 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_RECOMMENDATION and SOLUTION_TYPE_SEARCH.
  • SITE_SEARCH: SOLUTION_TYPE_SEARCH is automatically enrolled. Other solutions cannot be enrolled.

repeated .google.cloud.discoveryengine.v1alpha.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.v1alpha.Schema starting_schema = 28;

Returns
Type Description
Schema

The startingSchema.

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.v1alpha.Schema starting_schema = 28;

Returns
Type Description
SchemaOrBuilder

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.v1alpha.DocumentProcessingConfig document_processing_config = 27;

Returns
Type Description
boolean

Whether the documentProcessingConfig field is set.

hasIdpConfig()

public boolean hasIdpConfig()

Output only. Data store level identity provider config.

.google.cloud.discoveryengine.v1alpha.IdpConfig idp_config = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the idpConfig field is set.

hasLanguageInfo()

public boolean hasLanguageInfo()

Language info for DataStore.

.google.cloud.discoveryengine.v1alpha.LanguageInfo language_info = 14;

Returns
Type Description
boolean

Whether the languageInfo 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.v1alpha.Schema starting_schema = 28;

Returns
Type Description
boolean

Whether the startingSchema field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DataStore.Builder newBuilderForType()
Returns
Type Description
DataStore.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DataStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DataStore.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DataStore.Builder toBuilder()
Returns
Type Description
DataStore.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException