Google Cloud Native v0.28.0, Feb 2 23

google-native.bigqueryreservation/v1beta1.getCapacityCommitment

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/v1beta1:getCapacityCommitment
  arguments:
    # arguments dictionary

The following arguments are supported:

CapacityCommitmentId string
Location string
Project string

CapacityCommitmentId string
Location string
Project string

capacityCommitmentId String
location String
project String

capacityCommitmentId string
location string
project string

capacity_commitment_id str
location str
project str

capacityCommitmentId String
location String
project String

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.
FailureStatus Pulumi.GoogleNative.BigQueryReservation.V1Beta1.Outputs.StatusResponse: For FAILED commitment plan, provides the reason of failure.
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.
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 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.
FailureStatus StatusResponse: For FAILED commitment plan, provides the reason of failure.
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.
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 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.
failureStatus StatusResponse: For FAILED commitment plan, provides the reason of failure.
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.
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 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.
failureStatus StatusResponse: For FAILED commitment plan, provides the reason of failure.
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.
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 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.
failure_status StatusResponse: For FAILED commitment plan, provides the reason of failure.
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.
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 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.
failureStatus Property Map: For FAILED commitment plan, provides the reason of failure.
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.
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 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