Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. bigqueryreservation
  5. bigqueryreservation/v1
  6. getCapacityCommitment

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.bigqueryreservation/v1.getCapacityCommitment

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Returns information about the capacity commitment.

    Using getCapacityCommitment

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCapacityCommitment(args: GetCapacityCommitmentArgs, opts?: InvokeOptions): Promise<GetCapacityCommitmentResult>
function getCapacityCommitmentOutput(args: GetCapacityCommitmentOutputArgs, opts?: InvokeOptions): Output<GetCapacityCommitmentResult>
    def get_capacity_commitment(capacity_commitment_id: Optional[str] = None,
                            location: Optional[str] = None,
                            project: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetCapacityCommitmentResult
def get_capacity_commitment_output(capacity_commitment_id: Optional[pulumi.Input[str]] = None,
                            location: Optional[pulumi.Input[str]] = None,
                            project: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetCapacityCommitmentResult]
    func LookupCapacityCommitment(ctx *Context, args *LookupCapacityCommitmentArgs, opts ...InvokeOption) (*LookupCapacityCommitmentResult, error)
func LookupCapacityCommitmentOutput(ctx *Context, args *LookupCapacityCommitmentOutputArgs, opts ...InvokeOption) LookupCapacityCommitmentResultOutput

    > Note: This function is named LookupCapacityCommitment in the Go SDK.

    public static class GetCapacityCommitment 
{
    public static Task<GetCapacityCommitmentResult> InvokeAsync(GetCapacityCommitmentArgs args, InvokeOptions? opts = null)
    public static Output<GetCapacityCommitmentResult> Invoke(GetCapacityCommitmentInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetCapacityCommitmentResult> getCapacityCommitment(GetCapacityCommitmentArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: google-native:bigqueryreservation/v1:getCapacityCommitment
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getCapacityCommitment Result

    The following output properties are available:

    CommitmentEndTime string
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    CommitmentStartTime string
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    Edition string
    Edition of the capacity commitment.
    FailureStatus Pulumi.GoogleNative.BigQueryReservation.V1.Outputs.StatusResponse
    For FAILED commitment plan, provides the reason of failure.
    IsFlatRate bool
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    MultiRegionAuxiliary bool
    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.
    Name string
    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.
    Plan string
    Capacity commitment commitment plan.
    RenewalPlan string
    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.
    SlotCount string
    Number of slots in this commitment.
    State string
    State of the commitment.
    CommitmentEndTime string
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    CommitmentStartTime string
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    Edition string
    Edition of the capacity commitment.
    FailureStatus StatusResponse
    For FAILED commitment plan, provides the reason of failure.
    IsFlatRate bool
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    MultiRegionAuxiliary bool
    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.
    Name string
    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.
    Plan string
    Capacity commitment commitment plan.
    RenewalPlan string
    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.
    SlotCount string
    Number of slots in this commitment.
    State string
    State of the commitment.
    commitmentEndTime String
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    commitmentStartTime String
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    edition String
    Edition of the capacity commitment.
    failureStatus StatusResponse
    For FAILED commitment plan, provides the reason of failure.
    isFlatRate Boolean
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    multiRegionAuxiliary Boolean
    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.
    name String
    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.
    plan String
    Capacity commitment commitment plan.
    renewalPlan String
    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.
    slotCount String
    Number of slots in this commitment.
    state String
    State of the commitment.
    commitmentEndTime string
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    commitmentStartTime string
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    edition string
    Edition of the capacity commitment.
    failureStatus StatusResponse
    For FAILED commitment plan, provides the reason of failure.
    isFlatRate boolean
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    multiRegionAuxiliary boolean
    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.
    name string
    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.
    plan string
    Capacity commitment commitment plan.
    renewalPlan string
    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.
    slotCount string
    Number of slots in this commitment.
    state string
    State of the commitment.
    commitment_end_time str
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    commitment_start_time str
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    edition str
    Edition of the capacity commitment.
    failure_status StatusResponse
    For FAILED commitment plan, provides the reason of failure.
    is_flat_rate bool
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    multi_region_auxiliary bool
    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.
    name str
    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.
    plan str
    Capacity commitment commitment plan.
    renewal_plan str
    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.
    slot_count str
    Number of slots in this commitment.
    state str
    State of the commitment.
    commitmentEndTime String
    The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    commitmentStartTime String
    The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
    edition String
    Edition of the capacity commitment.
    failureStatus Property Map
    For FAILED commitment plan, provides the reason of failure.
    isFlatRate Boolean
    If true, the commitment is a flat-rate commitment, otherwise, it's an edition commitment.
    multiRegionAuxiliary Boolean
    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.
    name String
    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.
    plan String
    Capacity commitment commitment plan.
    renewalPlan String
    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.
    slotCount String
    Number of slots in this commitment.
    state String
    State of the commitment.

    Supporting Types

    StatusResponse

    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details List<ImmutableDictionary<string, string>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    Code int
    The status code, which should be an enum value of google.rpc.Code.
    Details []map[string]string
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    Message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Integer
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String,String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code number
    The status code, which should be an enum value of google.rpc.Code.
    details {[key: string]: string}[]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message string
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code int
    The status code, which should be an enum value of google.rpc.Code.
    details Sequence[Mapping[str, str]]
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message str
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
    code Number
    The status code, which should be an enum value of google.rpc.Code.
    details List<Map<String>>
    A list of messages that carry the error details. There is a common set of message types for APIs to use.
    message String
    A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native