EmbedContentRequest.Builder (proto-google-cloud-aiplatform-v1 3.86.0 API)

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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EmbedContentRequest`	`build()`
`EmbedContentRequest`	`buildPartial()`
`EmbedContentRequest.Builder`	`clear()`
`EmbedContentRequest.Builder`	`clearAutoTruncate()` Optional.
`EmbedContentRequest.Builder`	`clearContent()` Required.
`EmbedContentRequest.Builder`	`clearModel()` Required.
`EmbedContentRequest.Builder`	`clearOutputDimensionality()` Optional.
`EmbedContentRequest.Builder`	`clearTaskType()` Optional.
`EmbedContentRequest.Builder`	`clearTitle()` Optional.
`boolean`	`getAutoTruncate()` Optional.
`Content`	`getContent()` Required.
`Content.Builder`	`getContentBuilder()` Required.
`ContentOrBuilder`	`getContentOrBuilder()` Required.
`EmbedContentRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getModel()` Required.
`com.google.protobuf.ByteString`	`getModelBytes()` Required.
`int`	`getOutputDimensionality()` Optional.
`EmbedContentRequest.EmbeddingTaskType`	`getTaskType()` Optional.
`int`	`getTaskTypeValue()` Optional.
`String`	`getTitle()` Optional.
`com.google.protobuf.ByteString`	`getTitleBytes()` Optional.
`boolean`	`hasAutoTruncate()` Optional.
`boolean`	`hasContent()` Required.
`boolean`	`hasModel()` Required.
`boolean`	`hasOutputDimensionality()` Optional.
`boolean`	`hasTaskType()` Optional.
`boolean`	`hasTitle()` Optional.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`EmbedContentRequest.Builder`	`mergeContent(Content value)` Required.
`EmbedContentRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`EmbedContentRequest.Builder`	`mergeFrom(EmbedContentRequest other)`
`EmbedContentRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`EmbedContentRequest.Builder`	`setAutoTruncate(boolean value)` Optional.
`EmbedContentRequest.Builder`	`setContent(Content.Builder builderForValue)` Required.
`EmbedContentRequest.Builder`	`setContent(Content value)` Required.
`EmbedContentRequest.Builder`	`setModel(String value)` Required.
`EmbedContentRequest.Builder`	`setModelBytes(com.google.protobuf.ByteString value)` Required.
`EmbedContentRequest.Builder`	`setOutputDimensionality(int value)` Optional.
`EmbedContentRequest.Builder`	`setTaskType(EmbedContentRequest.EmbeddingTaskType value)` Optional.
`EmbedContentRequest.Builder`	`setTaskTypeValue(int value)` Optional.
`EmbedContentRequest.Builder`	`setTitle(String value)` Optional.
`EmbedContentRequest.Builder`	`setTitleBytes(com.google.protobuf.ByteString value)` Optional.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - 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. Required.
 
```
    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. Required.
 
```
    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. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
  - setContent
```
public EmbedContentRequest.Builder setContent(Content.Builder builderForValue)
```
```
 Required. Input content to be embedded. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
  - mergeContent
```
public EmbedContentRequest.Builder mergeContent(Content value)
```
```
 Required. Input content to be embedded. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
  - clearContent
```
public EmbedContentRequest.Builder clearContent()
```
```
 Required. Input content to be embedded. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
  - getContentBuilder
```
public Content.Builder getContentBuilder()
```
```
 Required. Input content to be embedded. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
  - getContentOrBuilder
```
public ContentOrBuilder getContentOrBuilder()
```
```
 Required. Input content to be embedded. Required.
 
```
    optional .google.cloud.aiplatform.v1.Content content = 2;
    Specified by:
    
    getContentOrBuilder in interface EmbedContentRequestOrBuilder
  - hasTitle
```
public boolean hasTitle()
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasTitle in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    Whether the title field is set.
  - getTitle
```
public String getTitle()
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getTitle in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The title.
  - getTitleBytes
```
public com.google.protobuf.ByteString getTitleBytes()
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getTitleBytes in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The bytes for title.
  - setTitle
```
public EmbedContentRequest.Builder setTitle(String value)
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The title to set.
    
    Returns:
    
    This builder for chaining.
  - clearTitle
```
public EmbedContentRequest.Builder clearTitle()
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - setTitleBytes
```
public EmbedContentRequest.Builder setTitleBytes(com.google.protobuf.ByteString value)
```
```
 Optional. An optional title for the text.
 
```
    optional string title = 4 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The bytes for title to set.
    
    Returns:
    
    This builder for chaining.
  - hasTaskType
```
public boolean hasTaskType()
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasTaskType in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    Whether the taskType field is set.
  - getTaskTypeValue
```
public int getTaskTypeValue()
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getTaskTypeValue in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for taskType.
  - setTaskTypeValue
```
public EmbedContentRequest.Builder setTaskTypeValue(int value)
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The enum numeric value on the wire for taskType to set.
    
    Returns:
    
    This builder for chaining.
  - getTaskType
```
public EmbedContentRequest.EmbeddingTaskType getTaskType()
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getTaskType in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The taskType.
  - setTaskType
```
public EmbedContentRequest.Builder setTaskType(EmbedContentRequest.EmbeddingTaskType value)
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The taskType to set.
    
    Returns:
    
    This builder for chaining.
  - clearTaskType
```
public EmbedContentRequest.Builder clearTaskType()
```
```
 Optional. The task type of the embedding.
 
```
    optional .google.cloud.aiplatform.v1.EmbedContentRequest.EmbeddingTaskType task_type = 5 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - hasOutputDimensionality
```
public boolean hasOutputDimensionality()
```
```
 Optional. Optional reduced dimension for the output embedding. If set,
 excessive values in the output embedding are truncated from the end.
 
```
    optional int32 output_dimensionality = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasOutputDimensionality in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    Whether the outputDimensionality field is set.
  - getOutputDimensionality
```
public int getOutputDimensionality()
```
```
 Optional. Optional reduced dimension for the output embedding. If set,
 excessive values in the output embedding are truncated from the end.
 
```
    optional int32 output_dimensionality = 6 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getOutputDimensionality in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The outputDimensionality.
  - setOutputDimensionality
```
public EmbedContentRequest.Builder setOutputDimensionality(int value)
```
```
 Optional. Optional reduced dimension for the output embedding. If set,
 excessive values in the output embedding are truncated from the end.
 
```
    optional int32 output_dimensionality = 6 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The outputDimensionality to set.
    
    Returns:
    
    This builder for chaining.
  - clearOutputDimensionality
```
public EmbedContentRequest.Builder clearOutputDimensionality()
```
```
 Optional. Optional reduced dimension for the output embedding. If set,
 excessive values in the output embedding are truncated from the end.
 
```
    optional int32 output_dimensionality = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.
  - hasAutoTruncate
```
public boolean hasAutoTruncate()
```
```
 Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
 
```
    optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    hasAutoTruncate in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    Whether the autoTruncate field is set.
  - getAutoTruncate
```
public boolean getAutoTruncate()
```
```
 Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
 
```
    optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
    Specified by:
    
    getAutoTruncate in interface EmbedContentRequestOrBuilder
    
    Returns:
    
    The autoTruncate.
  - setAutoTruncate
```
public EmbedContentRequest.Builder setAutoTruncate(boolean value)
```
```
 Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
 
```
    optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    value - The autoTruncate to set.
    
    Returns:
    
    This builder for chaining.
  - clearAutoTruncate
```
public EmbedContentRequest.Builder clearAutoTruncate()
```
```
 Optional. Whether to silently truncate the input content if it's longer
 than the maximum sequence length.
 
```
    optional bool auto_truncate = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    This builder for chaining.

Class EmbedContentRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

mergeFrom

mergeFrom

isInitialized

mergeFrom

hasModel

getModel

getModelBytes

setModel

clearModel

setModelBytes

hasContent

getContent

setContent

setContent

mergeContent

clearContent

getContentBuilder

getContentOrBuilder

hasTitle

getTitle

getTitleBytes

setTitle

clearTitle

setTitleBytes

hasTaskType

getTaskTypeValue

setTaskTypeValue

getTaskType

setTaskType

clearTaskType

hasOutputDimensionality

getOutputDimensionality

setOutputDimensionality

clearOutputDimensionality

hasAutoTruncate

getAutoTruncate

setAutoTruncate

clearAutoTruncate