Class Reservation

  • All Implemented Interfaces:
    ReservationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class Reservation
    extends com.google.protobuf.GeneratedMessageV3
    implements ReservationOrBuilder
     Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
     
    Protobuf type google.cloud.compute.v1.Reservation
    See Also:
    Serialized Form
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • hasCommitment

        public boolean hasCommitment()
         [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
         
        optional string commitment = 482134805;
        Specified by:
        hasCommitment in interface ReservationOrBuilder
        Returns:
        Whether the commitment field is set.
      • getCommitment

        public String getCommitment()
         [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
         
        optional string commitment = 482134805;
        Specified by:
        getCommitment in interface ReservationOrBuilder
        Returns:
        The commitment.
      • getCommitmentBytes

        public com.google.protobuf.ByteString getCommitmentBytes()
         [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
         
        optional string commitment = 482134805;
        Specified by:
        getCommitmentBytes in interface ReservationOrBuilder
        Returns:
        The bytes for commitment.
      • hasCreationTimestamp

        public boolean hasCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        hasCreationTimestamp in interface ReservationOrBuilder
        Returns:
        Whether the creationTimestamp field is set.
      • getCreationTimestamp

        public String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestamp in interface ReservationOrBuilder
        Returns:
        The creationTimestamp.
      • getCreationTimestampBytes

        public com.google.protobuf.ByteString getCreationTimestampBytes()
         [Output Only] Creation timestamp in RFC3339 text format.
         
        optional string creation_timestamp = 30525366;
        Specified by:
        getCreationTimestampBytes in interface ReservationOrBuilder
        Returns:
        The bytes for creationTimestamp.
      • hasDescription

        public boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        hasDescription in interface ReservationOrBuilder
        Returns:
        Whether the description field is set.
      • getDescription

        public String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescription in interface ReservationOrBuilder
        Returns:
        The description.
      • getDescriptionBytes

        public com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
         
        optional string description = 422937596;
        Specified by:
        getDescriptionBytes in interface ReservationOrBuilder
        Returns:
        The bytes for description.
      • hasId

        public boolean hasId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        hasId in interface ReservationOrBuilder
        Returns:
        Whether the id field is set.
      • getId

        public long getId()
         [Output Only] The unique identifier for the resource. This identifier is defined by the server.
         
        optional uint64 id = 3355;
        Specified by:
        getId in interface ReservationOrBuilder
        Returns:
        The id.
      • hasKind

        public boolean hasKind()
         [Output Only] Type of the resource. Always compute#reservations for reservations.
         
        optional string kind = 3292052;
        Specified by:
        hasKind in interface ReservationOrBuilder
        Returns:
        Whether the kind field is set.
      • getKind

        public String getKind()
         [Output Only] Type of the resource. Always compute#reservations for reservations.
         
        optional string kind = 3292052;
        Specified by:
        getKind in interface ReservationOrBuilder
        Returns:
        The kind.
      • getKindBytes

        public com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#reservations for reservations.
         
        optional string kind = 3292052;
        Specified by:
        getKindBytes in interface ReservationOrBuilder
        Returns:
        The bytes for kind.
      • hasName

        public boolean hasName()
         The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         
        optional string name = 3373707;
        Specified by:
        hasName in interface ReservationOrBuilder
        Returns:
        Whether the name field is set.
      • getName

        public String getName()
         The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         
        optional string name = 3373707;
        Specified by:
        getName in interface ReservationOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
         
        optional string name = 3373707;
        Specified by:
        getNameBytes in interface ReservationOrBuilder
        Returns:
        The bytes for name.
      • getResourcePoliciesCount

        public int getResourcePoliciesCount()
        Description copied from interface: ReservationOrBuilder
         Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
         
        map<string, string> resource_policies = 22220385;
        Specified by:
        getResourcePoliciesCount in interface ReservationOrBuilder
      • containsResourcePolicies

        public boolean containsResourcePolicies​(String key)
         Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
         
        map<string, string> resource_policies = 22220385;
        Specified by:
        containsResourcePolicies in interface ReservationOrBuilder
      • getResourcePoliciesMap

        public Map<String,​String> getResourcePoliciesMap()
         Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
         
        map<string, string> resource_policies = 22220385;
        Specified by:
        getResourcePoliciesMap in interface ReservationOrBuilder
      • getResourcePoliciesOrDefault

        public String getResourcePoliciesOrDefault​(String key,
                                                   String defaultValue)
         Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
         
        map<string, string> resource_policies = 22220385;
        Specified by:
        getResourcePoliciesOrDefault in interface ReservationOrBuilder
      • getResourcePoliciesOrThrow

        public String getResourcePoliciesOrThrow​(String key)
         Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
         
        map<string, string> resource_policies = 22220385;
        Specified by:
        getResourcePoliciesOrThrow in interface ReservationOrBuilder
      • hasResourceStatus

        public boolean hasResourceStatus()
         [Output Only] Status information for Reservation resource.
         
        optional .google.cloud.compute.v1.AllocationResourceStatus resource_status = 249429315;
        Specified by:
        hasResourceStatus in interface ReservationOrBuilder
        Returns:
        Whether the resourceStatus field is set.
      • getResourceStatus

        public AllocationResourceStatus getResourceStatus()
         [Output Only] Status information for Reservation resource.
         
        optional .google.cloud.compute.v1.AllocationResourceStatus resource_status = 249429315;
        Specified by:
        getResourceStatus in interface ReservationOrBuilder
        Returns:
        The resourceStatus.
      • hasSatisfiesPzs

        public boolean hasSatisfiesPzs()
         [Output Only] Reserved for future use.
         
        optional bool satisfies_pzs = 480964267;
        Specified by:
        hasSatisfiesPzs in interface ReservationOrBuilder
        Returns:
        Whether the satisfiesPzs field is set.
      • getSatisfiesPzs

        public boolean getSatisfiesPzs()
         [Output Only] Reserved for future use.
         
        optional bool satisfies_pzs = 480964267;
        Specified by:
        getSatisfiesPzs in interface ReservationOrBuilder
        Returns:
        The satisfiesPzs.
      • hasSelfLink

        public boolean hasSelfLink()
         [Output Only] Server-defined fully-qualified URL for this resource.
         
        optional string self_link = 456214797;
        Specified by:
        hasSelfLink in interface ReservationOrBuilder
        Returns:
        Whether the selfLink field is set.
      • getSelfLink

        public String getSelfLink()
         [Output Only] Server-defined fully-qualified URL for this resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLink in interface ReservationOrBuilder
        Returns:
        The selfLink.
      • getSelfLinkBytes

        public com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined fully-qualified URL for this resource.
         
        optional string self_link = 456214797;
        Specified by:
        getSelfLinkBytes in interface ReservationOrBuilder
        Returns:
        The bytes for selfLink.
      • hasShareSettings

        public boolean hasShareSettings()
         Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
         
        optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
        Specified by:
        hasShareSettings in interface ReservationOrBuilder
        Returns:
        Whether the shareSettings field is set.
      • getShareSettings

        public ShareSettings getShareSettings()
         Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
         
        optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
        Specified by:
        getShareSettings in interface ReservationOrBuilder
        Returns:
        The shareSettings.
      • getShareSettingsOrBuilder

        public ShareSettingsOrBuilder getShareSettingsOrBuilder()
         Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
         
        optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;
        Specified by:
        getShareSettingsOrBuilder in interface ReservationOrBuilder
      • hasSpecificReservation

        public boolean hasSpecificReservation()
         Reservation for instances with specific machine shapes.
         
        optional .google.cloud.compute.v1.AllocationSpecificSKUReservation specific_reservation = 404901951;
        Specified by:
        hasSpecificReservation in interface ReservationOrBuilder
        Returns:
        Whether the specificReservation field is set.
      • hasSpecificReservationRequired

        public boolean hasSpecificReservationRequired()
         Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
         
        optional bool specific_reservation_required = 226550687;
        Specified by:
        hasSpecificReservationRequired in interface ReservationOrBuilder
        Returns:
        Whether the specificReservationRequired field is set.
      • getSpecificReservationRequired

        public boolean getSpecificReservationRequired()
         Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
         
        optional bool specific_reservation_required = 226550687;
        Specified by:
        getSpecificReservationRequired in interface ReservationOrBuilder
        Returns:
        The specificReservationRequired.
      • hasStatus

        public boolean hasStatus()
         [Output Only] The status of the reservation.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        hasStatus in interface ReservationOrBuilder
        Returns:
        Whether the status field is set.
      • getStatus

        public String getStatus()
         [Output Only] The status of the reservation.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        getStatus in interface ReservationOrBuilder
        Returns:
        The status.
      • getStatusBytes

        public com.google.protobuf.ByteString getStatusBytes()
         [Output Only] The status of the reservation.
         Check the Status enum for the list of possible values.
         
        optional string status = 181260274;
        Specified by:
        getStatusBytes in interface ReservationOrBuilder
        Returns:
        The bytes for status.
      • hasZone

        public boolean hasZone()
         Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
         
        optional string zone = 3744684;
        Specified by:
        hasZone in interface ReservationOrBuilder
        Returns:
        Whether the zone field is set.
      • getZone

        public String getZone()
         Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
         
        optional string zone = 3744684;
        Specified by:
        getZone in interface ReservationOrBuilder
        Returns:
        The zone.
      • getZoneBytes

        public com.google.protobuf.ByteString getZoneBytes()
         Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
         
        optional string zone = 3744684;
        Specified by:
        getZoneBytes in interface ReservationOrBuilder
        Returns:
        The bytes for zone.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static Reservation parseFrom​(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(ByteBuffer data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(com.google.protobuf.ByteString data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(com.google.protobuf.ByteString data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(byte[] data)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(byte[] data,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static Reservation parseFrom​(com.google.protobuf.CodedInputStream input,
                                            com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                     throws IOException
        Throws:
        IOException
      • newBuilderForType

        public Reservation.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public Reservation.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected Reservation.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstance

        public static Reservation getDefaultInstance()
      • parser

        public static com.google.protobuf.Parser<Reservation> parser()
      • getParserForType

        public com.google.protobuf.Parser<Reservation> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public Reservation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder