com.google.cloud.aiplatform.v1beta1

Class StoredContentsExample.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

com.google.cloud.aiplatform.v1beta1.StoredContentsExample.Builder

All Implemented Interfaces:

StoredContentsExampleOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

StoredContentsExample

public static final class StoredContentsExample.Builder
extends com.google.protobuf.GeneratedMessageV3.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

Method Summary

Modifier and Type	Method and Description
StoredContentsExample.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StoredContentsExample	build()
StoredContentsExample	buildPartial()
StoredContentsExample.Builder	clear()
StoredContentsExample.Builder	clearContentsExample() Required.
StoredContentsExample.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
StoredContentsExample.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
StoredContentsExample.Builder	clearSearchKey() Optional.
StoredContentsExample.Builder	clearSearchKeyGenerationMethod() Optional.
StoredContentsExample.Builder	clone()
ContentsExample	getContentsExample() Required.
ContentsExample.Builder	getContentsExampleBuilder() Required.
ContentsExampleOrBuilder	getContentsExampleOrBuilder() Required.
StoredContentsExample	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getSearchKey() Optional.
com.google.protobuf.ByteString	getSearchKeyBytes() Optional.
StoredContentsExample.SearchKeyGenerationMethod	getSearchKeyGenerationMethod() Optional.
StoredContentsExample.SearchKeyGenerationMethod.Builder	getSearchKeyGenerationMethodBuilder() Optional.
StoredContentsExample.SearchKeyGenerationMethodOrBuilder	getSearchKeyGenerationMethodOrBuilder() Optional.
boolean	hasContentsExample() Required.
boolean	hasSearchKeyGenerationMethod() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
StoredContentsExample.Builder	mergeContentsExample(ContentsExample value) Required.
StoredContentsExample.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
StoredContentsExample.Builder	mergeFrom(com.google.protobuf.Message other)
StoredContentsExample.Builder	mergeFrom(StoredContentsExample other)
StoredContentsExample.Builder	mergeSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value) Optional.
StoredContentsExample.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
StoredContentsExample.Builder	setContentsExample(ContentsExample.Builder builderForValue) Required.
StoredContentsExample.Builder	setContentsExample(ContentsExample value) Required.
StoredContentsExample.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
StoredContentsExample.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
StoredContentsExample.Builder	setSearchKey(String value) Optional.
StoredContentsExample.Builder	setSearchKeyBytes(com.google.protobuf.ByteString value) Optional.
StoredContentsExample.Builder	setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod.Builder builderForValue) Optional.
StoredContentsExample.Builder	setSearchKeyGenerationMethod(StoredContentsExample.SearchKeyGenerationMethod value) Optional.
StoredContentsExample.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<StoredContentsExample.Builder>

clear

public StoredContentsExample.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

getDefaultInstanceForType

public StoredContentsExample getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public StoredContentsExample build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public StoredContentsExample buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public StoredContentsExample.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

setField

public StoredContentsExample.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

clearField

public StoredContentsExample.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

clearOneof

public StoredContentsExample.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

setRepeatedField

public StoredContentsExample.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      int index,
                                                      Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

addRepeatedField

public StoredContentsExample.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

mergeFrom

public StoredContentsExample.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StoredContentsExample.Builder>

mergeFrom

public StoredContentsExample.Builder mergeFrom(StoredContentsExample other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

mergeFrom

public StoredContentsExample.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<StoredContentsExample.Builder>

Throws:

IOException

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.

setSearchKey

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

Parameters:

value - The searchKey to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

setSearchKeyBytes

public StoredContentsExample.Builder setSearchKeyBytes(com.google.protobuf.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];

Parameters:

value - The bytes for searchKey to set.

Returns:

This builder for chaining.

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.

setContentsExample

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

setContentsExample

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

mergeContentsExample

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

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

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

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.

setSearchKeyGenerationMethod

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

setSearchKeyGenerationMethod

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

mergeSearchKeyGenerationMethod

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

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

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

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

setUnknownFields

public final StoredContentsExample.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>

mergeUnknownFields

public final StoredContentsExample.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<StoredContentsExample.Builder>