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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 | |
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static DataStore.Builder newBuilder()
newBuilder(DataStore prototype)
public static DataStore.Builder newBuilder(DataStore prototype)
public static DataStore parseDelimitedFrom(InputStream input)
public static DataStore parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static DataStore parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DataStore parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static DataStore parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataStore parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DataStore parseFrom(CodedInputStream input)
public static DataStore parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static DataStore parseFrom(InputStream input)
public static DataStore parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static DataStore parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DataStore parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<DataStore> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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];
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];
getDefaultInstanceForType()
public DataStore getDefaultInstanceForType()
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;
getDocumentProcessingConfigOrBuilder()
public DocumentProcessingConfigOrBuilder getDocumentProcessingConfigOrBuilder()
Configuration for Document understanding and enrichment.
.google.cloud.discoveryengine.v1alpha.DocumentProcessingConfig document_processing_config = 27;
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];
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];
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.
|
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()
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;
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;
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.
|
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()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public DataStore.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DataStore.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public DataStore.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
