Package com.google.cloud.aiplatform.v1

Class EmbedContentRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.Builder>
com.google.cloud.aiplatform.v1.EmbedContentRequest.Builder
All Implemented Interfaces:
EmbedContentRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
EmbedContentRequest
public static final class EmbedContentRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.Builder> implements EmbedContentRequestOrBuilder
 Request message for
 [PredictionService.EmbedContent][google.cloud.aiplatform.v1.PredictionService.EmbedContent].
Protobuf type google.cloud.aiplatform.v1.EmbedContentRequest

  • 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.Builder<EmbedContentRequest.Builder>

    • clear

      public EmbedContentRequest.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<EmbedContentRequest.Builder>

    • getDefaultInstanceForType

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

    • build

      public EmbedContentRequest build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public EmbedContentRequest buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public EmbedContentRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EmbedContentRequest.Builder>

    • mergeFrom

      public EmbedContentRequest.Builder mergeFrom(EmbedContentRequest other)

    • isInitialized

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

    • mergeFrom

      public EmbedContentRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<EmbedContentRequest.Builder>
      Throws:
      IOException

    • hasModel

      public boolean hasModel()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      hasModel in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the model field is set.

    • getModel

      public String getModel()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      getModel in interface EmbedContentRequestOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Specified by:
      getModelBytes in interface EmbedContentRequestOrBuilder
      Returns:
      The bytes for model.

    • setModel

      public EmbedContentRequest.Builder setModel(String value)
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The model to set.
      Returns:
      This builder for chaining.

    • clearModel

      public EmbedContentRequest.Builder clearModel()
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setModelBytes

      public EmbedContentRequest.Builder setModelBytes(com.google.protobuf.ByteString value)
       Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
      optional string model = 1 [(.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for model to set.
      Returns:
      This builder for chaining.

    • hasContent

      public boolean hasContent()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      hasContent in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the content field is set.

    • getContent

      public Content getContent()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      getContent in interface EmbedContentRequestOrBuilder
      Returns:
      The content.

    • setContent

      public EmbedContentRequest.Builder setContent(Content value)
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;

    • setContent

      public EmbedContentRequest.Builder setContent(Content.Builder builderForValue)
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;

    • mergeContent

      public EmbedContentRequest.Builder mergeContent(Content value)
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;

    • clearContent

      public EmbedContentRequest.Builder clearContent()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;

    • getContentBuilder

      public Content.Builder getContentBuilder()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;

    • getContentOrBuilder

      public ContentOrBuilder getContentOrBuilder()
       Required. Input content to be embedded.
      optional .google.cloud.aiplatform.v1.Content content = 2;
      Specified by:
      getContentOrBuilder in interface EmbedContentRequestOrBuilder

    • hasTitle

      @Deprecated public boolean hasTitle()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTitle in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the title field is set.

    • getTitle

      @Deprecated public String getTitle()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitle in interface EmbedContentRequestOrBuilder
      Returns:
      The title.

    • getTitleBytes

      @Deprecated public com.google.protobuf.ByteString getTitleBytes()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTitleBytes in interface EmbedContentRequestOrBuilder
      Returns:
      The bytes for title.

    • setTitle

      @Deprecated public EmbedContentRequest.Builder setTitle(String value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The title to set.
      Returns:
      This builder for chaining.

    • clearTitle

      @Deprecated public EmbedContentRequest.Builder clearTitle()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • setTitleBytes

      @Deprecated public EmbedContentRequest.Builder setTitleBytes(com.google.protobuf.ByteString value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.title is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=968
       Optional. Deprecated: Please use EmbedContentConfig.title instead.
 The title for the text.
      optional string title = 4 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The bytes for title to set.
      Returns:
      This builder for chaining.

    • hasTaskType

      @Deprecated public boolean hasTaskType()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasTaskType in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the taskType field is set.

    • getTaskTypeValue

      @Deprecated public int getTaskTypeValue()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskTypeValue in interface EmbedContentRequestOrBuilder
      Returns:
      The enum numeric value on the wire for taskType.

    • setTaskTypeValue

      @Deprecated public EmbedContentRequest.Builder setTaskTypeValue(int value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The enum numeric value on the wire for taskType to set.
      Returns:
      This builder for chaining.

    • getTaskType

      @Deprecated public EmbedContentRequest.EmbeddingTaskType getTaskType()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTaskType in interface EmbedContentRequestOrBuilder
      Returns:
      The taskType.

    • setTaskType

      @Deprecated public EmbedContentRequest.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The taskType to set.
      Returns:
      This builder for chaining.

    • clearTaskType

      @Deprecated public EmbedContentRequest.Builder clearTaskType()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.task_type is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=973
       Optional. Deprecated: Please use EmbedContentConfig.task_type instead.
 The task type of the embedding.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasOutputDimensionality

      @Deprecated public boolean hasOutputDimensionality()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasOutputDimensionality in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the outputDimensionality field is set.

    • getOutputDimensionality

      @Deprecated public int getOutputDimensionality()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getOutputDimensionality in interface EmbedContentRequestOrBuilder
      Returns:
      The outputDimensionality.

    • setOutputDimensionality

      @Deprecated public EmbedContentRequest.Builder setOutputDimensionality(int value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The outputDimensionality to set.
      Returns:
      This builder for chaining.

    • clearOutputDimensionality

      @Deprecated public EmbedContentRequest.Builder clearOutputDimensionality()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.output_dimensionality is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=979
       Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality
 instead. Reduced dimension for the output embedding. If set, excessive
 values in the output embedding are truncated from the end.
      optional int32 output_dimensionality = 6 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasAutoTruncate

      @Deprecated public boolean hasAutoTruncate()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAutoTruncate in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the autoTruncate field is set.

    • getAutoTruncate

      @Deprecated public boolean getAutoTruncate()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAutoTruncate in interface EmbedContentRequestOrBuilder
      Returns:
      The autoTruncate.

    • setAutoTruncate

      @Deprecated public EmbedContentRequest.Builder setAutoTruncate(boolean value)
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The autoTruncate to set.
      Returns:
      This builder for chaining.

    • clearAutoTruncate

      @Deprecated public EmbedContentRequest.Builder clearAutoTruncate()
      Deprecated.
      google.cloud.aiplatform.v1.EmbedContentRequest.auto_truncate is deprecated. See google/cloud/aiplatform/v1/prediction_service.proto;l=985
       Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.
 Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
      optional bool auto_truncate = 7 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasEmbedContentConfig

      public boolean hasEmbedContentConfig()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasEmbedContentConfig in interface EmbedContentRequestOrBuilder
      Returns:
      Whether the embedContentConfig field is set.

    • getEmbedContentConfig

      public EmbedContentRequest.EmbedContentConfig getEmbedContentConfig()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbedContentConfig in interface EmbedContentRequestOrBuilder
      Returns:
      The embedContentConfig.

    • setEmbedContentConfig

      public EmbedContentRequest.Builder setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • setEmbedContentConfig

      public EmbedContentRequest.Builder setEmbedContentConfig(EmbedContentRequest.EmbedContentConfig.Builder builderForValue)
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • mergeEmbedContentConfig

      public EmbedContentRequest.Builder mergeEmbedContentConfig(EmbedContentRequest.EmbedContentConfig value)
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • clearEmbedContentConfig

      public EmbedContentRequest.Builder clearEmbedContentConfig()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getEmbedContentConfigBuilder

      public EmbedContentRequest.EmbedContentConfig.Builder getEmbedContentConfigBuilder()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];

    • getEmbedContentConfigOrBuilder

      public EmbedContentRequest.EmbedContentConfigOrBuilder getEmbedContentConfigOrBuilder()
       Optional. Configuration for the EmbedContent request.
      optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbedContentConfig embed_content_config = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getEmbedContentConfigOrBuilder in interface EmbedContentRequestOrBuilder