Class SearchExamplesRequest (3.64.0)

public final class SearchExamplesRequest extends GeneratedMessageV3 implements SearchExamplesRequestOrBuilder

Request message for ExampleStoreService.SearchExamples.

Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesRequest

Static Fields

EXAMPLE_STORE_FIELD_NUMBER

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

TOP_K_FIELD_NUMBER

public static final int TOP_K_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchExamplesRequest getDefaultInstance()
Returns
Type Description
SearchExamplesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchExamplesRequest.Builder newBuilder()
Returns
Type Description
SearchExamplesRequest.Builder

newBuilder(SearchExamplesRequest prototype)

public static SearchExamplesRequest.Builder newBuilder(SearchExamplesRequest prototype)
Parameter
Name Description
prototype SearchExamplesRequest
Returns
Type Description
SearchExamplesRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchExamplesRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchExamplesRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchExamplesRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchExamplesRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchExamplesRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchExamplesRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchExamplesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchExamplesRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchExamplesRequest> parser()
Returns
Type Description
Parser<SearchExamplesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchExamplesRequest getDefaultInstanceForType()
Returns
Type Description
SearchExamplesRequest

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

getParserForType()

public Parser<SearchExamplesRequest> getParserForType()
Returns
Type Description
Parser<SearchExamplesRequest>
Overrides

getSerializedSize()

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;

Returns
Type Description
StoredContentsExampleParameters

The storedContentsExampleParameters.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchExamplesRequest.Builder newBuilderForType()
Returns
Type Description
SearchExamplesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchExamplesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchExamplesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public SearchExamplesRequest.Builder toBuilder()
Returns
Type Description
SearchExamplesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException