Class UpsertDatapointsRequest.Builder (3.43.0)

public static final class UpsertDatapointsRequest.Builder extends GeneratedMessageV3.Builder<UpsertDatapointsRequest.Builder> implements UpsertDatapointsRequestOrBuilder

Request message for IndexService.UpsertDatapoints

Protobuf type google.cloud.aiplatform.v1.UpsertDatapointsRequest

Static Methods

getDescriptor()

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

Methods

addAllDatapoints(Iterable<? extends IndexDatapoint> values)

public UpsertDatapointsRequest.Builder addAllDatapoints(Iterable<? extends IndexDatapoint> values)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

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

addDatapoints(IndexDatapoint value)

public UpsertDatapointsRequest.Builder addDatapoints(IndexDatapoint value)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
value IndexDatapoint
Returns
Type Description
UpsertDatapointsRequest.Builder

addDatapoints(IndexDatapoint.Builder builderForValue)

public UpsertDatapointsRequest.Builder addDatapoints(IndexDatapoint.Builder builderForValue)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
builderForValue IndexDatapoint.Builder
Returns
Type Description
UpsertDatapointsRequest.Builder

addDatapoints(int index, IndexDatapoint value)

public UpsertDatapointsRequest.Builder addDatapoints(int index, IndexDatapoint value)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameters
Name Description
index int
value IndexDatapoint
Returns
Type Description
UpsertDatapointsRequest.Builder

addDatapoints(int index, IndexDatapoint.Builder builderForValue)

public UpsertDatapointsRequest.Builder addDatapoints(int index, IndexDatapoint.Builder builderForValue)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameters
Name Description
index int
builderForValue IndexDatapoint.Builder
Returns
Type Description
UpsertDatapointsRequest.Builder

addDatapointsBuilder()

public IndexDatapoint.Builder addDatapointsBuilder()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Returns
Type Description
IndexDatapoint.Builder

addDatapointsBuilder(int index)

public IndexDatapoint.Builder addDatapointsBuilder(int index)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public UpsertDatapointsRequest build()
Returns
Type Description
UpsertDatapointsRequest

buildPartial()

public UpsertDatapointsRequest buildPartial()
Returns
Type Description
UpsertDatapointsRequest

clear()

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

clearDatapoints()

public UpsertDatapointsRequest.Builder clearDatapoints()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Returns
Type Description
UpsertDatapointsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearIndex()

public UpsertDatapointsRequest.Builder clearIndex()

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

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

Returns
Type Description
UpsertDatapointsRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearUpdateMask()

public UpsertDatapointsRequest.Builder clearUpdateMask()

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
UpsertDatapointsRequest.Builder

clone()

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

getDatapoints(int index)

public IndexDatapoint getDatapoints(int index)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint

getDatapointsBuilder(int index)

public IndexDatapoint.Builder getDatapointsBuilder(int index)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
index int
Returns
Type Description
IndexDatapoint.Builder

getDatapointsBuilderList()

public List<IndexDatapoint.Builder> getDatapointsBuilderList()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Returns
Type Description
List<Builder>

getDatapointsCount()

public int getDatapointsCount()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Returns
Type Description
int

getDatapointsList()

public List<IndexDatapoint> getDatapointsList()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Returns
Type Description
List<IndexDatapoint>

getDatapointsOrBuilder(int index)

public IndexDatapointOrBuilder getDatapointsOrBuilder(int index)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
index int
Returns
Type Description
IndexDatapointOrBuilder

getDatapointsOrBuilderList()

public List<? extends IndexDatapointOrBuilder> getDatapointsOrBuilderList()

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

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

getDefaultInstanceForType()

public UpsertDatapointsRequest getDefaultInstanceForType()
Returns
Type Description
UpsertDatapointsRequest

getDescriptorForType()

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

getIndex()

public String getIndex()

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

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

Returns
Type Description
String

The index.

getIndexBytes()

public ByteString getIndexBytes()

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

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

Returns
Type Description
ByteString

The bytes for index.

getUpdateMask()

public FieldMask getUpdateMask()

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FieldMaskOrBuilder

hasUpdateMask()

public boolean hasUpdateMask()

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpsertDatapointsRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateMask(FieldMask value)

public UpsertDatapointsRequest.Builder mergeUpdateMask(FieldMask value)

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpsertDatapointsRequest.Builder

removeDatapoints(int index)

public UpsertDatapointsRequest.Builder removeDatapoints(int index)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameter
Name Description
index int
Returns
Type Description
UpsertDatapointsRequest.Builder

setDatapoints(int index, IndexDatapoint value)

public UpsertDatapointsRequest.Builder setDatapoints(int index, IndexDatapoint value)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameters
Name Description
index int
value IndexDatapoint
Returns
Type Description
UpsertDatapointsRequest.Builder

setDatapoints(int index, IndexDatapoint.Builder builderForValue)

public UpsertDatapointsRequest.Builder setDatapoints(int index, IndexDatapoint.Builder builderForValue)

A list of datapoints to be created/updated.

repeated .google.cloud.aiplatform.v1.IndexDatapoint datapoints = 2;

Parameters
Name Description
index int
builderForValue IndexDatapoint.Builder
Returns
Type Description
UpsertDatapointsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

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

setIndex(String value)

public UpsertDatapointsRequest.Builder setIndex(String value)

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

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

Parameter
Name Description
value String

The index to set.

Returns
Type Description
UpsertDatapointsRequest.Builder

This builder for chaining.

setIndexBytes(ByteString value)

public UpsertDatapointsRequest.Builder setIndexBytes(ByteString value)

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}

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

Parameter
Name Description
value ByteString

The bytes for index to set.

Returns
Type Description
UpsertDatapointsRequest.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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

setUpdateMask(FieldMask value)

public UpsertDatapointsRequest.Builder setUpdateMask(FieldMask value)

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpsertDatapointsRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpsertDatapointsRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

Optional. Update mask is used to specify the fields to be overwritten in the datapoints by the update. The fields specified in the update_mask are relative to each IndexDatapoint inside datapoints, not the full request.

Updatable fields:

  • Use all_restricts to update both restricts and numeric_restricts.

.google.protobuf.FieldMask update_mask = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpsertDatapointsRequest.Builder