Package com.google.cloud.compute.v1

Interface CommitmentOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Commitment, Commitment.Builder
    public interface CommitmentOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasAutoRenew

        boolean hasAutoRenew()
         Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
        optional bool auto_renew = 495520765;
        Returns:
        Whether the autoRenew field is set.

      • getAutoRenew

        boolean getAutoRenew()
         Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
        optional bool auto_renew = 495520765;
        Returns:
        The autoRenew.

      • hasCategory

        boolean hasCategory()
         The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
 Check the Category enum for the list of possible values.
        optional string category = 50511102;
        Returns:
        Whether the category field is set.

      • getCategory

        String getCategory()
         The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
 Check the Category enum for the list of possible values.
        optional string category = 50511102;
        Returns:
        The category.

      • getCategoryBytes

        com.google.protobuf.ByteString getCategoryBytes()
         The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
 Check the Category enum for the list of possible values.
        optional string category = 50511102;
        Returns:
        The bytes for category.

      • hasCreationTimestamp

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

      • getCreationTimestamp

        String getCreationTimestamp()
         [Output Only] Creation timestamp in RFC3339 text format.
        optional string creation_timestamp = 30525366;
        Returns:
        The creationTimestamp.

      • getCreationTimestampBytes

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

      • hasDescription

        boolean hasDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        Whether the description field is set.

      • getDescription

        String getDescription()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The description.

      • getDescriptionBytes

        com.google.protobuf.ByteString getDescriptionBytes()
         An optional description of this resource. Provide this property when you create the resource.
        optional string description = 422937596;
        Returns:
        The bytes for description.

      • hasEndTimestamp

        boolean hasEndTimestamp()
         [Output Only] Commitment end time in RFC3339 text format.
        optional string end_timestamp = 468096690;
        Returns:
        Whether the endTimestamp field is set.

      • getEndTimestamp

        String getEndTimestamp()
         [Output Only] Commitment end time in RFC3339 text format.
        optional string end_timestamp = 468096690;
        Returns:
        The endTimestamp.

      • getEndTimestampBytes

        com.google.protobuf.ByteString getEndTimestampBytes()
         [Output Only] Commitment end time in RFC3339 text format.
        optional string end_timestamp = 468096690;
        Returns:
        The bytes for endTimestamp.

      • hasId

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

      • getId

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

      • hasKind

        boolean hasKind()
         [Output Only] Type of the resource. Always compute#commitment for commitments.
        optional string kind = 3292052;
        Returns:
        Whether the kind field is set.

      • getKind

        String getKind()
         [Output Only] Type of the resource. Always compute#commitment for commitments.
        optional string kind = 3292052;
        Returns:
        The kind.

      • getKindBytes

        com.google.protobuf.ByteString getKindBytes()
         [Output Only] Type of the resource. Always compute#commitment for commitments.
        optional string kind = 3292052;
        Returns:
        The bytes for kind.

      • hasLicenseResource

        boolean hasLicenseResource()
         The license specification required as part of a license commitment.
        optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
        Returns:
        Whether the licenseResource field is set.

      • getLicenseResource

        LicenseResourceCommitment getLicenseResource()
         The license specification required as part of a license commitment.
        optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
        Returns:
        The licenseResource.

      • getLicenseResourceOrBuilder

        LicenseResourceCommitmentOrBuilder getLicenseResourceOrBuilder()
         The license specification required as part of a license commitment.
        optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;

      • getMergeSourceCommitmentsList

        List<String> getMergeSourceCommitmentsList()
         List of source commitments to be merged into a new commitment.
        repeated string merge_source_commitments = 188093761;
        Returns:
        A list containing the mergeSourceCommitments.

      • getMergeSourceCommitmentsCount

        int getMergeSourceCommitmentsCount()
         List of source commitments to be merged into a new commitment.
        repeated string merge_source_commitments = 188093761;
        Returns:
        The count of mergeSourceCommitments.

      • getMergeSourceCommitments

        String getMergeSourceCommitments​(int index)
         List of source commitments to be merged into a new commitment.
        repeated string merge_source_commitments = 188093761;
        Parameters:
        index - The index of the element to return.
        Returns:
        The mergeSourceCommitments at the given index.

      • getMergeSourceCommitmentsBytes

        com.google.protobuf.ByteString getMergeSourceCommitmentsBytes​(int index)
         List of source commitments to be merged into a new commitment.
        repeated string merge_source_commitments = 188093761;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the mergeSourceCommitments at the given index.

      • hasName

        boolean hasName()
         Name of the resource. Provided by the client when the resource is created. The 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;
        Returns:
        Whether the name field is set.

      • getName

        String getName()
         Name of the resource. Provided by the client when the resource is created. The 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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Name of the resource. Provided by the client when the resource is created. The 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;
        Returns:
        The bytes for name.

      • hasPlan

        boolean hasPlan()
         The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
 Check the Plan enum for the list of possible values.
        optional string plan = 3443497;
        Returns:
        Whether the plan field is set.

      • getPlan

        String getPlan()
         The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
 Check the Plan enum for the list of possible values.
        optional string plan = 3443497;
        Returns:
        The plan.

      • getPlanBytes

        com.google.protobuf.ByteString getPlanBytes()
         The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
 Check the Plan enum for the list of possible values.
        optional string plan = 3443497;
        Returns:
        The bytes for plan.

      • hasRegion

        boolean hasRegion()
         [Output Only] URL of the region where this commitment may be used.
        optional string region = 138946292;
        Returns:
        Whether the region field is set.

      • getRegion

        String getRegion()
         [Output Only] URL of the region where this commitment may be used.
        optional string region = 138946292;
        Returns:
        The region.

      • getRegionBytes

        com.google.protobuf.ByteString getRegionBytes()
         [Output Only] URL of the region where this commitment may be used.
        optional string region = 138946292;
        Returns:
        The bytes for region.

      • getReservationsList

        List<Reservation> getReservationsList()
         List of reservations in this commitment.
        repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

      • getReservations

        Reservation getReservations​(int index)
         List of reservations in this commitment.
        repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

      • getReservationsCount

        int getReservationsCount()
         List of reservations in this commitment.
        repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

      • getReservationsOrBuilderList

        List<? extends ReservationOrBuilder> getReservationsOrBuilderList()
         List of reservations in this commitment.
        repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

      • getReservationsOrBuilder

        ReservationOrBuilder getReservationsOrBuilder​(int index)
         List of reservations in this commitment.
        repeated .google.cloud.compute.v1.Reservation reservations = 399717927;

      • getResourcesList

        List<ResourceCommitment> getResourcesList()
         A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
        repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

      • getResources

        ResourceCommitment getResources​(int index)
         A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
        repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

      • getResourcesCount

        int getResourcesCount()
         A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
        repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

      • getResourcesOrBuilderList

        List<? extends ResourceCommitmentOrBuilder> getResourcesOrBuilderList()
         A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
        repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

      • getResourcesOrBuilder

        ResourceCommitmentOrBuilder getResourcesOrBuilder​(int index)
         A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
        repeated .google.cloud.compute.v1.ResourceCommitment resources = 164412965;

      • hasSelfLink

        boolean hasSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        Whether the selfLink field is set.

      • getSelfLink

        String getSelfLink()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        The selfLink.

      • getSelfLinkBytes

        com.google.protobuf.ByteString getSelfLinkBytes()
         [Output Only] Server-defined URL for the resource.
        optional string self_link = 456214797;
        Returns:
        The bytes for selfLink.

      • hasSplitSourceCommitment

        boolean hasSplitSourceCommitment()
         Source commitment to be split into a new commitment.
        optional string split_source_commitment = 402611156;
        Returns:
        Whether the splitSourceCommitment field is set.

      • getSplitSourceCommitment

        String getSplitSourceCommitment()
         Source commitment to be split into a new commitment.
        optional string split_source_commitment = 402611156;
        Returns:
        The splitSourceCommitment.

      • getSplitSourceCommitmentBytes

        com.google.protobuf.ByteString getSplitSourceCommitmentBytes()
         Source commitment to be split into a new commitment.
        optional string split_source_commitment = 402611156;
        Returns:
        The bytes for splitSourceCommitment.

      • hasStartTimestamp

        boolean hasStartTimestamp()
         [Output Only] Commitment start time in RFC3339 text format.
        optional string start_timestamp = 83645817;
        Returns:
        Whether the startTimestamp field is set.

      • getStartTimestamp

        String getStartTimestamp()
         [Output Only] Commitment start time in RFC3339 text format.
        optional string start_timestamp = 83645817;
        Returns:
        The startTimestamp.

      • getStartTimestampBytes

        com.google.protobuf.ByteString getStartTimestampBytes()
         [Output Only] Commitment start time in RFC3339 text format.
        optional string start_timestamp = 83645817;
        Returns:
        The bytes for startTimestamp.

      • hasStatus

        boolean hasStatus()
         [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Returns:
        Whether the status field is set.

      • getStatus

        String getStatus()
         [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Returns:
        The status.

      • getStatusBytes

        com.google.protobuf.ByteString getStatusBytes()
         [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
 Check the Status enum for the list of possible values.
        optional string status = 181260274;
        Returns:
        The bytes for status.

      • hasStatusMessage

        boolean hasStatusMessage()
         [Output Only] An optional, human-readable explanation of the status.
        optional string status_message = 297428154;
        Returns:
        Whether the statusMessage field is set.

      • getStatusMessage

        String getStatusMessage()
         [Output Only] An optional, human-readable explanation of the status.
        optional string status_message = 297428154;
        Returns:
        The statusMessage.

      • getStatusMessageBytes

        com.google.protobuf.ByteString getStatusMessageBytes()
         [Output Only] An optional, human-readable explanation of the status.
        optional string status_message = 297428154;
        Returns:
        The bytes for statusMessage.

      • hasType

        boolean hasType()
         The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Returns:
        Whether the type field is set.

      • getType

        String getType()
         The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
 Check the Type enum for the list of possible values.
        optional string type = 3575610;
        Returns:
        The bytes for type.