Package com.google.cloud.bigquery.reservation.v1

Interface CapacityCommitmentOrBuilder

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

    • Method Detail

      • getName

        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];
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         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];
        Returns:
        The bytes for name.

      • getSlotCount

        long getSlotCount()
         Number of slots in this commitment.
        int64 slot_count = 2;
        Returns:
        The slotCount.

      • getPlanValue

        int getPlanValue()
         Capacity commitment commitment plan.
        .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
        Returns:
        The enum numeric value on the wire for plan.

      • getPlan

        CapacityCommitment.CommitmentPlan getPlan()
         Capacity commitment commitment plan.
        .google.cloud.bigquery.reservation.v1.CapacityCommitment.CommitmentPlan plan = 3;
        Returns:
        The plan.

      • getStateValue

        int getStateValue()
         Output only. State of the commitment.
        .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The enum numeric value on the wire for state.

      • getState

        CapacityCommitment.State getState()
         Output only. State of the commitment.
        .google.cloud.bigquery.reservation.v1.CapacityCommitment.State state = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The state.

      • hasCommitmentStartTime

        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];
        Returns:
        Whether the commitmentStartTime field is set.

      • getCommitmentStartTime

        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];
        Returns:
        The commitmentStartTime.

      • getCommitmentStartTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCommitmentStartTimeOrBuilder()
         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];

      • hasCommitmentEndTime

        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];
        Returns:
        Whether the commitmentEndTime field is set.

      • getCommitmentEndTime

        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];
        Returns:
        The commitmentEndTime.

      • getCommitmentEndTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCommitmentEndTimeOrBuilder()
         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];

      • hasFailureStatus

        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];
        Returns:
        Whether the failureStatus field is set.

      • getFailureStatus

        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];
        Returns:
        The failureStatus.

      • getFailureStatusOrBuilder

        com.google.rpc.StatusOrBuilder getFailureStatusOrBuilder()
         Output only. For FAILED commitment plan, provides the reason of failure.
        .google.rpc.Status failure_status = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getRenewalPlanValue

        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;
        Returns:
        The enum numeric value on the wire for renewalPlan.

      • getRenewalPlan

        CapacityCommitment.CommitmentPlan getRenewalPlan()
         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;
        Returns:
        The renewalPlan.

      • getMultiRegionAuxiliary

        boolean getMultiRegionAuxiliary()
         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;
        Returns:
        The multiRegionAuxiliary.

      • getEditionValue

        int getEditionValue()
         Edition of the capacity commitment.
        .google.cloud.bigquery.reservation.v1.Edition edition = 12;
        Returns:
        The enum numeric value on the wire for edition.

      • getEdition

        Edition getEdition()
         Edition of the capacity commitment.
        .google.cloud.bigquery.reservation.v1.Edition edition = 12;
        Returns:
        The edition.