com.google.cloud.aiplatform.v1beta1

Class StoredContentsExample

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.StoredContentsExample

All Implemented Interfaces:

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

public final class StoredContentsExample
extends com.google.protobuf.GeneratedMessageV3
implements StoredContentsExampleOrBuilder

 A ContentsExample to be used with GenerateContent alongside information
 required for storage and retrieval with Example Store.
 

Protobuf type google.cloud.aiplatform.v1beta1.StoredContentsExample

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StoredContentsExample.Builder A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.
static class	StoredContentsExample.SearchKeyGenerationMethod Options for generating the search key from the conversation history.
static interface	StoredContentsExample.SearchKeyGenerationMethodOrBuilder

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	CONTENTS_EXAMPLE_FIELD_NUMBER
static int	SEARCH_KEY_FIELD_NUMBER
static int	SEARCH_KEY_GENERATION_METHOD_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)
ContentsExample	getContentsExample() Required.
ContentsExampleOrBuilder	getContentsExampleOrBuilder() Required.
static StoredContentsExample	getDefaultInstance()
StoredContentsExample	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<StoredContentsExample>	getParserForType()
String	getSearchKey() Optional.
com.google.protobuf.ByteString	getSearchKeyBytes() Optional.
StoredContentsExample.SearchKeyGenerationMethod	getSearchKeyGenerationMethod() Optional.
StoredContentsExample.SearchKeyGenerationMethodOrBuilder	getSearchKeyGenerationMethodOrBuilder() Optional.
int	getSerializedSize()
boolean	hasContentsExample() Required.
int	hashCode()
boolean	hasSearchKeyGenerationMethod() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static StoredContentsExample.Builder	newBuilder()
static StoredContentsExample.Builder	newBuilder(StoredContentsExample prototype)
StoredContentsExample.Builder	newBuilderForType()
protected StoredContentsExample.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static StoredContentsExample	parseDelimitedFrom(InputStream input)
static StoredContentsExample	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StoredContentsExample	parseFrom(byte[] data)
static StoredContentsExample	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StoredContentsExample	parseFrom(ByteBuffer data)
static StoredContentsExample	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StoredContentsExample	parseFrom(com.google.protobuf.ByteString data)
static StoredContentsExample	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StoredContentsExample	parseFrom(com.google.protobuf.CodedInputStream input)
static StoredContentsExample	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static StoredContentsExample	parseFrom(InputStream input)
static StoredContentsExample	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<StoredContentsExample>	parser()
StoredContentsExample.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

SEARCH_KEY_FIELD_NUMBER

public static final int SEARCH_KEY_FIELD_NUMBER

See Also:

Constant Field Values

CONTENTS_EXAMPLE_FIELD_NUMBER

public static final int CONTENTS_EXAMPLE_FIELD_NUMBER

See Also:

Constant Field Values

SEARCH_KEY_GENERATION_METHOD_FIELD_NUMBER

public static final int SEARCH_KEY_GENERATION_METHOD_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

getSearchKey

public String getSearchKey()

 Optional. (Optional) the search key used for retrieval. If not provided at
 upload-time, the search key will be generated from
 `contents_example.contents` using the method provided by
 `search_key_generation_method`. The generated search key will be included
 in retrieved examples.
 

string search_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSearchKey in interface StoredContentsExampleOrBuilder

Returns:

The searchKey.

getSearchKeyBytes

public com.google.protobuf.ByteString getSearchKeyBytes()

 Optional. (Optional) the search key used for retrieval. If not provided at
 upload-time, the search key will be generated from
 `contents_example.contents` using the method provided by
 `search_key_generation_method`. The generated search key will be included
 in retrieved examples.
 

string search_key = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSearchKeyBytes in interface StoredContentsExampleOrBuilder

Returns:

The bytes for searchKey.

hasContentsExample

public boolean hasContentsExample()

 Required. The example to be used with GenerateContent.
 

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

hasContentsExample in interface StoredContentsExampleOrBuilder

Returns:

Whether the contentsExample field is set.

getContentsExample

public ContentsExample getContentsExample()

 Required. The example to be used with GenerateContent.
 

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getContentsExample in interface StoredContentsExampleOrBuilder

Returns:

The contentsExample.

getContentsExampleOrBuilder

public ContentsExampleOrBuilder getContentsExampleOrBuilder()

 Required. The example to be used with GenerateContent.
 

.google.cloud.aiplatform.v1beta1.ContentsExample contents_example = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getContentsExampleOrBuilder in interface StoredContentsExampleOrBuilder

hasSearchKeyGenerationMethod

public boolean hasSearchKeyGenerationMethod()

 Optional. The method used to generate the search key from
 `contents_example.contents`. This is ignored when uploading an example if
 `search_key` is provided.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasSearchKeyGenerationMethod in interface StoredContentsExampleOrBuilder

Returns:

Whether the searchKeyGenerationMethod field is set.

getSearchKeyGenerationMethod

public StoredContentsExample.SearchKeyGenerationMethod getSearchKeyGenerationMethod()

 Optional. The method used to generate the search key from
 `contents_example.contents`. This is ignored when uploading an example if
 `search_key` is provided.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSearchKeyGenerationMethod in interface StoredContentsExampleOrBuilder

Returns:

The searchKeyGenerationMethod.

getSearchKeyGenerationMethodOrBuilder

public StoredContentsExample.SearchKeyGenerationMethodOrBuilder getSearchKeyGenerationMethodOrBuilder()

 Optional. The method used to generate the search key from
 `contents_example.contents`. This is ignored when uploading an example if
 `search_key` is provided.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExample.SearchKeyGenerationMethod search_key_generation_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSearchKeyGenerationMethodOrBuilder in interface StoredContentsExampleOrBuilder

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 StoredContentsExample parseFrom(ByteBuffer data)
                                       throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static StoredContentsExample parseFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static StoredContentsExample parseDelimitedFrom(InputStream input)
                                                throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public StoredContentsExample.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static StoredContentsExample.Builder newBuilder()

newBuilder

public static StoredContentsExample.Builder newBuilder(StoredContentsExample prototype)

toBuilder

public StoredContentsExample.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static StoredContentsExample getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<StoredContentsExample> 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 StoredContentsExample getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder