Class SearchExamplesRequest (3.77.0)
public final class SearchExamplesRequest extends GeneratedMessageV3 implements SearchExamplesRequestOrBuilder
Request message for
ExampleStoreService.SearchExamples.
Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int EXAMPLE_STORE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STORED_CONTENTS_EXAMPLE_PARAMETERS_FIELD_NUMBER
public static final int STORED_CONTENTS_EXAMPLE_PARAMETERS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOP_K_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static SearchExamplesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static SearchExamplesRequest.Builder newBuilder()
public static SearchExamplesRequest.Builder newBuilder(SearchExamplesRequest prototype)
public static SearchExamplesRequest parseDelimitedFrom(InputStream input)
public static SearchExamplesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchExamplesRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static SearchExamplesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchExamplesRequest parseFrom(ByteString data)
public static SearchExamplesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchExamplesRequest parseFrom(CodedInputStream input)
public static SearchExamplesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchExamplesRequest parseFrom(InputStream input)
public static SearchExamplesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchExamplesRequest parseFrom(ByteBuffer data)
public static SearchExamplesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<SearchExamplesRequest> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public SearchExamplesRequest getDefaultInstanceForType()
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()
public Parser<SearchExamplesRequest> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getStoredContentsExampleParameters()
public StoredContentsExampleParameters getStoredContentsExampleParameters()
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.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchExamplesRequest.Builder newBuilderForType()
protected SearchExamplesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public SearchExamplesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
