v1beta1

package
v0.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 29, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
	CapacityCommitmentPlanCommitmentPlanUnspecified = CapacityCommitmentPlan("COMMITMENT_PLAN_UNSPECIFIED")
	// Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
	CapacityCommitmentPlanFlex = CapacityCommitmentPlan("FLEX")
	// Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.
	CapacityCommitmentPlanTrial = CapacityCommitmentPlan("TRIAL")
	// Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
	CapacityCommitmentPlanMonthly = CapacityCommitmentPlan("MONTHLY")
	// Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.
	CapacityCommitmentPlanAnnual = CapacityCommitmentPlan("ANNUAL")
)
View Source 
const (
	// Invalid plan value. Requests with this value will be rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.
	CapacityCommitmentRenewalPlanCommitmentPlanUnspecified = CapacityCommitmentRenewalPlan("COMMITMENT_PLAN_UNSPECIFIED")
	// Flex commitments have committed period of 1 minute after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
	CapacityCommitmentRenewalPlanFlex = CapacityCommitmentRenewalPlan("FLEX")
	// Trial commitments have a committed period of 182 days after becoming ACTIVE. After that, they are converted to a new commitment based on the `renewal_plan`. Default `renewal_plan` for Trial commitment is Flex so that it can be deleted right after committed period ends.
	CapacityCommitmentRenewalPlanTrial = CapacityCommitmentRenewalPlan("TRIAL")
	// Monthly commitments have a committed period of 30 days after becoming ACTIVE. After that, they are not in a committed period anymore and can be removed any time.
	CapacityCommitmentRenewalPlanMonthly = CapacityCommitmentRenewalPlan("MONTHLY")
	// Annual commitments have a committed period of 365 days after becoming ACTIVE. After that they are converted to a new commitment based on the renewal_plan.
	CapacityCommitmentRenewalPlanAnnual = CapacityCommitmentRenewalPlan("ANNUAL")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type CapacityCommitment 

type CapacityCommitment struct {
	pulumi.CustomResourceState

	// The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
	CapacityCommitmentId pulumi.StringPtrOutput `pulumi:"capacityCommitmentId"`
	// The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
	CommitmentEndTime pulumi.StringOutput `pulumi:"commitmentEndTime"`
	// The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
	CommitmentStartTime pulumi.StringOutput `pulumi:"commitmentStartTime"`
	// If true, fail the request if another project in the organization has a capacity commitment.
	EnforceSingleAdminProjectPerOrg pulumi.BoolPtrOutput `pulumi:"enforceSingleAdminProjectPerOrg"`
	// For FAILED commitment plan, provides the reason of failure.
	FailureStatus StatusResponseOutput `pulumi:"failureStatus"`
	Location      pulumi.StringOutput  `pulumi:"location"`
	// 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.
	MultiRegionAuxiliary pulumi.BoolOutput `pulumi:"multiRegionAuxiliary"`
	// 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.
	Name pulumi.StringOutput `pulumi:"name"`
	// Capacity commitment commitment plan.
	Plan    pulumi.StringOutput `pulumi:"plan"`
	Project pulumi.StringOutput `pulumi:"project"`
	// 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.
	RenewalPlan pulumi.StringOutput `pulumi:"renewalPlan"`
	// Number of slots in this commitment.
	SlotCount pulumi.StringOutput `pulumi:"slotCount"`
	// State of the commitment.
	State pulumi.StringOutput `pulumi:"state"`
}

Creates a new capacity commitment resource. Auto-naming is currently not supported for this resource.

func GetCapacityCommitment 

func GetCapacityCommitment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CapacityCommitmentState, opts ...pulumi.ResourceOption) (*CapacityCommitment, error)

GetCapacityCommitment gets an existing CapacityCommitment resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewCapacityCommitment 

func NewCapacityCommitment(ctx *pulumi.Context,
	name string, args *CapacityCommitmentArgs, opts ...pulumi.ResourceOption) (*CapacityCommitment, error)

NewCapacityCommitment registers a new resource with the given unique name, arguments, and options.

func (*CapacityCommitment) ElementType 

func (*CapacityCommitment) ElementType() reflect.Type

func (*CapacityCommitment) ToCapacityCommitmentOutput 

func (i *CapacityCommitment) ToCapacityCommitmentOutput() CapacityCommitmentOutput

func (*CapacityCommitment) ToCapacityCommitmentOutputWithContext 

func (i *CapacityCommitment) ToCapacityCommitmentOutputWithContext(ctx context.Context) CapacityCommitmentOutput

type CapacityCommitmentArgs 

type CapacityCommitmentArgs struct {
	// The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.
	CapacityCommitmentId pulumi.StringPtrInput
	// If true, fail the request if another project in the organization has a capacity commitment.
	EnforceSingleAdminProjectPerOrg pulumi.BoolPtrInput
	Location                        pulumi.StringPtrInput
	// 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.
	MultiRegionAuxiliary pulumi.BoolPtrInput
	// Capacity commitment commitment plan.
	Plan    CapacityCommitmentPlanPtrInput
	Project pulumi.StringPtrInput
	// 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.
	RenewalPlan CapacityCommitmentRenewalPlanPtrInput
	// Number of slots in this commitment.
	SlotCount pulumi.StringPtrInput
}

The set of arguments for constructing a CapacityCommitment resource.

func (CapacityCommitmentArgs) ElementType 

func (CapacityCommitmentArgs) ElementType() reflect.Type

type CapacityCommitmentInput 

type CapacityCommitmentInput interface {
	pulumi.Input

	ToCapacityCommitmentOutput() CapacityCommitmentOutput
	ToCapacityCommitmentOutputWithContext(ctx context.Context) CapacityCommitmentOutput
}

type CapacityCommitmentOutput 

type CapacityCommitmentOutput struct{ *pulumi.OutputState }

func (CapacityCommitmentOutput) CapacityCommitmentId added in v0.21.0 

func (o CapacityCommitmentOutput) CapacityCommitmentId() pulumi.StringPtrOutput

The optional capacity commitment ID. Capacity commitment name will be generated automatically if this field is empty. This field must only contain lower case alphanumeric characters or dashes. The first and last character cannot be a dash. Max length is 64 characters. NOTE: this ID won't be kept if the capacity commitment is split or merged.

func (CapacityCommitmentOutput) CommitmentEndTime added in v0.19.0 

func (o CapacityCommitmentOutput) CommitmentEndTime() pulumi.StringOutput

The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

func (CapacityCommitmentOutput) CommitmentStartTime added in v0.19.0 

func (o CapacityCommitmentOutput) CommitmentStartTime() pulumi.StringOutput

The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

func (CapacityCommitmentOutput) ElementType 

func (CapacityCommitmentOutput) ElementType() reflect.Type

func (CapacityCommitmentOutput) EnforceSingleAdminProjectPerOrg added in v0.21.0 

func (o CapacityCommitmentOutput) EnforceSingleAdminProjectPerOrg() pulumi.BoolPtrOutput

If true, fail the request if another project in the organization has a capacity commitment.

func (CapacityCommitmentOutput) FailureStatus added in v0.19.0 

func (o CapacityCommitmentOutput) FailureStatus() StatusResponseOutput

For FAILED commitment plan, provides the reason of failure.

func (CapacityCommitmentOutput) Location added in v0.21.0 

func (o CapacityCommitmentOutput) Location() pulumi.StringOutput

func (CapacityCommitmentOutput) MultiRegionAuxiliary added in v0.19.0 

func (o CapacityCommitmentOutput) MultiRegionAuxiliary() pulumi.BoolOutput

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.

func (CapacityCommitmentOutput) Name added in v0.19.0 

func (o CapacityCommitmentOutput) Name() pulumi.StringOutput

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.

func (CapacityCommitmentOutput) Plan added in v0.19.0 

func (o CapacityCommitmentOutput) Plan() pulumi.StringOutput

Capacity commitment commitment plan.

func (CapacityCommitmentOutput) Project added in v0.21.0 

func (o CapacityCommitmentOutput) Project() pulumi.StringOutput

func (CapacityCommitmentOutput) RenewalPlan added in v0.19.0 

func (o CapacityCommitmentOutput) RenewalPlan() pulumi.StringOutput

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.

func (CapacityCommitmentOutput) SlotCount added in v0.19.0 

func (o CapacityCommitmentOutput) SlotCount() pulumi.StringOutput

Number of slots in this commitment.

func (CapacityCommitmentOutput) State added in v0.19.0 

func (o CapacityCommitmentOutput) State() pulumi.StringOutput

State of the commitment.

func (CapacityCommitmentOutput) ToCapacityCommitmentOutput 

func (o CapacityCommitmentOutput) ToCapacityCommitmentOutput() CapacityCommitmentOutput

func (CapacityCommitmentOutput) ToCapacityCommitmentOutputWithContext 

func (o CapacityCommitmentOutput) ToCapacityCommitmentOutputWithContext(ctx context.Context) CapacityCommitmentOutput

type CapacityCommitmentPlan added in v0.4.0 

type CapacityCommitmentPlan string

Capacity commitment commitment plan.

func (CapacityCommitmentPlan) ElementType added in v0.4.0 

func (CapacityCommitmentPlan) ElementType() reflect.Type

func (CapacityCommitmentPlan) ToCapacityCommitmentPlanOutput added in v0.6.0 

func (e CapacityCommitmentPlan) ToCapacityCommitmentPlanOutput() CapacityCommitmentPlanOutput

func (CapacityCommitmentPlan) ToCapacityCommitmentPlanOutputWithContext added in v0.6.0 

func (e CapacityCommitmentPlan) ToCapacityCommitmentPlanOutputWithContext(ctx context.Context) CapacityCommitmentPlanOutput

func (CapacityCommitmentPlan) ToCapacityCommitmentPlanPtrOutput added in v0.6.0 

func (e CapacityCommitmentPlan) ToCapacityCommitmentPlanPtrOutput() CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlan) ToCapacityCommitmentPlanPtrOutputWithContext added in v0.6.0 

func (e CapacityCommitmentPlan) ToCapacityCommitmentPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlan) ToStringOutput added in v0.4.0 

func (e CapacityCommitmentPlan) ToStringOutput() pulumi.StringOutput

func (CapacityCommitmentPlan) ToStringOutputWithContext added in v0.4.0 

func (e CapacityCommitmentPlan) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CapacityCommitmentPlan) ToStringPtrOutput added in v0.4.0 

func (e CapacityCommitmentPlan) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentPlan) ToStringPtrOutputWithContext added in v0.4.0 

func (e CapacityCommitmentPlan) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentPlanInput added in v0.6.0 

type CapacityCommitmentPlanInput interface {
	pulumi.Input

	ToCapacityCommitmentPlanOutput() CapacityCommitmentPlanOutput
	ToCapacityCommitmentPlanOutputWithContext(context.Context) CapacityCommitmentPlanOutput
}

CapacityCommitmentPlanInput is an input type that accepts CapacityCommitmentPlanArgs and CapacityCommitmentPlanOutput values. You can construct a concrete instance of `CapacityCommitmentPlanInput` via: 

CapacityCommitmentPlanArgs{...}

type CapacityCommitmentPlanOutput added in v0.6.0 

type CapacityCommitmentPlanOutput struct{ *pulumi.OutputState }

func (CapacityCommitmentPlanOutput) ElementType added in v0.6.0 

func (CapacityCommitmentPlanOutput) ElementType() reflect.Type

func (CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanOutput added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanOutput() CapacityCommitmentPlanOutput

func (CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanOutputWithContext(ctx context.Context) CapacityCommitmentPlanOutput

func (CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanPtrOutput added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanPtrOutput() CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToCapacityCommitmentPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlanOutput) ToStringOutput added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToStringOutput() pulumi.StringOutput

func (CapacityCommitmentPlanOutput) ToStringOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CapacityCommitmentPlanOutput) ToStringPtrOutput added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentPlanOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentPlanPtrInput added in v0.6.0 

type CapacityCommitmentPlanPtrInput interface {
	pulumi.Input

	ToCapacityCommitmentPlanPtrOutput() CapacityCommitmentPlanPtrOutput
	ToCapacityCommitmentPlanPtrOutputWithContext(context.Context) CapacityCommitmentPlanPtrOutput
}

func CapacityCommitmentPlanPtr added in v0.6.0 

func CapacityCommitmentPlanPtr(v string) CapacityCommitmentPlanPtrInput

type CapacityCommitmentPlanPtrOutput added in v0.6.0 

type CapacityCommitmentPlanPtrOutput struct{ *pulumi.OutputState }

func (CapacityCommitmentPlanPtrOutput) Elem added in v0.6.0 

func (o CapacityCommitmentPlanPtrOutput) Elem() CapacityCommitmentPlanOutput

func (CapacityCommitmentPlanPtrOutput) ElementType added in v0.6.0 

func (CapacityCommitmentPlanPtrOutput) ElementType() reflect.Type

func (CapacityCommitmentPlanPtrOutput) ToCapacityCommitmentPlanPtrOutput added in v0.6.0 

func (o CapacityCommitmentPlanPtrOutput) ToCapacityCommitmentPlanPtrOutput() CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlanPtrOutput) ToCapacityCommitmentPlanPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanPtrOutput) ToCapacityCommitmentPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentPlanPtrOutput

func (CapacityCommitmentPlanPtrOutput) ToStringPtrOutput added in v0.6.0 

func (o CapacityCommitmentPlanPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentPlanPtrOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentPlanPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentRenewalPlan added in v0.4.0 

type CapacityCommitmentRenewalPlan 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.

func (CapacityCommitmentRenewalPlan) ElementType added in v0.4.0 

func (CapacityCommitmentRenewalPlan) ElementType() reflect.Type

func (CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanOutput added in v0.6.0 

func (e CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanOutput() CapacityCommitmentRenewalPlanOutput

func (CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanOutputWithContext added in v0.6.0 

func (e CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanOutputWithContext(ctx context.Context) CapacityCommitmentRenewalPlanOutput

func (CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanPtrOutput added in v0.6.0 

func (e CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanPtrOutput() CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanPtrOutputWithContext added in v0.6.0 

func (e CapacityCommitmentRenewalPlan) ToCapacityCommitmentRenewalPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlan) ToStringOutput added in v0.4.0 

func (e CapacityCommitmentRenewalPlan) ToStringOutput() pulumi.StringOutput

func (CapacityCommitmentRenewalPlan) ToStringOutputWithContext added in v0.4.0 

func (e CapacityCommitmentRenewalPlan) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CapacityCommitmentRenewalPlan) ToStringPtrOutput added in v0.4.0 

func (e CapacityCommitmentRenewalPlan) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentRenewalPlan) ToStringPtrOutputWithContext added in v0.4.0 

func (e CapacityCommitmentRenewalPlan) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentRenewalPlanInput added in v0.6.0 

type CapacityCommitmentRenewalPlanInput interface {
	pulumi.Input

	ToCapacityCommitmentRenewalPlanOutput() CapacityCommitmentRenewalPlanOutput
	ToCapacityCommitmentRenewalPlanOutputWithContext(context.Context) CapacityCommitmentRenewalPlanOutput
}

CapacityCommitmentRenewalPlanInput is an input type that accepts CapacityCommitmentRenewalPlanArgs and CapacityCommitmentRenewalPlanOutput values. You can construct a concrete instance of `CapacityCommitmentRenewalPlanInput` via: 

CapacityCommitmentRenewalPlanArgs{...}

type CapacityCommitmentRenewalPlanOutput added in v0.6.0 

type CapacityCommitmentRenewalPlanOutput struct{ *pulumi.OutputState }

func (CapacityCommitmentRenewalPlanOutput) ElementType added in v0.6.0 

func (CapacityCommitmentRenewalPlanOutput) ElementType() reflect.Type

func (CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanOutput() CapacityCommitmentRenewalPlanOutput

func (CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanOutputWithContext(ctx context.Context) CapacityCommitmentRenewalPlanOutput

func (CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanPtrOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanPtrOutput() CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToCapacityCommitmentRenewalPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlanOutput) ToStringOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToStringOutput() pulumi.StringOutput

func (CapacityCommitmentRenewalPlanOutput) ToStringOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (CapacityCommitmentRenewalPlanOutput) ToStringPtrOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentRenewalPlanOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentRenewalPlanPtrInput added in v0.6.0 

type CapacityCommitmentRenewalPlanPtrInput interface {
	pulumi.Input

	ToCapacityCommitmentRenewalPlanPtrOutput() CapacityCommitmentRenewalPlanPtrOutput
	ToCapacityCommitmentRenewalPlanPtrOutputWithContext(context.Context) CapacityCommitmentRenewalPlanPtrOutput
}

func CapacityCommitmentRenewalPlanPtr added in v0.6.0 

func CapacityCommitmentRenewalPlanPtr(v string) CapacityCommitmentRenewalPlanPtrInput

type CapacityCommitmentRenewalPlanPtrOutput added in v0.6.0 

type CapacityCommitmentRenewalPlanPtrOutput struct{ *pulumi.OutputState }

func (CapacityCommitmentRenewalPlanPtrOutput) Elem added in v0.6.0 

func (o CapacityCommitmentRenewalPlanPtrOutput) Elem() CapacityCommitmentRenewalPlanOutput

func (CapacityCommitmentRenewalPlanPtrOutput) ElementType added in v0.6.0 

func (CapacityCommitmentRenewalPlanPtrOutput) ElementType() reflect.Type

func (CapacityCommitmentRenewalPlanPtrOutput) ToCapacityCommitmentRenewalPlanPtrOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanPtrOutput) ToCapacityCommitmentRenewalPlanPtrOutput() CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlanPtrOutput) ToCapacityCommitmentRenewalPlanPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanPtrOutput) ToCapacityCommitmentRenewalPlanPtrOutputWithContext(ctx context.Context) CapacityCommitmentRenewalPlanPtrOutput

func (CapacityCommitmentRenewalPlanPtrOutput) ToStringPtrOutput added in v0.6.0 

func (o CapacityCommitmentRenewalPlanPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (CapacityCommitmentRenewalPlanPtrOutput) ToStringPtrOutputWithContext added in v0.6.0 

func (o CapacityCommitmentRenewalPlanPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type CapacityCommitmentState 

type CapacityCommitmentState struct {
}

func (CapacityCommitmentState) ElementType 

func (CapacityCommitmentState) ElementType() reflect.Type

type LookupCapacityCommitmentArgs added in v0.4.0 

type LookupCapacityCommitmentArgs struct {
	CapacityCommitmentId string  `pulumi:"capacityCommitmentId"`
	Location             string  `pulumi:"location"`
	Project              *string `pulumi:"project"`
}

type LookupCapacityCommitmentOutputArgs added in v0.8.0 

type LookupCapacityCommitmentOutputArgs struct {
	CapacityCommitmentId pulumi.StringInput    `pulumi:"capacityCommitmentId"`
	Location             pulumi.StringInput    `pulumi:"location"`
	Project              pulumi.StringPtrInput `pulumi:"project"`
}

func (LookupCapacityCommitmentOutputArgs) ElementType added in v0.8.0 

func (LookupCapacityCommitmentOutputArgs) ElementType() reflect.Type

type LookupCapacityCommitmentResult added in v0.4.0 

type LookupCapacityCommitmentResult struct {
	// The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.
	CommitmentEndTime string `pulumi:"commitmentEndTime"`
	// The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.
	CommitmentStartTime string `pulumi:"commitmentStartTime"`
	// For FAILED commitment plan, provides the reason of failure.
	FailureStatus StatusResponse `pulumi:"failureStatus"`
	// 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.
	MultiRegionAuxiliary bool `pulumi:"multiRegionAuxiliary"`
	// 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.
	Name string `pulumi:"name"`
	// Capacity commitment commitment plan.
	Plan string `pulumi:"plan"`
	// 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.
	RenewalPlan string `pulumi:"renewalPlan"`
	// Number of slots in this commitment.
	SlotCount string `pulumi:"slotCount"`
	// State of the commitment.
	State string `pulumi:"state"`
}

func LookupCapacityCommitment added in v0.4.0 

func LookupCapacityCommitment(ctx *pulumi.Context, args *LookupCapacityCommitmentArgs, opts ...pulumi.InvokeOption) (*LookupCapacityCommitmentResult, error)

Returns information about the capacity commitment.

type LookupCapacityCommitmentResultOutput added in v0.8.0 

type LookupCapacityCommitmentResultOutput struct{ *pulumi.OutputState }

func LookupCapacityCommitmentOutput added in v0.8.0 

func LookupCapacityCommitmentOutput(ctx *pulumi.Context, args LookupCapacityCommitmentOutputArgs, opts ...pulumi.InvokeOption) LookupCapacityCommitmentResultOutput

func (LookupCapacityCommitmentResultOutput) CommitmentEndTime added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) CommitmentEndTime() pulumi.StringOutput

The end of the current commitment period. It is applicable only for ACTIVE capacity commitments.

func (LookupCapacityCommitmentResultOutput) CommitmentStartTime added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) CommitmentStartTime() pulumi.StringOutput

The start of the current commitment period. It is applicable only for ACTIVE capacity commitments.

func (LookupCapacityCommitmentResultOutput) ElementType added in v0.8.0 

func (LookupCapacityCommitmentResultOutput) ElementType() reflect.Type

func (LookupCapacityCommitmentResultOutput) FailureStatus added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) FailureStatus() StatusResponseOutput

For FAILED commitment plan, provides the reason of failure.

func (LookupCapacityCommitmentResultOutput) MultiRegionAuxiliary added in v0.15.0 

func (o LookupCapacityCommitmentResultOutput) MultiRegionAuxiliary() pulumi.BoolOutput

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.

func (LookupCapacityCommitmentResultOutput) Name added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) Name() pulumi.StringOutput

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.

func (LookupCapacityCommitmentResultOutput) Plan added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) Plan() pulumi.StringOutput

Capacity commitment commitment plan.

func (LookupCapacityCommitmentResultOutput) RenewalPlan added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) RenewalPlan() pulumi.StringOutput

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.

func (LookupCapacityCommitmentResultOutput) SlotCount added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) SlotCount() pulumi.StringOutput

Number of slots in this commitment.

func (LookupCapacityCommitmentResultOutput) State added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) State() pulumi.StringOutput

State of the commitment.

func (LookupCapacityCommitmentResultOutput) ToLookupCapacityCommitmentResultOutput added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) ToLookupCapacityCommitmentResultOutput() LookupCapacityCommitmentResultOutput

func (LookupCapacityCommitmentResultOutput) ToLookupCapacityCommitmentResultOutputWithContext added in v0.8.0 

func (o LookupCapacityCommitmentResultOutput) ToLookupCapacityCommitmentResultOutputWithContext(ctx context.Context) LookupCapacityCommitmentResultOutput

type LookupReservationArgs added in v0.4.0 

type LookupReservationArgs struct {
	Location      string  `pulumi:"location"`
	Project       *string `pulumi:"project"`
	ReservationId string  `pulumi:"reservationId"`
}

type LookupReservationOutputArgs added in v0.8.0 

type LookupReservationOutputArgs struct {
	Location      pulumi.StringInput    `pulumi:"location"`
	Project       pulumi.StringPtrInput `pulumi:"project"`
	ReservationId pulumi.StringInput    `pulumi:"reservationId"`
}

func (LookupReservationOutputArgs) ElementType added in v0.8.0 

func (LookupReservationOutputArgs) ElementType() reflect.Type

type LookupReservationResult added in v0.4.0 

type LookupReservationResult struct {
	// Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
	Concurrency string `pulumi:"concurrency"`
	// Creation time of the reservation.
	CreationTime string `pulumi:"creationTime"`
	// If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
	IgnoreIdleSlots bool `pulumi:"ignoreIdleSlots"`
	// Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
	MultiRegionAuxiliary bool `pulumi:"multiRegionAuxiliary"`
	// The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_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.
	Name string `pulumi:"name"`
	// Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
	SlotCapacity string `pulumi:"slotCapacity"`
	// Last update time of the reservation.
	UpdateTime string `pulumi:"updateTime"`
}

func LookupReservation added in v0.4.0 

func LookupReservation(ctx *pulumi.Context, args *LookupReservationArgs, opts ...pulumi.InvokeOption) (*LookupReservationResult, error)

Returns information about the reservation.

type LookupReservationResultOutput added in v0.8.0 

type LookupReservationResultOutput struct{ *pulumi.OutputState }

func LookupReservationOutput added in v0.8.0 

func LookupReservationOutput(ctx *pulumi.Context, args LookupReservationOutputArgs, opts ...pulumi.InvokeOption) LookupReservationResultOutput

func (LookupReservationResultOutput) Concurrency added in v0.16.0 

func (o LookupReservationResultOutput) Concurrency() pulumi.StringOutput

Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.

func (LookupReservationResultOutput) CreationTime added in v0.8.0 

func (o LookupReservationResultOutput) CreationTime() pulumi.StringOutput

Creation time of the reservation.

func (LookupReservationResultOutput) ElementType added in v0.8.0 

func (LookupReservationResultOutput) ElementType() reflect.Type

func (LookupReservationResultOutput) IgnoreIdleSlots added in v0.8.0 

func (o LookupReservationResultOutput) IgnoreIdleSlots() pulumi.BoolOutput

If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.

func (LookupReservationResultOutput) MultiRegionAuxiliary added in v0.15.0 

func (o LookupReservationResultOutput) MultiRegionAuxiliary() pulumi.BoolOutput

Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.

func (LookupReservationResultOutput) Name added in v0.8.0 

func (o LookupReservationResultOutput) Name() pulumi.StringOutput

The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_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.

func (LookupReservationResultOutput) SlotCapacity added in v0.8.0 

func (o LookupReservationResultOutput) SlotCapacity() pulumi.StringOutput

Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

func (LookupReservationResultOutput) ToLookupReservationResultOutput added in v0.8.0 

func (o LookupReservationResultOutput) ToLookupReservationResultOutput() LookupReservationResultOutput

func (LookupReservationResultOutput) ToLookupReservationResultOutputWithContext added in v0.8.0 

func (o LookupReservationResultOutput) ToLookupReservationResultOutputWithContext(ctx context.Context) LookupReservationResultOutput

func (LookupReservationResultOutput) UpdateTime added in v0.8.0 

func (o LookupReservationResultOutput) UpdateTime() pulumi.StringOutput

Last update time of the reservation.

type Reservation 

type Reservation struct {
	pulumi.CustomResourceState

	// Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
	Concurrency pulumi.StringOutput `pulumi:"concurrency"`
	// Creation time of the reservation.
	CreationTime pulumi.StringOutput `pulumi:"creationTime"`
	// If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
	IgnoreIdleSlots pulumi.BoolOutput   `pulumi:"ignoreIdleSlots"`
	Location        pulumi.StringOutput `pulumi:"location"`
	// Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
	MultiRegionAuxiliary pulumi.BoolOutput `pulumi:"multiRegionAuxiliary"`
	// The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_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.
	Name    pulumi.StringOutput `pulumi:"name"`
	Project pulumi.StringOutput `pulumi:"project"`
	// The reservation ID. It 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.
	ReservationId pulumi.StringPtrOutput `pulumi:"reservationId"`
	// Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
	SlotCapacity pulumi.StringOutput `pulumi:"slotCapacity"`
	// Last update time of the reservation.
	UpdateTime pulumi.StringOutput `pulumi:"updateTime"`
}

Creates a new reservation resource.

func GetReservation 

func GetReservation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ReservationState, opts ...pulumi.ResourceOption) (*Reservation, error)

GetReservation gets an existing Reservation resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewReservation 

func NewReservation(ctx *pulumi.Context,
	name string, args *ReservationArgs, opts ...pulumi.ResourceOption) (*Reservation, error)

NewReservation registers a new resource with the given unique name, arguments, and options.

func (*Reservation) ElementType 

func (*Reservation) ElementType() reflect.Type

func (*Reservation) ToReservationOutput 

func (i *Reservation) ToReservationOutput() ReservationOutput

func (*Reservation) ToReservationOutputWithContext 

func (i *Reservation) ToReservationOutputWithContext(ctx context.Context) ReservationOutput

type ReservationArgs 

type ReservationArgs struct {
	// Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.
	Concurrency pulumi.StringPtrInput
	// If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.
	IgnoreIdleSlots pulumi.BoolPtrInput
	Location        pulumi.StringPtrInput
	// Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.
	MultiRegionAuxiliary pulumi.BoolPtrInput
	// The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_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.
	Name    pulumi.StringPtrInput
	Project pulumi.StringPtrInput
	// The reservation ID. It 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.
	ReservationId pulumi.StringPtrInput
	// Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
	SlotCapacity pulumi.StringPtrInput
}

The set of arguments for constructing a Reservation resource.

func (ReservationArgs) ElementType 

func (ReservationArgs) ElementType() reflect.Type

type ReservationInput 

type ReservationInput interface {
	pulumi.Input

	ToReservationOutput() ReservationOutput
	ToReservationOutputWithContext(ctx context.Context) ReservationOutput
}

type ReservationOutput 

type ReservationOutput struct{ *pulumi.OutputState }

func (ReservationOutput) Concurrency added in v0.19.0 

func (o ReservationOutput) Concurrency() pulumi.StringOutput

Maximum number of queries that are allowed to run concurrently in this reservation. This is a soft limit due to asynchronous nature of the system and various optimizations for small queries. Default value is 0 which means that concurrency will be automatically set based on the reservation size.

func (ReservationOutput) CreationTime added in v0.19.0 

func (o ReservationOutput) CreationTime() pulumi.StringOutput

Creation time of the reservation.

func (ReservationOutput) ElementType 

func (ReservationOutput) ElementType() reflect.Type

func (ReservationOutput) IgnoreIdleSlots added in v0.19.0 

func (o ReservationOutput) IgnoreIdleSlots() pulumi.BoolOutput

If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project. If true, a query or pipeline job using this reservation will execute with the slot capacity specified in the slot_capacity field at most.

func (ReservationOutput) Location added in v0.21.0 

func (o ReservationOutput) Location() pulumi.StringOutput

func (ReservationOutput) MultiRegionAuxiliary added in v0.19.0 

func (o ReservationOutput) MultiRegionAuxiliary() pulumi.BoolOutput

Applicable only for reservations located within one of the BigQuery multi-regions (US or EU). If set to true, this reservation is placed in the organization's secondary region which is designated for disaster recovery purposes. If false, this reservation is placed in the organization's default region.

func (ReservationOutput) Name added in v0.19.0 

func (o ReservationOutput) Name() pulumi.StringOutput

The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`. The reservation_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.

func (ReservationOutput) Project added in v0.21.0 

func (o ReservationOutput) Project() pulumi.StringOutput

func (ReservationOutput) ReservationId added in v0.21.0 

func (o ReservationOutput) ReservationId() pulumi.StringPtrOutput

The reservation ID. It 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.

func (ReservationOutput) SlotCapacity added in v0.19.0 

func (o ReservationOutput) SlotCapacity() pulumi.StringOutput

Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism. Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false. If the new reservation's slot capacity exceeds the project's slot capacity or if total slot capacity of the new reservation and its siblings exceeds the project's slot capacity, the request will fail with `google.rpc.Code.RESOURCE_EXHAUSTED`. NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.

func (ReservationOutput) ToReservationOutput 

func (o ReservationOutput) ToReservationOutput() ReservationOutput

func (ReservationOutput) ToReservationOutputWithContext 

func (o ReservationOutput) ToReservationOutputWithContext(ctx context.Context) ReservationOutput

func (ReservationOutput) UpdateTime added in v0.19.0 

func (o ReservationOutput) UpdateTime() pulumi.StringOutput

Last update time of the reservation.

type ReservationState 

type ReservationState struct {
}

func (ReservationState) ElementType 

func (ReservationState) ElementType() reflect.Type

type StatusResponse 

type StatusResponse struct {
	// The status code, which should be an enum value of google.rpc.Code.
	Code int `pulumi:"code"`
	// A list of messages that carry the error details. There is a common set of message types for APIs to use.
	Details []map[string]string `pulumi:"details"`
	// 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.
	Message string `pulumi:"message"`
}

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

type StatusResponseOutput 

type StatusResponseOutput struct{ *pulumi.OutputState }

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

func (StatusResponseOutput) Code 

func (o StatusResponseOutput) Code() pulumi.IntOutput

The status code, which should be an enum value of google.rpc.Code.

func (StatusResponseOutput) Details 

func (o StatusResponseOutput) Details() pulumi.StringMapArrayOutput

A list of messages that carry the error details. There is a common set of message types for APIs to use.

func (StatusResponseOutput) ElementType 

func (StatusResponseOutput) ElementType() reflect.Type

func (StatusResponseOutput) Message 

func (o StatusResponseOutput) Message() pulumi.StringOutput

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.

func (StatusResponseOutput) ToStatusResponseOutput 

func (o StatusResponseOutput) ToStatusResponseOutput() StatusResponseOutput

func (StatusResponseOutput) ToStatusResponseOutputWithContext 

func (o StatusResponseOutput) ToStatusResponseOutputWithContext(ctx context.Context) StatusResponseOutput

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.