Class StoredContentsExample (3.77.0)
Version 3.77.0keyboard_arrow_down
public final class StoredContentsExample extends 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENTS_EXAMPLE_FIELD_NUMBER
public static final int CONTENTS_EXAMPLE_FIELD_NUMBER
Field Value
Type Description
int
SEARCH_KEY_FIELD_NUMBER
public static final int SEARCH_KEY_FIELD_NUMBER
Field Value
Type Description
int
SEARCH_KEY_GENERATION_METHOD_FIELD_NUMBER
public static final int SEARCH_KEY_GENERATION_METHOD_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static StoredContentsExample getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static StoredContentsExample . Builder newBuilder ()
newBuilder(StoredContentsExample prototype)
public static StoredContentsExample . Builder newBuilder ( StoredContentsExample prototype )
parseDelimitedFrom(InputStream input)
public static StoredContentsExample parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static StoredContentsExample parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static StoredContentsExample parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static StoredContentsExample parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static StoredContentsExample parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static StoredContentsExample parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StoredContentsExample parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<StoredContentsExample> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
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];
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 ()
getParserForType()
public Parser<StoredContentsExample> getParserForType ()
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];
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];
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
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.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public StoredContentsExample . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StoredContentsExample . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public StoredContentsExample . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
