com.google.cloud.aiplatform.v1beta1

Interface StoredContentsExampleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

StoredContentsExample, StoredContentsExample.Builder

public interface StoredContentsExampleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
ContentsExample	getContentsExample() Required.
ContentsExampleOrBuilder	getContentsExampleOrBuilder() Required.
String	getSearchKey() Optional.
com.google.protobuf.ByteString	getSearchKeyBytes() Optional.
StoredContentsExample.SearchKeyGenerationMethod	getSearchKeyGenerationMethod() Optional.
StoredContentsExample.SearchKeyGenerationMethodOrBuilder	getSearchKeyGenerationMethodOrBuilder() Optional.
boolean	hasContentsExample() Required.
boolean	hasSearchKeyGenerationMethod() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSearchKey

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:

The searchKey.

getSearchKeyBytes

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

Returns:

The bytes for searchKey.

hasContentsExample

boolean hasContentsExample()

 Required. The example to be used with GenerateContent.
 

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

Returns:

Whether the contentsExample field is set.

getContentsExample

ContentsExample getContentsExample()

 Required. The example to be used with GenerateContent.
 

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

Returns:

The contentsExample.

getContentsExampleOrBuilder

ContentsExampleOrBuilder getContentsExampleOrBuilder()

 Required. The example to be used with GenerateContent.
 

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

hasSearchKeyGenerationMethod

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:

Whether the searchKeyGenerationMethod field is set.

getSearchKeyGenerationMethod

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:

The searchKeyGenerationMethod.

getSearchKeyGenerationMethodOrBuilder

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