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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public SearchExamplesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchExamplesRequest build()
public SearchExamplesRequest buildPartial()
public SearchExamplesRequest.Builder clear()
Overrides
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) = { ... }
public SearchExamplesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public SearchExamplesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public SearchExamplesRequest.Builder clearParameters()
clearStoredContentsExampleParameters()
public SearchExamplesRequest.Builder clearStoredContentsExampleParameters()
The parameters of StoredContentsExamples to be searched.
.google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;
public SearchExamplesRequest.Builder clearTopK()
Optional. The number of similar examples to return.
int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
public SearchExamplesRequest.Builder clone()
Overrides
public SearchExamplesRequest getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
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.
|
public SearchExamplesRequest.ParametersCase getParametersCase()
getStoredContentsExampleParameters()
public StoredContentsExampleParameters getStoredContentsExampleParameters()
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;
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.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchExamplesRequest.Builder mergeFrom(SearchExamplesRequest other)
public SearchExamplesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public SearchExamplesRequest.Builder mergeFrom(Message other)
Parameter |
Name |
Description |
other |
Message
|
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;
public final SearchExamplesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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.
|
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.
|
public SearchExamplesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchExamplesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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;
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;
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.
|
public final SearchExamplesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides