Package com.google.cloud.aiplatform.v1beta1

Class SearchExamplesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.SearchExamplesRequest
All Implemented Interfaces:
SearchExamplesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchExamplesRequest extends com.google.protobuf.GeneratedMessage implements SearchExamplesRequestOrBuilder
 Request message for
 [ExampleStoreService.SearchExamples][google.cloud.aiplatform.v1beta1.ExampleStoreService.SearchExamples].
Protobuf type google.cloud.aiplatform.v1beta1.SearchExamplesRequest
See Also:

  • Field Details

    • STORED_CONTENTS_EXAMPLE_PARAMETERS_FIELD_NUMBER

      public static final int STORED_CONTENTS_EXAMPLE_PARAMETERS_FIELD_NUMBER
      See Also:

    • EXAMPLE_STORE_FIELD_NUMBER

      public static final int EXAMPLE_STORE_FIELD_NUMBER
      See Also:

    • TOP_K_FIELD_NUMBER

      public static final int TOP_K_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getParametersCase

      public SearchExamplesRequest.ParametersCase getParametersCase()
      Specified by:
      getParametersCase in interface SearchExamplesRequestOrBuilder

    • hasStoredContentsExampleParameters

      public boolean hasStoredContentsExampleParameters()
       The parameters of StoredContentsExamples to be searched.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;
      Specified by:
      hasStoredContentsExampleParameters in interface SearchExamplesRequestOrBuilder
      Returns:
      Whether the storedContentsExampleParameters field is set.

    • getStoredContentsExampleParameters

      public StoredContentsExampleParameters getStoredContentsExampleParameters()
       The parameters of StoredContentsExamples to be searched.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;
      Specified by:
      getStoredContentsExampleParameters in interface SearchExamplesRequestOrBuilder
      Returns:
      The storedContentsExampleParameters.

    • getStoredContentsExampleParametersOrBuilder

      public StoredContentsExampleParametersOrBuilder getStoredContentsExampleParametersOrBuilder()
       The parameters of StoredContentsExamples to be searched.
      .google.cloud.aiplatform.v1beta1.StoredContentsExampleParameters stored_contents_example_parameters = 6;
      Specified by:
      getStoredContentsExampleParametersOrBuilder in interface SearchExamplesRequestOrBuilder

    • 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) = { ... }
      Specified by:
      getExampleStore in interface SearchExamplesRequestOrBuilder
      Returns:
      The exampleStore.

    • getExampleStoreBytes

      public com.google.protobuf.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) = { ... }
      Specified by:
      getExampleStoreBytes in interface SearchExamplesRequestOrBuilder
      Returns:
      The bytes for exampleStore.

    • getTopK

      public long getTopK()
       Optional. The number of similar examples to return.
      int64 top_k = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTopK in interface SearchExamplesRequestOrBuilder
      Returns:
      The topK.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchExamplesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchExamplesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchExamplesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchExamplesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchExamplesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchExamplesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchExamplesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchExamplesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchExamplesRequest.Builder newBuilder()

    • newBuilder

      public static SearchExamplesRequest.Builder newBuilder(SearchExamplesRequest prototype)

    • toBuilder

      public SearchExamplesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchExamplesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchExamplesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchExamplesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchExamplesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchExamplesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder