Class ReservationAffinity (3.56.0)

public final class ReservationAffinity extends GeneratedMessageV3 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 Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

RESERVATION_AFFINITY_TYPE_FIELD_NUMBER

public static final int RESERVATION_AFFINITY_TYPE_FIELD_NUMBER
Field Value
Type Description
int

VALUES_FIELD_NUMBER

public static final int VALUES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ReservationAffinity getDefaultInstance()
Returns
Type Description
ReservationAffinity

getDescriptor()

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

newBuilder()

public static ReservationAffinity.Builder newBuilder()
Returns
Type Description
ReservationAffinity.Builder

newBuilder(ReservationAffinity prototype)

public static ReservationAffinity.Builder newBuilder(ReservationAffinity prototype)
Parameter
Name Description
prototype ReservationAffinity
Returns
Type Description
ReservationAffinity.Builder

parseDelimitedFrom(InputStream input)

public static ReservationAffinity parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ReservationAffinity parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ReservationAffinity parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ReservationAffinity parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ReservationAffinity parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ReservationAffinity parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ReservationAffinity parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ReservationAffinity
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ReservationAffinity> parser()
Returns
Type Description
Parser<ReservationAffinity>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ReservationAffinity getDefaultInstanceForType()
Returns
Type Description
ReservationAffinity

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.

getParserForType()

public Parser<ReservationAffinity> getParserForType()
Returns
Type Description
Parser<ReservationAffinity>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ReservationAffinity.Builder newBuilderForType()
Returns
Type Description
ReservationAffinity.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ReservationAffinity.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ReservationAffinity.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ReservationAffinity.Builder toBuilder()
Returns
Type Description
ReservationAffinity.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException