public static final class StoredContentsExample.Builder extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public StoredContentsExample.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public StoredContentsExample build()
buildPartial()
public StoredContentsExample buildPartial()
clear()
public StoredContentsExample.Builder clear()
Overrides
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];
clearField(Descriptors.FieldDescriptor field)
public StoredContentsExample.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public StoredContentsExample.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
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];
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];
clone()
public StoredContentsExample.Builder clone()
Overrides
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];
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];
getDefaultInstanceForType()
public StoredContentsExample getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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];
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];
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 GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
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];
mergeFrom(StoredContentsExample other)
public StoredContentsExample.Builder mergeFrom(StoredContentsExample other)
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public StoredContentsExample.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public StoredContentsExample.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
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];
mergeUnknownFields(UnknownFieldSet unknownFields)
public final StoredContentsExample.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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];
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];
setField(Descriptors.FieldDescriptor field, Object value)
public StoredContentsExample.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public StoredContentsExample.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
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.
|
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.
|
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];
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];
setUnknownFields(UnknownFieldSet unknownFields)
public final StoredContentsExample.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
