Class SearchExamplesRequest.Builder (3.64.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

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

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

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchExamplesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchExamplesRequest.Builder
Overrides

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

getDefaultInstanceForType()

public SearchExamplesRequest getDefaultInstanceForType()
Returns
Type Description
SearchExamplesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchExamplesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchExamplesRequest.Builder
Overrides

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

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

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

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