Class Reservation

A reservation is a mechanism used to guarantee BigQuery slots to users.

To get more information about Reservation, see:

• API documentation
• How-to Guides
• Introduction to Reservations

Example Usage - Bigquery Reservation Basic

using Pulumi;
using Gcp = Pulumi.Gcp;

class MyStack : Stack
{
public MyStack()
{
    var reservation = new Gcp.BigQuery.Reservation("reservation", new Gcp.BigQuery.ReservationArgs
    {
        Location = "asia-northeast1",
        SlotCapacity = 0,
        IgnoreIdleSlots = false,
    });
}

}

Inheritance

System.Object

Resource

CustomResource

Reservation

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.BigQuery

Assembly: Pulumi.Gcp.dll

Syntax

public class Reservation : CustomResource

Constructors

Reservation(String, ReservationArgs, CustomResourceOptions)

Create a Reservation resource with the given unique name, arguments, and options.

Declaration

public Reservation(string name, ReservationArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
ReservationArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

IgnoreIdleSlots

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

Declaration

public Output<bool?> IgnoreIdleSlots { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Location

The geographic location where the transfer config should reside. Examples: US, EU, asia-northeast1. The default value is US.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

Name

The name of the reservation. This field must only contain alphanumeric characters or dash.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

Project

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

SlotCapacity

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 ignoreIdleSlots is set to false.

Declaration

public Output<int> SlotCapacity { get; }

Property Value

Type	Description
Output<System.Int32>

Methods

Get(String, Input<String>, ReservationState, CustomResourceOptions)

Get an existing Reservation resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static Reservation Get(string name, Input<string> id, ReservationState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
ReservationState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
Reservation