Class AugmentPromptRequest.Builder (3.56.0)

public static final class AugmentPromptRequest.Builder extends GeneratedMessageV3.Builder<AugmentPromptRequest.Builder> implements AugmentPromptRequestOrBuilder

Request message for AugmentPrompt.

Protobuf type google.cloud.aiplatform.v1.AugmentPromptRequest

Static Methods

getDescriptor()

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

Methods

addAllContents(Iterable<? extends Content> values)

public AugmentPromptRequest.Builder addAllContents(Iterable<? extends Content> values)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<? extends com.google.cloud.aiplatform.v1.Content>
Returns
Type Description
AugmentPromptRequest.Builder

addContents(Content value)

public AugmentPromptRequest.Builder addContents(Content value)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Content
Returns
Type Description
AugmentPromptRequest.Builder

addContents(Content.Builder builderForValue)

public AugmentPromptRequest.Builder addContents(Content.Builder builderForValue)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Content.Builder
Returns
Type Description
AugmentPromptRequest.Builder

addContents(int index, Content value)

public AugmentPromptRequest.Builder addContents(int index, Content value)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Content
Returns
Type Description
AugmentPromptRequest.Builder

addContents(int index, Content.Builder builderForValue)

public AugmentPromptRequest.Builder addContents(int index, Content.Builder builderForValue)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Content.Builder
Returns
Type Description
AugmentPromptRequest.Builder

addContentsBuilder()

public Content.Builder addContentsBuilder()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Content.Builder

addContentsBuilder(int index)

public Content.Builder addContentsBuilder(int index)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Content.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AugmentPromptRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

build()

public AugmentPromptRequest build()
Returns
Type Description
AugmentPromptRequest

buildPartial()

public AugmentPromptRequest buildPartial()
Returns
Type Description
AugmentPromptRequest

clear()

public AugmentPromptRequest.Builder clear()
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

clearContents()

public AugmentPromptRequest.Builder clearContents()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.Builder

clearDataSource()

public AugmentPromptRequest.Builder clearDataSource()
Returns
Type Description
AugmentPromptRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public AugmentPromptRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

clearModel()

public AugmentPromptRequest.Builder clearModel()

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AugmentPromptRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

clearParent()

public AugmentPromptRequest.Builder clearParent()

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
AugmentPromptRequest.Builder

This builder for chaining.

clearVertexRagStore()

public AugmentPromptRequest.Builder clearVertexRagStore()

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.Builder

clone()

public AugmentPromptRequest.Builder clone()
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

getContents(int index)

public Content getContents(int index)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Content

getContentsBuilder(int index)

public Content.Builder getContentsBuilder(int index)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
Content.Builder

getContentsBuilderList()

public List<Content.Builder> getContentsBuilderList()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Builder>

getContentsCount()

public int getContentsCount()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getContentsList()

public List<Content> getContentsList()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<Content>

getContentsOrBuilder(int index)

public ContentOrBuilder getContentsOrBuilder(int index)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ContentOrBuilder

getContentsOrBuilderList()

public List<? extends ContentOrBuilder> getContentsOrBuilderList()

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.aiplatform.v1.ContentOrBuilder>

getDataSourceCase()

public AugmentPromptRequest.DataSourceCase getDataSourceCase()
Returns
Type Description
AugmentPromptRequest.DataSourceCase

getDefaultInstanceForType()

public AugmentPromptRequest getDefaultInstanceForType()
Returns
Type Description
AugmentPromptRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getModel()

public AugmentPromptRequest.Model getModel()

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.Model

The model.

getModelBuilder()

public AugmentPromptRequest.Model.Builder getModelBuilder()

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.Model.Builder

getModelOrBuilder()

public AugmentPromptRequest.ModelOrBuilder getModelOrBuilder()

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AugmentPromptRequest.ModelOrBuilder

getParent()

public String getParent()

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getVertexRagStore()

public VertexRagStore getVertexRagStore()

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRagStore

The vertexRagStore.

getVertexRagStoreBuilder()

public VertexRagStore.Builder getVertexRagStoreBuilder()

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRagStore.Builder

getVertexRagStoreOrBuilder()

public VertexRagStoreOrBuilder getVertexRagStoreOrBuilder()

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VertexRagStoreOrBuilder

hasModel()

public boolean hasModel()

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the model field is set.

hasVertexRagStore()

public boolean hasVertexRagStore()

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the vertexRagStore field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AugmentPromptRequest other)

public AugmentPromptRequest.Builder mergeFrom(AugmentPromptRequest other)
Parameter
Name Description
other AugmentPromptRequest
Returns
Type Description
AugmentPromptRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AugmentPromptRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AugmentPromptRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AugmentPromptRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

mergeModel(AugmentPromptRequest.Model value)

public AugmentPromptRequest.Builder mergeModel(AugmentPromptRequest.Model value)

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AugmentPromptRequest.Model
Returns
Type Description
AugmentPromptRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AugmentPromptRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

mergeVertexRagStore(VertexRagStore value)

public AugmentPromptRequest.Builder mergeVertexRagStore(VertexRagStore value)

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VertexRagStore
Returns
Type Description
AugmentPromptRequest.Builder

removeContents(int index)

public AugmentPromptRequest.Builder removeContents(int index)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
AugmentPromptRequest.Builder

setContents(int index, Content value)

public AugmentPromptRequest.Builder setContents(int index, Content value)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
value Content
Returns
Type Description
AugmentPromptRequest.Builder

setContents(int index, Content.Builder builderForValue)

public AugmentPromptRequest.Builder setContents(int index, Content.Builder builderForValue)

Optional. Input content to augment, only text format is supported for now.

repeated .google.cloud.aiplatform.v1.Content contents = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
index int
builderForValue Content.Builder
Returns
Type Description
AugmentPromptRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public AugmentPromptRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

setModel(AugmentPromptRequest.Model value)

public AugmentPromptRequest.Builder setModel(AugmentPromptRequest.Model value)

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value AugmentPromptRequest.Model
Returns
Type Description
AugmentPromptRequest.Builder

setModel(AugmentPromptRequest.Model.Builder builderForValue)

public AugmentPromptRequest.Builder setModel(AugmentPromptRequest.Model.Builder builderForValue)

Optional. Metadata of the backend deployed model.

.google.cloud.aiplatform.v1.AugmentPromptRequest.Model model = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue AugmentPromptRequest.Model.Builder
Returns
Type Description
AugmentPromptRequest.Builder

setParent(String value)

public AugmentPromptRequest.Builder setParent(String value)

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
AugmentPromptRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public AugmentPromptRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the Location from which to augment prompt. The users must have permission to make a call in the project. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
AugmentPromptRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AugmentPromptRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AugmentPromptRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AugmentPromptRequest.Builder
Overrides

setVertexRagStore(VertexRagStore value)

public AugmentPromptRequest.Builder setVertexRagStore(VertexRagStore value)

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value VertexRagStore
Returns
Type Description
AugmentPromptRequest.Builder

setVertexRagStore(VertexRagStore.Builder builderForValue)

public AugmentPromptRequest.Builder setVertexRagStore(VertexRagStore.Builder builderForValue)

Optional. Retrieves contexts from the Vertex RagStore.

.google.cloud.aiplatform.v1.VertexRagStore vertex_rag_store = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue VertexRagStore.Builder
Returns
Type Description
AugmentPromptRequest.Builder