com.google.cloud.discoveryengine.v1beta

Interface DataStoreOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

DataStore, DataStore.Builder

public interface DataStoreOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
DataStore.ContentConfig	getContentConfig() Immutable.
int	getContentConfigValue() Immutable.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDefaultSchemaId() Output only.
com.google.protobuf.ByteString	getDefaultSchemaIdBytes() Output only.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
IndustryVertical	getIndustryVertical() Immutable.
int	getIndustryVerticalValue() Immutable.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
SolutionType	getSolutionTypes(int index) The solutions that the data store enrolls.
int	getSolutionTypesCount() The solutions that the data store enrolls.
List<SolutionType>	getSolutionTypesList() The solutions that the data store enrolls.
int	getSolutionTypesValue(int index) The solutions that the data store enrolls.
List<Integer>	getSolutionTypesValueList() The solutions that the data store enrolls.
boolean	hasCreateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

getIndustryVerticalValue

int getIndustryVerticalValue()

 Immutable. The industry vertical that the data store registers.
 

.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for industryVertical.

getIndustryVertical

IndustryVertical getIndustryVertical()

 Immutable. The industry vertical that the data store registers.
 

.google.cloud.discoveryengine.v1beta.IndustryVertical industry_vertical = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The industryVertical.

getSolutionTypesList

List<SolutionType> getSolutionTypesList()

 The solutions that the data store enrolls. Available solutions for each
 [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.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.v1beta.SolutionType solution_types = 5;

Returns:

A list containing the solutionTypes.

getSolutionTypesCount

int getSolutionTypesCount()

 The solutions that the data store enrolls. Available solutions for each
 [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.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.v1beta.SolutionType solution_types = 5;

Returns:

The count of solutionTypes.

getSolutionTypes

SolutionType getSolutionTypes(int index)

 The solutions that the data store enrolls. Available solutions for each
 [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.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.v1beta.SolutionType solution_types = 5;

Parameters:

index - The index of the element to return.

Returns:

The solutionTypes at the given index.

getSolutionTypesValueList

List<Integer> getSolutionTypesValueList()

 The solutions that the data store enrolls. Available solutions for each
 [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.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.v1beta.SolutionType solution_types = 5;

Returns:

A list containing the enum numeric values on the wire for solutionTypes.

getSolutionTypesValue

int getSolutionTypesValue(int index)

 The solutions that the data store enrolls. Available solutions for each
 [industry_vertical][google.cloud.discoveryengine.v1beta.DataStore.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.v1beta.SolutionType solution_types = 5;

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of solutionTypes at the given index.

getDefaultSchemaId

String getDefaultSchemaId()

 Output only. The id of the default
 [Schema][google.cloud.discoveryengine.v1beta.Schema] asscociated to this
 data store.
 

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

Returns:

The defaultSchemaId.

getDefaultSchemaIdBytes

com.google.protobuf.ByteString getDefaultSchemaIdBytes()

 Output only. The id of the default
 [Schema][google.cloud.discoveryengine.v1beta.Schema] asscociated to this
 data store.
 

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

Returns:

The bytes for defaultSchemaId.

getContentConfigValue

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.v1beta.DataStore.ContentConfig.NO_CONTENT].
 

.google.cloud.discoveryengine.v1beta.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for contentConfig.

getContentConfig

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.v1beta.DataStore.ContentConfig.NO_CONTENT].
 

.google.cloud.discoveryengine.v1beta.DataStore.ContentConfig content_config = 6 [(.google.api.field_behavior) = IMMUTABLE];

Returns:

The contentConfig.

hasCreateTime

boolean hasCreateTime()

 Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Timestamp the
 [DataStore][google.cloud.discoveryengine.v1beta.DataStore] was created at.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];