ReservationArgs class

The set of arguments for Reservation. The set of arguments for Reservation.

Constructors

ReservationArgs({Input<ReservationAutoscale?>? autoscale, Input<int?>? concurrency, Input<String?>? deletionPolicy, Input<String?>? edition, Input<bool?>? ignoreIdleSlots, Input<Map<String, String>?>? labels, Input<String?>? location, Input<int?>? maxSlots, Input<String?>? name, Input<String?>? project, Input<String?>? reservationGroup, Input<String?>? scalingMode, Input<String?>? secondaryLocation, required Input<int> slotCapacity})

Creates a new ReservationArgs. autoscale The configuration parameters for the auto scaling feature. concurrency 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. deletionPolicy Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. edition The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS ignoreIdleSlots If false, any query using this reservation will use idle slots from other reservations within labels The labels associated with this reservation. You can use these to location The geographic location where the transfer config should reside. maxSlots (Optional, Beta) name The name of the reservation. This field must only contain alphanumeric characters or dash. project The ID of the project in which the resource belongs. reservationGroup The reservation group that this reservation belongs to. scalingMode (Optional, Beta) secondaryLocation The current location of the reservation's secondary replica. This field is only set for slotCapacity Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the

const

ReservationArgs.fromMap(Map<String, dynamic> map)

factory

Properties

autoscale → Input<ReservationAutoscale?>?

The configuration parameters for the auto scaling feature. Structure is documented below.

final

concurrency → Input<int?>?

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.

final

deletionPolicy → Input<String?>?

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

final

edition → Input<String?>?

The edition type. Valid values are STANDARD, ENTERPRISE, ENTERPRISE_PLUS

final

hashCode → int

The hash code for this object.

no setter, inherited

ignoreIdleSlots → Input<bool?>?

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.

final

labels → Input<Map<String, String>?>?

The labels associated with this reservation. You can use these to organize and group your reservations.

final

location → Input<String?>?

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

final

maxSlots → Input<int?>?

(Optional, Beta) The overall max slots for the reservation, covering slotCapacity (baseline), idle slots (if ignoreIdleSlots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the maxSlots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the maxSlots - baseline. This field must be set together with the scalingMode enum value, otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. If the maxSlots and scalingMode are set, the autoscale or autoscale.max_slots field must be unset. Otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the maxSlots is 1000 and scalingMode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000. If the maxSlots is 1000, scalingMode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700. If the maxSlots is 1000, scalingMode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null. If the maxSlots and scalingMode are set, then the ignoreIdleSlots field must be aligned with the scalingMode enum value.(See details in ScalingMode comments). Otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. Please note, the maxSlots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set maxSlots smaller or equal to the baseline as it will not be meaningful. If the field is present and slotCapacity>=maxSlots, requests will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. Please note that if maxSlots is set to 0, we will treat it as unset. Customers can set maxSlots to 0 and set scalingMode to SCALING_MODE_UNSPECIFIED to disable the maxSlots feature.

final

name → Input<String?>?

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

final

project → Input<String?>?

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

final

reservationGroup → Input<String?>?

The reservation group that this reservation belongs to.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scalingMode → Input<String?>?

(Optional, Beta) The scaling mode for the reservation. If the field is present but maxSlots is not present, requests will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. Enum values: SCALING_MODE_UNSPECIFIED: Default value of ScalingMode. AUTOSCALE_ONLY: The reservation will scale up only using slots from autoscaling. It will not use any idle slots even if there may be some available. The upper limit that autoscaling can scale up to will be maxSlots - baseline. For example, if maxSlots is 1000, baseline is 200 and customer sets ScalingMode to AUTOSCALE_ONLY, then autoscalerg will scale up to 800 slots and no idle slots will be used. Please note, in this mode, the ignoreIdleSlots field must be set to true. Otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. IDLE_SLOTS_ONLY: The reservation will scale up using only idle slots contributed by other reservations or from unassigned commitments. If no idle slots are available it will not scale up further. If the idle slots which it is using are reclaimed by the contributing reservation(s) it may be forced to scale down. The max idle slots the reservation can be maxSlots - baseline capacity. For example, if maxSlots is 1000, baseline is 200 and customer sets ScalingMode to IDLE_SLOTS_ONLY, 1. if there are 1000 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 700 slots with 200 baseline and 300 idle slots. Please note, in this mode, the reservation might not be able to scale up to maxSlots. Please note, in this mode, the ignoreIdleSlots field must be set to false. Otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT ALL_SLOTS: The reservation will scale up using all slots available to it. It will use idle slots contributed by other reservations or from unassigned commitments first. If no idle slots are available it will scale up using autoscaling. For example, if maxSlots is 1000, baseline is 200 and customer sets ScalingMode to ALL_SLOTS, 1. if there are 800 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline and 800 idle slots. 2. if there are 500 idle slots available in other reservations, the reservation will scale up to 1000 slots with 200 baseline, 500 idle slots and 300 autoscaling slots. 3. if there are no idle slots available in other reservations, it will scale up to 1000 slots with 200 baseline and 800 autoscaling slots. Please note, in this mode, the ignoreIdleSlots field must be set to false. Otherwise the request will be rejected with error code google.rpc.Code.INVALID_ARGUMENT. Possible values are: SCALING_MODE_UNSPECIFIED, AUTOSCALE_ONLY, IDLE_SLOTS_ONLY, ALL_SLOTS.

final

secondaryLocation → Input<String?>?

The current location of the reservation's secondary replica. This field is only set for reservations using the managed disaster recovery feature. Users can set this in create reservation calls to create a failover reservation or in update reservation calls to convert a non-failover reservation to a failover reservation(or vice versa).

final

slotCapacity → Input<int>

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.

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited