/*
* Copyright 2020 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/bigquery/reservation/v1/reservation.proto
package com.google.cloud.bigquery.reservation.v1;
public interface CapacityCommitmentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.bigquery.reservation.v1.CapacityCommitment)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The resource name of the capacity commitment, e.g.,
* `projects/myproject/locations/US/capacityCommitments/123`
* The commitment_id must only contain lower case alphanumeric characters or
* dashes. It must start with a letter and must not end
* with a dash. Its maximum length is 64 characters.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The resource name of the capacity commitment, e.g.,
* `projects/myproject/locations/US/capacityCommitments/123`
* The commitment_id must only contain lower case alphanumeric characters or
* dashes. It must start with a letter and must not end
* with a dash. Its maximum length is 64 characters.
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Number of slots in this commitment.
*
*
* int64 slot_count = 2;
*
* @return The slotCount.
*/
long getSlotCount();
/**
*
*
*
* Capacity commitment commitment plan.
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
*
* @return The enum numeric value on the wire for plan.
*/
int getPlanValue();
/**
*
*
*
* Capacity commitment commitment plan.
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
*
* @return The plan.
*/
com.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan getPlan();
/**
*
*
*
* Output only. State of the commitment.
*
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. State of the commitment.
*
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.bigquery.reservation.v1.CapacityCommitment.State getState();
/**
*
*
*
* Output only. The start of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the commitmentStartTime field is set.
*/
boolean hasCommitmentStartTime();
/**
*
*
*
* Output only. The start of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The commitmentStartTime.
*/
com.google.protobuf.Timestamp getCommitmentStartTime();
/**
*
*
*
* Output only. The start of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_start_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCommitmentStartTimeOrBuilder();
/**
*
*
*
* Output only. The end of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the commitmentEndTime field is set.
*/
boolean hasCommitmentEndTime();
/**
*
*
*
* Output only. The end of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The commitmentEndTime.
*/
com.google.protobuf.Timestamp getCommitmentEndTime();
/**
*
*
*
* Output only. The end of the current commitment period. It is applicable
* only for ACTIVE capacity commitments.
*
*
*
* .google.protobuf.Timestamp commitment_end_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCommitmentEndTimeOrBuilder();
/**
*
*
*
* Output only. For FAILED commitment plan, provides the reason of failure.
*
*
* .google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the failureStatus field is set.
*/
boolean hasFailureStatus();
/**
*
*
*
* Output only. For FAILED commitment plan, provides the reason of failure.
*
*
* .google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The failureStatus.
*/
com.google.rpc.Status getFailureStatus();
/**
*
*
*
* Output only. For FAILED commitment plan, provides the reason of failure.
*
*
* .google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.rpc.StatusOrBuilder getFailureStatusOrBuilder();
/**
*
*
*
* The plan this capacity commitment is converted to after commitment_end_time
* passes. Once the plan is changed, committed period is extended according to
* commitment plan. Only applicable for ANNUAL and TRIAL commitments.
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8;
*
*
* @return The enum numeric value on the wire for renewalPlan.
*/
int getRenewalPlanValue();
/**
*
*
*
* The plan this capacity commitment is converted to after commitment_end_time
* passes. Once the plan is changed, committed period is extended according to
* commitment plan. Only applicable for ANNUAL and TRIAL commitments.
*
*
* .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan renewal_plan = 8;
*
*
* @return The renewalPlan.
*/
com.google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan getRenewalPlan();
/**
*
*
*
* Applicable only for commitments located within one of the BigQuery
* multi-regions (US or EU).
* If set to true, this commitment is placed in the organization's
* secondary region which is designated for disaster recovery purposes.
* If false, this commitment is placed in the organization's default region.
* NOTE: this is a preview feature. Project must be allow-listed in order to
* set this field.
*
*
* bool multi_region_auxiliary = 10;
*
* @return The multiRegionAuxiliary.
*/
boolean getMultiRegionAuxiliary();
/**
*
*
*
* Edition of the capacity commitment.
*
*
* .google.cloud.bigquery.reservation.v1.Edition edition = 12;
*
* @return The enum numeric value on the wire for edition.
*/
int getEditionValue();
/**
*
*
*
* Edition of the capacity commitment.
*
*
* .google.cloud.bigquery.reservation.v1.Edition edition = 12;
*
* @return The edition.
*/
com.google.cloud.bigquery.reservation.v1.Edition getEdition();
}