Class ReservationAffinity.Builder (3.52.0)

public static final class ReservationAffinity.Builder extends GeneratedMessageV3.Builder<ReservationAffinity.Builder> implements ReservationAffinityOrBuilder

A ReservationAffinity can be used to configure a Vertex AI resource (e.g., a DeployedModel) to draw its Compute Engine resources from a Shared Reservation, or exclusively from on-demand capacity.

Protobuf type google.cloud.aiplatform.v1.ReservationAffinity

Static Methods

getDescriptor()

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

Methods

addAllValues(Iterable<String> values)

public ReservationAffinity.Builder addAllValues(Iterable<String> values)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
values Iterable<String>

The values to add.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addValues(String value)

public ReservationAffinity.Builder addValues(String value)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The values to add.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

addValuesBytes(ByteString value)

public ReservationAffinity.Builder addValuesBytes(ByteString value)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes of the values to add.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

build()

public ReservationAffinity build()
Returns
Type Description
ReservationAffinity

buildPartial()

public ReservationAffinity buildPartial()
Returns
Type Description
ReservationAffinity

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearKey()

public ReservationAffinity.Builder clearKey()

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearReservationAffinityType()

public ReservationAffinity.Builder clearReservationAffinityType()

Required. Specifies the reservation affinity type.

.google.cloud.aiplatform.v1.ReservationAffinity.Type reservation_affinity_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

clearValues()

public ReservationAffinity.Builder clearValues()

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ReservationAffinity getDefaultInstanceForType()
Returns
Type Description
ReservationAffinity

getDescriptorForType()

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

getKey()

public String getKey()

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for key.

getReservationAffinityType()

public ReservationAffinity.Type getReservationAffinityType()

Required. Specifies the reservation affinity type.

.google.cloud.aiplatform.v1.ReservationAffinity.Type reservation_affinity_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ReservationAffinity.Type

The reservationAffinityType.

getReservationAffinityTypeValue()

public int getReservationAffinityTypeValue()

Required. Specifies the reservation affinity type.

.google.cloud.aiplatform.v1.ReservationAffinity.Type reservation_affinity_type = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for reservationAffinityType.

getValues(int index)

public String getValues(int index)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The values at the given index.

getValuesBytes(int index)

public ByteString getValuesBytes(int index)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the values at the given index.

getValuesCount()

public int getValuesCount()

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of values.

getValuesList()

public ProtocolStringList getValuesList()

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the values.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ReservationAffinity other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setKey(String value)

public ReservationAffinity.Builder setKey(String value)

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The key to set.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

setKeyBytes(ByteString value)

public ReservationAffinity.Builder setKeyBytes(ByteString value)

Optional. Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, use compute.googleapis.com/reservation-name as the key and specify the name of your reservation as its value.

string key = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for key to set.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

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

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

setReservationAffinityType(ReservationAffinity.Type value)

public ReservationAffinity.Builder setReservationAffinityType(ReservationAffinity.Type value)

Required. Specifies the reservation affinity type.

.google.cloud.aiplatform.v1.ReservationAffinity.Type reservation_affinity_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ReservationAffinity.Type

The reservationAffinityType to set.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

setReservationAffinityTypeValue(int value)

public ReservationAffinity.Builder setReservationAffinityTypeValue(int value)

Required. Specifies the reservation affinity type.

.google.cloud.aiplatform.v1.ReservationAffinity.Type reservation_affinity_type = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for reservationAffinityType to set.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setValues(int index, String value)

public ReservationAffinity.Builder setValues(int index, String value)

Optional. Corresponds to the label values of a reservation resource. This must be the full resource name of the reservation.

repeated string values = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameters
Name Description
index int

The index to set the value at.

value String

The values to set.

Returns
Type Description
ReservationAffinity.Builder

This builder for chaining.