# BigQuery Reservation v1 API - Class Reservation (2.12.0)

2.12.0 (latest) 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0

    public sealed class Reservation : IMessage<Reservation>, IEquatable<Reservation>, IDeepCloneable<Reservation>, IBufferMessage, IMessage

Reference documentation and code samples for the BigQuery Reservation v1 API class Reservation.

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

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> Reservation

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Reservation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Reservation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Reservation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.BigQuery.Reservation.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1)

## Assembly

Google.Cloud.BigQuery.Reservation.V1.dll

## Constructors

### Reservation()

    public Reservation()

### Reservation(Reservation)

    public Reservation(Reservation other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation` |

## Properties

### Autoscale

    public Reservation.Types.Autoscale Autoscale { get; set; }

Optional. The configuration parameters for the auto scaling feature.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservationhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Types.Autoscale` |   |

### Concurrency

    public long Concurrency { get; set; }

Optional. Job concurrency target which sets a soft upper bound on the
number of jobs that can run concurrently in this reservation. This is a
soft target due to asynchronous nature of the system and various
optimizations for small queries. Default value is 0 which means that
concurrency target will be automatically computed by the system. NOTE: this
field is exposed as target job concurrency in the Information Schema, DDL
and BigQuery CLI.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### CreationTime

    public Timestamp CreationTime { get; set; }

Output only. Creation time of the reservation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |

### Edition

    public Edition Edition { get; set; }

Optional. Edition of the reservation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Edition` |   |

### HasMaxSlots

    public bool HasMaxSlots { get; }

Gets whether the "max_slots" field is set

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### IgnoreIdleSlots

    public bool IgnoreIdleSlots { get; set; }

Optional. 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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Labels

    public MapField<string, string> Labels { get; }

Optional. The labels associated with this reservation. You can use these
to organize and group your reservations.
You can set this property when you create or update a reservation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### MaxSlots

    public long MaxSlots { get; set; }

Optional. The overall max slots for the reservation, covering slot_capacity
(baseline), idle slots (if ignore_idle_slots 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 max_slots value. However, in terms of
autoscale.current_slots (which accounts for the additional added slots), it
will never exceed the max_slots - baseline.

This field must be set together with the scaling_mode enum value,
otherwise the request will be rejected with error code
`google.rpc.Code.INVALID_ARGUMENT`.

If the max_slots and scaling_mode 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 max_slots is 1000 and scaling_mode 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 max_slots is 1000, scaling_mode 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 max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the
output, the autoscaler field will be null.

If the max_slots and scaling_mode are set, then the ignore_idle_slots field
must be aligned with the scaling_mode enum value.(See details in
ScalingMode comments). Otherwise the request will be rejected with
error code `google.rpc.Code.INVALID_ARGUMENT`.

Please note, the max_slots is for user to manage the part of slots greater
than the baseline. Therefore, we don't allow users to set max_slots smaller
or equal to the baseline as it will not be meaningful. If the field is
present and slot_capacity\>=max_slots, requests will be rejected with error
code `google.rpc.Code.INVALID_ARGUMENT`.

Please note that if max_slots is set to 0, we will treat it as unset.
Customers can set max_slots to 0 and set scaling_mode to
SCALING_MODE_UNSPECIFIED to disable the max_slots feature.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MultiRegionAuxiliary

    [Obsolete]
    public bool MultiRegionAuxiliary { get; set; }

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.

NOTE: this is a preview feature. Project must be allow-listed in order to
set this field.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Name

    public string Name { get; set; }

Identifier. 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.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OriginalPrimaryLocation

    public string OriginalPrimaryLocation { get; set; }

Output only. The location where the reservation was originally created.
This is set only during the failover reservation's creation. All billing
charges for the failover reservation will be applied to this location.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### OriginalPrimaryLocationAsLocationName

    public LocationName OriginalPrimaryLocationAsLocationName { get; set; }

[LocationName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html)-typed view over the [OriginalPrimaryLocation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation#Google_Cloud_BigQuery_Reservation_V1_Reservation_OriginalPrimaryLocation) resource name
property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html` |   |

### PrimaryLocation

    public string PrimaryLocation { get; set; }

Output only. The current location of the reservation's primary replica.
This field is only set for reservations using the managed disaster recovery
feature.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### PrimaryLocationAsLocationName

    public LocationName PrimaryLocationAsLocationName { get; set; }

[LocationName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html)-typed view over the [PrimaryLocation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation#Google_Cloud_BigQuery_Reservation_V1_Reservation_PrimaryLocation) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html` |   |

### ReplicationStatus

    public Reservation.Types.ReplicationStatus ReplicationStatus { get; set; }

Output only. The Disaster Recovery(DR) replication status of the
reservation. This is only available for the primary replicas of DR/failover
reservations and provides information about the both the staleness of the
secondary and the last error encountered while trying to replicate changes
from the primary to the secondary. If this field is blank, it means that
the reservation is either not a DR reservation or the reservation is a DR
secondary or that any replication operations on the reservation have
succeeded.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservationhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Types.ReplicationStatus` |   |

### ReservationGroup

    public string ReservationGroup { get; set; }

Optional. The reservation group that this reservation belongs to.
You can set this property when you create or update a reservation.
Reservations do not need to belong to a reservation group.
Format:
projects/{project}/locations/{location}/reservationGroups/{reservation_group}
or just {reservation_group}

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ReservationName

    public ReservationName ReservationName { get; set; }

[ReservationName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.ReservationName)-typed view over the [Name](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation#Google_Cloud_BigQuery_Reservation_V1_Reservation_Name) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.ReservationName` |   |

### ScalingMode

    public Reservation.Types.ScalingMode ScalingMode { get; set; }

Optional. The scaling mode for the reservation.
If the field is present but max_slots is not present, requests will be
rejected with error code `google.rpc.Code.INVALID_ARGUMENT`.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservationhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation.Types.ScalingMode` |   |

### SchedulingPolicy

    public SchedulingPolicy SchedulingPolicy { get; set; }

Optional. The scheduling policy to use for jobs and queries running under
this reservation. The scheduling policy controls how the reservation's
resources are distributed.

This feature is not yet generally available.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.SchedulingPolicy` |   |

### SecondaryLocation

    public string SecondaryLocation { get; set; }

Optional. 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).

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### SecondaryLocationAsLocationName

    public LocationName SecondaryLocationAsLocationName { get; set; }

[LocationName](https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html)-typed view over the [SecondaryLocation](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.Reservation.V1/latest/Google.Cloud.BigQuery.Reservation.V1.Reservation#Google_Cloud_BigQuery_Reservation_V1_Reservation_SecondaryLocation) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Api.Gax/latest/Google.Api.Gax.ResourceNames.LocationName.html` |   |

### SlotCapacity

    public long SlotCapacity { get; set; }

Optional. Baseline 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, or autoscaling is enabled.

The total slot_capacity of the reservation and its siblings
may exceed the total slot_count of capacity commitments. In that case, the
exceeding slots will be charged with the autoscale SKU. You can increase
the number of baseline slots in a reservation every few minutes. If you
want to decrease your baseline slots, you are limited to once an hour if
you have recently changed your baseline slot capacity and your baseline
slots exceed your committed slots. Otherwise, you can decrease your
baseline slots every few minutes.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### UpdateTime

    public Timestamp UpdateTime { get; set; }

Output only. Last update time of the reservation.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Timestamp.html` |   |