com.google.cloud.aiplatform.v1beta1

Class SearchExamplesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.aiplatform.v1beta1.SearchExamplesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

SearchExamplesRequest

public static final class SearchExamplesRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchExamplesRequest.Builder>
implements SearchExamplesRequestOrBuilder

 Request message for
 [ExampleStoreService.SearchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.SearchExamples].
 

Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesRequest

Method Summary

Modifier and Type	Method and Description
SearchExamplesRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchExamplesRequest	build()
SearchExamplesRequest	buildPartial()
SearchExamplesRequest.Builder	clear()
SearchExamplesRequest.Builder	clearExampleStore() Required.
SearchExamplesRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
SearchExamplesRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
SearchExamplesRequest.Builder	clearParameters()
SearchExamplesRequest.Builder	clearStoredContentsExampleParameters() The parameters of StoredContentsExamples to be searched.
SearchExamplesRequest.Builder	clearTopK() Optional.
SearchExamplesRequest.Builder	clone()
SearchExamplesRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getExampleStore() Required.
com.google.protobuf.ByteString	getExampleStoreBytes() Required.
SearchExamplesRequest.ParametersCase	getParametersCase()
StoredContentsExampleParameters	getStoredContentsExampleParameters() The parameters of StoredContentsExamples to be searched.
StoredContentsExampleParameters.Builder	getStoredContentsExampleParametersBuilder() The parameters of StoredContentsExamples to be searched.
StoredContentsExampleParametersOrBuilder	getStoredContentsExampleParametersOrBuilder() The parameters of StoredContentsExamples to be searched.
long	getTopK() Optional.
boolean	hasStoredContentsExampleParameters() The parameters of StoredContentsExamples to be searched.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
SearchExamplesRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
SearchExamplesRequest.Builder	mergeFrom(com.google.protobuf.Message other)
SearchExamplesRequest.Builder	mergeFrom(SearchExamplesRequest other)
SearchExamplesRequest.Builder	mergeStoredContentsExampleParameters(StoredContentsExampleParameters value) The parameters of StoredContentsExamples to be searched.
SearchExamplesRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
SearchExamplesRequest.Builder	setExampleStore(String value) Required.
SearchExamplesRequest.Builder	setExampleStoreBytes(com.google.protobuf.ByteString value) Required.
SearchExamplesRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
SearchExamplesRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
SearchExamplesRequest.Builder	setStoredContentsExampleParameters(StoredContentsExampleParameters.Builder builderForValue) The parameters of StoredContentsExamples to be searched.
SearchExamplesRequest.Builder	setStoredContentsExampleParameters(StoredContentsExampleParameters value) The parameters of StoredContentsExamples to be searched.
SearchExamplesRequest.Builder	setTopK(long value) Optional.
SearchExamplesRequest.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<SearchExamplesRequest.Builder>

clear

public SearchExamplesRequest.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<SearchExamplesRequest.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<SearchExamplesRequest.Builder>

getDefaultInstanceForType

public SearchExamplesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public SearchExamplesRequest build()

Specified by:

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

Specified by:

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

buildPartial

public SearchExamplesRequest buildPartial()

Specified by:

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

Specified by:

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

clone

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

setField

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

clearField

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

clearOneof

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

setRepeatedField

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

addRepeatedField

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

mergeFrom

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

mergeFrom

public SearchExamplesRequest.Builder mergeFrom(SearchExamplesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

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

mergeFrom

public SearchExamplesRequest.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<SearchExamplesRequest.Builder>

Throws:

IOException

getParametersCase

public SearchExamplesRequest.ParametersCase getParametersCase()

Specified by:

getParametersCase in interface SearchExamplesRequestOrBuilder

clearParameters

public SearchExamplesRequest.Builder clearParameters()

hasStoredContentsExampleParameters

public boolean hasStoredContentsExampleParameters()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

Specified by:

hasStoredContentsExampleParameters in interface SearchExamplesRequestOrBuilder

Returns:

Whether the storedContentsExampleParameters field is set.

getStoredContentsExampleParameters

public StoredContentsExampleParameters getStoredContentsExampleParameters()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

Specified by:

getStoredContentsExampleParameters in interface SearchExamplesRequestOrBuilder

Returns:

The storedContentsExampleParameters.

setStoredContentsExampleParameters

public SearchExamplesRequest.Builder setStoredContentsExampleParameters(StoredContentsExampleParameters value)

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

setStoredContentsExampleParameters

public SearchExamplesRequest.Builder setStoredContentsExampleParameters(StoredContentsExampleParameters.Builder builderForValue)

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

mergeStoredContentsExampleParameters

public SearchExamplesRequest.Builder mergeStoredContentsExampleParameters(StoredContentsExampleParameters value)

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

clearStoredContentsExampleParameters

public SearchExamplesRequest.Builder clearStoredContentsExampleParameters()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

getStoredContentsExampleParametersBuilder

public StoredContentsExampleParameters.Builder getStoredContentsExampleParametersBuilder()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

getStoredContentsExampleParametersOrBuilder

public StoredContentsExampleParametersOrBuilder getStoredContentsExampleParametersOrBuilder()

 The parameters of StoredContentsExamples to be searched.
 

.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;

Specified by:

getStoredContentsExampleParametersOrBuilder in interface SearchExamplesRequestOrBuilder

getExampleStore

public String getExampleStore()

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getExampleStore in interface SearchExamplesRequestOrBuilder

Returns:

The exampleStore.

getExampleStoreBytes

public com.google.protobuf.ByteString getExampleStoreBytes()

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getExampleStoreBytes in interface SearchExamplesRequestOrBuilder

Returns:

The bytes for exampleStore.

setExampleStore

public SearchExamplesRequest.Builder setExampleStore(String value)

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The exampleStore to set.

Returns:

This builder for chaining.

clearExampleStore

public SearchExamplesRequest.Builder clearExampleStore()

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setExampleStoreBytes

public SearchExamplesRequest.Builder setExampleStoreBytes(com.google.protobuf.ByteString value)

 Required. The name of the ExampleStore resource that examples are retrieved
 from. Format:
 `projects/{project}/locations/{location}/exampleStores/{example_store}`
 

string example_store = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameters:

value - The bytes for exampleStore to set.

Returns:

This builder for chaining.

getTopK

public long getTopK()

 Optional. The number of similar examples to return.
 

int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTopK in interface SearchExamplesRequestOrBuilder

Returns:

The topK.

setTopK

public SearchExamplesRequest.Builder setTopK(long value)

 Optional. The number of similar examples to return.
 

int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The topK to set.

Returns:

This builder for chaining.

clearTopK

public SearchExamplesRequest.Builder clearTopK()

 Optional. The number of similar examples to return.
 

int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUnknownFields

public final SearchExamplesRequest.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<SearchExamplesRequest.Builder>

mergeUnknownFields

public final SearchExamplesRequest.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<SearchExamplesRequest.Builder>