Class SearchExamplesRequest.Builder (3.79.0)

Version latest

• 3.79.0 (latest)
• 3.77.0
• 3.76.0
• 3.75.0
• 3.74.0
• 3.73.0
• 3.71.0
• 3.69.0
• 3.68.0
• 3.65.0
• 3.64.0
• 3.63.0
• 3.61.0
• 3.60.0
• 3.59.0
• 3.58.0
• 3.57.0
• 3.56.0
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

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

Request message for ExampleStoreService.SearchExamples.

Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SearchExamplesRequest.Builder

Implements

SearchExamplesRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchExamplesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public SearchExamplesRequest build()

Returns
Type	Description
SearchExamplesRequest

buildPartial()

public SearchExamplesRequest buildPartial()

Returns
Type	Description
SearchExamplesRequest

clear()

public SearchExamplesRequest.Builder clear()

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
SearchExamplesRequest.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchExamplesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchExamplesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearParameters()

public SearchExamplesRequest.Builder clearParameters()

Returns
Type	Description
SearchExamplesRequest.Builder

clearStoredContentsExampleParameters()

public SearchExamplesRequest.Builder clearStoredContentsExampleParameters()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
SearchExamplesRequest.Builder

clearTopK()

public SearchExamplesRequest.Builder clearTopK()

Optional. The number of similar examples to return.

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

Returns
Type	Description
SearchExamplesRequest.Builder	This builder for chaining.

clone()

public SearchExamplesRequest.Builder clone()

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchExamplesRequest getDefaultInstanceForType()

Returns
Type	Description
SearchExamplesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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) = { ... }

Returns
Type	Description
String	The exampleStore.

getExampleStoreBytes()

public 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) = { ... }

Returns
Type	Description
ByteString	The bytes for exampleStore.

getParametersCase()

public SearchExamplesRequest.ParametersCase getParametersCase()

Returns
Type	Description
SearchExamplesRequest.ParametersCase

getStoredContentsExampleParameters()

public StoredContentsExampleParameters getStoredContentsExampleParameters()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
StoredContentsExampleParameters	The storedContentsExampleParameters.

getStoredContentsExampleParametersBuilder()

public StoredContentsExampleParameters.Builder getStoredContentsExampleParametersBuilder()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
StoredContentsExampleParameters.Builder

getStoredContentsExampleParametersOrBuilder()

public StoredContentsExampleParametersOrBuilder getStoredContentsExampleParametersOrBuilder()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
StoredContentsExampleParametersOrBuilder

getTopK()

public long getTopK()

Optional. The number of similar examples to return.

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

Returns
Type	Description
long	The topK.

hasStoredContentsExampleParameters()

public boolean hasStoredContentsExampleParameters()

The parameters of StoredContentsExamples to be searched.

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

Returns
Type	Description
boolean	Whether the storedContentsExampleParameters field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(SearchExamplesRequest other)

public SearchExamplesRequest.Builder mergeFrom(SearchExamplesRequest other)

Parameter
Name	Description
other	SearchExamplesRequest

Returns
Type	Description
SearchExamplesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchExamplesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchExamplesRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeStoredContentsExampleParameters(StoredContentsExampleParameters value)

public SearchExamplesRequest.Builder mergeStoredContentsExampleParameters(StoredContentsExampleParameters value)

The parameters of StoredContentsExamples to be searched.

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

Parameter
Name	Description
value	StoredContentsExampleParameters

Returns
Type	Description
SearchExamplesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchExamplesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setExampleStore(String value)

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) = { ... }

Parameter
Name	Description
value	String The exampleStore to set.

Returns
Type	Description
SearchExamplesRequest.Builder	This builder for chaining.

setExampleStoreBytes(ByteString value)

public SearchExamplesRequest.Builder setExampleStoreBytes(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) = { ... }

Parameter
Name	Description
value	ByteString The bytes for exampleStore to set.

Returns
Type	Description
SearchExamplesRequest.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchExamplesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchExamplesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStoredContentsExampleParameters(StoredContentsExampleParameters value)

public SearchExamplesRequest.Builder setStoredContentsExampleParameters(StoredContentsExampleParameters value)

The parameters of StoredContentsExamples to be searched.

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

Parameter
Name	Description
value	StoredContentsExampleParameters

Returns
Type	Description
SearchExamplesRequest.Builder

setStoredContentsExampleParameters(StoredContentsExampleParameters.Builder builderForValue)

public SearchExamplesRequest.Builder setStoredContentsExampleParameters(StoredContentsExampleParameters.Builder builderForValue)

The parameters of StoredContentsExamples to be searched.

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

Parameter
Name	Description
builderForValue	StoredContentsExampleParameters.Builder

Returns
Type	Description
SearchExamplesRequest.Builder

setTopK(long value)

public SearchExamplesRequest.Builder setTopK(long value)

Optional. The number of similar examples to return.

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

Parameter
Name	Description
value	long The topK to set.

Returns
Type	Description
SearchExamplesRequest.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchExamplesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchExamplesRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)