com.google.cloud.discoveryengine.v1beta

Class DataStore

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1beta.DataStore

All Implemented Interfaces:

DataStoreOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DataStore
extends com.google.protobuf.GeneratedMessageV3
implements DataStoreOrBuilder

 DataStore captures global settings and configs at the DataStore level.
 

Protobuf type google.cloud.discoveryengine.v1beta.DataStore

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataStore.Builder DataStore captures global settings and configs at the DataStore level.
static class	DataStore.ContentConfig Content config of the data store.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENT_CONFIG_FIELD_NUMBER
static int	CREATE_TIME_FIELD_NUMBER
static int	DEFAULT_SCHEMA_ID_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	INDUSTRY_VERTICAL_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SOLUTION_TYPES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
DataStore.ContentConfig	getContentConfig() Immutable.
int	getContentConfigValue() Immutable.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
static DataStore	getDefaultInstance()
DataStore	getDefaultInstanceForType()
String	getDefaultSchemaId() Output only.
com.google.protobuf.ByteString	getDefaultSchemaIdBytes() Output only.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
IndustryVertical	getIndustryVertical() Immutable.
int	getIndustryVerticalValue() Immutable.
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
com.google.protobuf.Parser<DataStore>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DataStore.Builder	newBuilder()
static DataStore.Builder	newBuilder(DataStore prototype)
DataStore.Builder	newBuilderForType()
protected DataStore.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DataStore	parseDelimitedFrom(InputStream input)
static DataStore	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataStore	parseFrom(byte[] data)
static DataStore	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataStore	parseFrom(ByteBuffer data)
static DataStore	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataStore	parseFrom(com.google.protobuf.ByteString data)
static DataStore	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataStore	parseFrom(com.google.protobuf.CodedInputStream input)
static DataStore	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DataStore	parseFrom(InputStream input)
static DataStore	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DataStore>	parser()
DataStore.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

INDUSTRY_VERTICAL_FIELD_NUMBER

public static final int INDUSTRY_VERTICAL_FIELD_NUMBER

See Also:

Constant Field Values

SOLUTION_TYPES_FIELD_NUMBER

public static final int SOLUTION_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

DEFAULT_SCHEMA_ID_FIELD_NUMBER

public static final int DEFAULT_SCHEMA_ID_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_CONFIG_FIELD_NUMBER

public static final int CONTENT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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

Specified by:

getName in interface DataStoreOrBuilder

Returns:

The name.

getNameBytes

public 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];

Specified by:

getNameBytes in interface DataStoreOrBuilder

Returns:

The bytes for name.

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

Specified by:

getDisplayName in interface DataStoreOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public 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];

Specified by:

getDisplayNameBytes in interface DataStoreOrBuilder

Returns:

The bytes for displayName.

getIndustryVerticalValue

public int getIndustryVerticalValue()

 Immutable. The industry vertical that the data store registers.
 

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

Specified by:

getIndustryVerticalValue in interface DataStoreOrBuilder

Returns:

The enum numeric value on the wire for industryVertical.

getIndustryVertical

public IndustryVertical getIndustryVertical()

 Immutable. The industry vertical that the data store registers.
 

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

Specified by:

getIndustryVertical in interface DataStoreOrBuilder

Returns:

The industryVertical.

getSolutionTypesList

public 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;

Specified by:

getSolutionTypesList in interface DataStoreOrBuilder

Returns:

A list containing the solutionTypes.

getSolutionTypesCount

public 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;

Specified by:

getSolutionTypesCount in interface DataStoreOrBuilder

Returns:

The count of solutionTypes.

getSolutionTypes

public 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;

Specified by:

getSolutionTypes in interface DataStoreOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The solutionTypes at the given index.

getSolutionTypesValueList

public 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;

Specified by:

getSolutionTypesValueList in interface DataStoreOrBuilder

Returns:

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

getSolutionTypesValue

public 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;

Specified by:

getSolutionTypesValue in interface DataStoreOrBuilder

Parameters:

index - The index of the value to return.

Returns:

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

getDefaultSchemaId

public 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];

Specified by:

getDefaultSchemaId in interface DataStoreOrBuilder

Returns:

The defaultSchemaId.

getDefaultSchemaIdBytes

public 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];

Specified by:

getDefaultSchemaIdBytes in interface DataStoreOrBuilder

Returns:

The bytes for defaultSchemaId.

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

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

Specified by:

getContentConfigValue in interface DataStoreOrBuilder

Returns:

The enum numeric value on the wire for contentConfig.

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

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

Specified by:

getContentConfig in interface DataStoreOrBuilder

Returns:

The contentConfig.

hasCreateTime

public 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];

Specified by:

hasCreateTime in interface DataStoreOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime

public 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];

Specified by:

getCreateTime in interface DataStoreOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder

public 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];

Specified by:

getCreateTimeOrBuilder in interface DataStoreOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DataStore parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DataStore parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static DataStore parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataStore parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static DataStore parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static DataStore parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static DataStore parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public DataStore.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DataStore.Builder newBuilder()

newBuilder

public static DataStore.Builder newBuilder(DataStore prototype)

toBuilder

public DataStore.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DataStore.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DataStore getDefaultInstance()

parser

public static com.google.protobuf.Parser<DataStore> parser()

getParserForType

public com.google.protobuf.Parser<DataStore> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DataStore getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder