Class StoredContentsExample.Builder (3.88.0)

3.88.0 (latest) 3.86.0 3.84.0 3.83.0 3.82.0 3.81.0 3.79.0 3.77.0 3.76.0 3.75.0 3.74.0 3.73.0 3.71.0 3.69.0 3.68.0 3.65.0 3.64.0 3.63.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.2 3.3.0 3.2.0 3.0.0 2.9.8 2.8.9 2.7.4 2.5.3 2.4.0

public static final class StoredContentsExample.Builder extends GeneratedMessage.Builder<StoredContentsExample.Builder> 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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > StoredContentsExample.Builder

Implements

StoredContentsExampleOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

build()

public StoredContentsExample build()

Returns
Type	Description
StoredContentsExample

buildPartial()

public StoredContentsExample buildPartial()

Returns
Type	Description
StoredContentsExample

clear()

public StoredContentsExample.Builder clear()

Returns
Type	Description
StoredContentsExample.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearContentsExample()

public StoredContentsExample.Builder clearContentsExample()

Required. The example to be used with GenerateContent.

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

Returns
Type	Description
StoredContentsExample.Builder

clearSearchKey()

public StoredContentsExample.Builder clearSearchKey()

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

Returns
Type	Description
StoredContentsExample.Builder	This builder for chaining.

clearSearchKeyGenerationMethod()

public StoredContentsExample.Builder clearSearchKeyGenerationMethod()

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

Returns
Type	Description
StoredContentsExample.Builder

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

Returns
Type	Description
ContentsExample	The contentsExample.

getContentsExampleBuilder()

public ContentsExample.Builder getContentsExampleBuilder()

Required. The example to be used with GenerateContent.

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

Returns
Type	Description
ContentsExample.Builder

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

Returns
Type	Description
ContentsExampleOrBuilder

getDefaultInstanceForType()

public StoredContentsExample getDefaultInstanceForType()

Returns
Type	Description
StoredContentsExample

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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

Returns
Type	Description
String	The searchKey.

getSearchKeyBytes()

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

Returns
Type	Description
ByteString	The bytes for searchKey.

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

Returns
Type	Description
StoredContentsExample.SearchKeyGenerationMethod	The searchKeyGenerationMethod.

getSearchKeyGenerationMethodBuilder()

public StoredContentsExample.SearchKeyGenerationMethod.Builder getSearchKeyGenerationMethodBuilder()

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

Returns
Type	Description
StoredContentsExample.SearchKeyGenerationMethod.Builder

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

Returns
Type	Description
StoredContentsExample.SearchKeyGenerationMethodOrBuilder

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

Returns
Type	Description
boolean	Whether the contentsExample field is set.

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

Returns
Type	Description
boolean	Whether the searchKeyGenerationMethod field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeContentsExample(ContentsExample value)

public StoredContentsExample.Builder mergeContentsExample(ContentsExample value)

Required. The example to be used with GenerateContent.

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

Parameter
Name	Description
value	ContentsExample

Returns
Type	Description
StoredContentsExample.Builder

mergeFrom(StoredContentsExample other)

public StoredContentsExample.Builder mergeFrom(StoredContentsExample other)

Parameter
Name	Description
other	StoredContentsExample

Returns
Type	Description
StoredContentsExample.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StoredContentsExample.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
StoredContentsExample.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public StoredContentsExample.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
StoredContentsExample.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value)

public StoredContentsExample.Builder mergeSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value)

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

Parameter
Name	Description
value	StoredContentsExample.SearchKeyGenerationMethod

Returns
Type	Description
StoredContentsExample.Builder

setContentsExample(ContentsExample value)

public StoredContentsExample.Builder setContentsExample(ContentsExample value)

Required. The example to be used with GenerateContent.

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

Parameter
Name	Description
value	ContentsExample

Returns
Type	Description
StoredContentsExample.Builder

setContentsExample(ContentsExample.Builder builderForValue)

public StoredContentsExample.Builder setContentsExample(ContentsExample.Builder builderForValue)

Required. The example to be used with GenerateContent.

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

Parameter
Name	Description
builderForValue	ContentsExample.Builder

Returns
Type	Description
StoredContentsExample.Builder

setSearchKey(String value)

public StoredContentsExample.Builder setSearchKey(String value)

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

Parameter
Name	Description
value	String The searchKey to set.

Returns
Type	Description
StoredContentsExample.Builder	This builder for chaining.

setSearchKeyBytes(ByteString value)

public StoredContentsExample.Builder setSearchKeyBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for searchKey to set.

Returns
Type	Description
StoredContentsExample.Builder	This builder for chaining.

setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value)

public StoredContentsExample.Builder setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value)

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

Parameter
Name	Description
value	StoredContentsExample.SearchKeyGenerationMethod

Returns
Type	Description
StoredContentsExample.Builder

setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod.Builder builderForValue)

public StoredContentsExample.Builder setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod.Builder builderForValue)

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

Parameter
Name	Description
builderForValue	StoredContentsExample.SearchKeyGenerationMethod.Builder

Returns
Type	Description
StoredContentsExample.Builder