com.google.cloud.compute.v1.CommitmentOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-compute-v1 Show documentation
Show all versions of proto-google-cloud-compute-v1 Show documentation
Proto library for google-cloud-compute
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/compute/v1/compute.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.compute.v1;
public interface CommitmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.compute.v1.Commitment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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;
*
* @return Whether the autoRenew field is set.
*/
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;
*
* @return The autoRenew.
*/
boolean getAutoRenew();
/**
*
*
*
* 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;
*
* @return Whether the category field is set.
*/
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;
*
* @return The category.
*/
java.lang.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;
*
* @return The bytes for category.
*/
com.google.protobuf.ByteString getCategoryBytes();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return Whether the creationTimestamp field is set.
*/
boolean hasCreationTimestamp();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return The creationTimestamp.
*/
java.lang.String getCreationTimestamp();
/**
*
*
*
* [Output Only] Creation timestamp in RFC3339 text format.
*
*
* optional string creation_timestamp = 30525366;
*
* @return The bytes for creationTimestamp.
*/
com.google.protobuf.ByteString getCreationTimestampBytes();
/**
*
*
*
* [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
*
*
* optional string custom_end_timestamp = 181770852;
*
* @return Whether the customEndTimestamp field is set.
*/
boolean hasCustomEndTimestamp();
/**
*
*
*
* [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
*
*
* optional string custom_end_timestamp = 181770852;
*
* @return The customEndTimestamp.
*/
java.lang.String getCustomEndTimestamp();
/**
*
*
*
* [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
*
*
* optional string custom_end_timestamp = 181770852;
*
* @return The bytes for customEndTimestamp.
*/
com.google.protobuf.ByteString getCustomEndTimestampBytes();
/**
*
*
*
* An optional description of this resource. Provide this property when you create the resource.
*
*
* optional string description = 422937596;
*
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
*
*
* An optional description of this resource. Provide this property when you create the resource.
*
*
* optional string description = 422937596;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* An optional description of this resource. Provide this property when you create the resource.
*
*
* optional string description = 422937596;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* [Output Only] Commitment end time in RFC3339 text format.
*
*
* optional string end_timestamp = 468096690;
*
* @return Whether the endTimestamp field is set.
*/
boolean hasEndTimestamp();
/**
*
*
*
* [Output Only] Commitment end time in RFC3339 text format.
*
*
* optional string end_timestamp = 468096690;
*
* @return The endTimestamp.
*/
java.lang.String getEndTimestamp();
/**
*
*
*
* [Output Only] Commitment end time in RFC3339 text format.
*
*
* optional string end_timestamp = 468096690;
*
* @return The bytes for endTimestamp.
*/
com.google.protobuf.ByteString getEndTimestampBytes();
/**
*
*
*
* Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
*
*
* repeated string existing_reservations = 493028443;
*
* @return A list containing the existingReservations.
*/
java.util.List getExistingReservationsList();
/**
*
*
*
* Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
*
*
* repeated string existing_reservations = 493028443;
*
* @return The count of existingReservations.
*/
int getExistingReservationsCount();
/**
*
*
*
* Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
*
*
* repeated string existing_reservations = 493028443;
*
* @param index The index of the element to return.
* @return The existingReservations at the given index.
*/
java.lang.String getExistingReservations(int index);
/**
*
*
*
* Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
*
*
* repeated string existing_reservations = 493028443;
*
* @param index The index of the value to return.
* @return The bytes of the existingReservations at the given index.
*/
com.google.protobuf.ByteString getExistingReservationsBytes(int index);
/**
*
*
*
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
*
*
* optional uint64 id = 3355;
*
* @return Whether the id field is set.
*/
boolean hasId();
/**
*
*
*
* [Output Only] The unique identifier for the resource. This identifier is defined by the server.
*
*
* optional uint64 id = 3355;
*
* @return The id.
*/
long getId();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#commitment for commitments.
*
*
* optional string kind = 3292052;
*
* @return Whether the kind field is set.
*/
boolean hasKind();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#commitment for commitments.
*
*
* optional string kind = 3292052;
*
* @return The kind.
*/
java.lang.String getKind();
/**
*
*
*
* [Output Only] Type of the resource. Always compute#commitment for commitments.
*
*
* optional string kind = 3292052;
*
* @return The bytes for kind.
*/
com.google.protobuf.ByteString getKindBytes();
/**
*
*
*
* The license specification required as part of a license commitment.
*
*
* optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
*
*
* @return Whether the licenseResource field is set.
*/
boolean hasLicenseResource();
/**
*
*
*
* The license specification required as part of a license commitment.
*
*
* optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
*
*
* @return The licenseResource.
*/
com.google.cloud.compute.v1.LicenseResourceCommitment getLicenseResource();
/**
*
*
*
* The license specification required as part of a license commitment.
*
*
* optional .google.cloud.compute.v1.LicenseResourceCommitment license_resource = 437955148;
*
*/
com.google.cloud.compute.v1.LicenseResourceCommitmentOrBuilder getLicenseResourceOrBuilder();
/**
*
*
*
* List of source commitments to be merged into a new commitment.
*
*
* repeated string merge_source_commitments = 188093761;
*
* @return A list containing the mergeSourceCommitments.
*/
java.util.List getMergeSourceCommitmentsList();
/**
*
*
*
* List of source commitments to be merged into a new commitment.
*
*
* repeated string merge_source_commitments = 188093761;
*
* @return The count of mergeSourceCommitments.
*/
int getMergeSourceCommitmentsCount();
/**
*
*
*
* List of source commitments to be merged into a new commitment.
*
*
* repeated string merge_source_commitments = 188093761;
*
* @param index The index of the element to return.
* @return The mergeSourceCommitments at the given index.
*/
java.lang.String getMergeSourceCommitments(int index);
/**
*
*
*
* List of source commitments to be merged into a new commitment.
*
*
* repeated string merge_source_commitments = 188093761;
*
* @param index The index of the value to return.
* @return The bytes of the mergeSourceCommitments at the given index.
*/
com.google.protobuf.ByteString getMergeSourceCommitmentsBytes(int index);
/**
*
*
*
* 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;
*
* @return Whether the name field is set.
*/
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;
*
* @return The name.
*/
java.lang.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;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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;
*
* @return Whether the plan field is set.
*/
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;
*
* @return The plan.
*/
java.lang.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;
*
* @return The bytes for plan.
*/
com.google.protobuf.ByteString getPlanBytes();
/**
*
*
*
* [Output Only] URL of the region where this commitment may be used.
*
*
* optional string region = 138946292;
*
* @return Whether the region field is set.
*/
boolean hasRegion();
/**
*
*
*
* [Output Only] URL of the region where this commitment may be used.
*
*
* optional string region = 138946292;
*
* @return The region.
*/
java.lang.String getRegion();
/**
*
*
*
* [Output Only] URL of the region where this commitment may be used.
*
*
* optional string region = 138946292;
*
* @return The bytes for region.
*/
com.google.protobuf.ByteString getRegionBytes();
/**
*
*
*
* List of create-on-create reservations for this commitment.
*
*
* repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
*/
java.util.List getReservationsList();
/**
*
*
*
* List of create-on-create reservations for this commitment.
*
*
* repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
*/
com.google.cloud.compute.v1.Reservation getReservations(int index);
/**
*
*
*
* List of create-on-create reservations for this commitment.
*
*
* repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
*/
int getReservationsCount();
/**
*
*
*
* List of create-on-create reservations for this commitment.
*
*
* repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
*/
java.util.List
getReservationsOrBuilderList();
/**
*
*
*
* List of create-on-create reservations for this commitment.
*
*
* repeated .google.cloud.compute.v1.Reservation reservations = 399717927;
*/
com.google.cloud.compute.v1.ReservationOrBuilder getReservationsOrBuilder(int index);
/**
*
*
*
* [Output Only] Status information for Commitment resource.
*
*
* optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
*
*
* @return Whether the resourceStatus field is set.
*/
boolean hasResourceStatus();
/**
*
*
*
* [Output Only] Status information for Commitment resource.
*
*
* optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
*
*
* @return The resourceStatus.
*/
com.google.cloud.compute.v1.CommitmentResourceStatus getResourceStatus();
/**
*
*
*
* [Output Only] Status information for Commitment resource.
*
*
* optional .google.cloud.compute.v1.CommitmentResourceStatus resource_status = 249429315;
*
*/
com.google.cloud.compute.v1.CommitmentResourceStatusOrBuilder getResourceStatusOrBuilder();
/**
*
*
*
* 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;
*/
java.util.List 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;
*/
com.google.cloud.compute.v1.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;
*/
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;
*/
java.util.List
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;
*/
com.google.cloud.compute.v1.ResourceCommitmentOrBuilder getResourcesOrBuilder(int index);
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return Whether the selfLink field is set.
*/
boolean hasSelfLink();
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return The selfLink.
*/
java.lang.String getSelfLink();
/**
*
*
*
* [Output Only] Server-defined URL for the resource.
*
*
* optional string self_link = 456214797;
*
* @return The bytes for selfLink.
*/
com.google.protobuf.ByteString getSelfLinkBytes();
/**
*
*
*
* Source commitment to be split into a new commitment.
*
*
* optional string split_source_commitment = 402611156;
*
* @return Whether the splitSourceCommitment field is set.
*/
boolean hasSplitSourceCommitment();
/**
*
*
*
* Source commitment to be split into a new commitment.
*
*
* optional string split_source_commitment = 402611156;
*
* @return The splitSourceCommitment.
*/
java.lang.String getSplitSourceCommitment();
/**
*
*
*
* Source commitment to be split into a new commitment.
*
*
* optional string split_source_commitment = 402611156;
*
* @return The bytes for splitSourceCommitment.
*/
com.google.protobuf.ByteString getSplitSourceCommitmentBytes();
/**
*
*
*
* [Output Only] Commitment start time in RFC3339 text format.
*
*
* optional string start_timestamp = 83645817;
*
* @return Whether the startTimestamp field is set.
*/
boolean hasStartTimestamp();
/**
*
*
*
* [Output Only] Commitment start time in RFC3339 text format.
*
*
* optional string start_timestamp = 83645817;
*
* @return The startTimestamp.
*/
java.lang.String getStartTimestamp();
/**
*
*
*
* [Output Only] Commitment start time in RFC3339 text format.
*
*
* optional string start_timestamp = 83645817;
*
* @return The bytes for startTimestamp.
*/
com.google.protobuf.ByteString getStartTimestampBytes();
/**
*
*
*
* [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;
*
* @return Whether the status field is set.
*/
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;
*
* @return The status.
*/
java.lang.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;
*
* @return The bytes for status.
*/
com.google.protobuf.ByteString getStatusBytes();
/**
*
*
*
* [Output Only] An optional, human-readable explanation of the status.
*
*
* optional string status_message = 297428154;
*
* @return Whether the statusMessage field is set.
*/
boolean hasStatusMessage();
/**
*
*
*
* [Output Only] An optional, human-readable explanation of the status.
*
*
* optional string status_message = 297428154;
*
* @return The statusMessage.
*/
java.lang.String getStatusMessage();
/**
*
*
*
* [Output Only] An optional, human-readable explanation of the status.
*
*
* optional string status_message = 297428154;
*
* @return The bytes for statusMessage.
*/
com.google.protobuf.ByteString getStatusMessageBytes();
/**
*
*
*
* 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;
*
* @return Whether the type field is set.
*/
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;
*
* @return The type.
*/
java.lang.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;
*
* @return The bytes for type.
*/
com.google.protobuf.ByteString getTypeBytes();
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy