com.google.cloud.bigquery.reservation.v1

Interface ReservationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Reservation, Reservation.Builder

public interface ReservationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Reservation.Autoscale	getAutoscale() The configuration parameters for the auto scaling feature.
Reservation.AutoscaleOrBuilder	getAutoscaleOrBuilder() The configuration parameters for the auto scaling feature.
long	getConcurrency() Job concurrency target which sets a soft upper bound on the number of jobs that can run concurrently in this reservation.
com.google.protobuf.Timestamp	getCreationTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreationTimeOrBuilder() Output only.
Edition	getEdition() Edition of the reservation.
int	getEditionValue() Edition of the reservation.
boolean	getIgnoreIdleSlots() If false, any query or pipeline job using this reservation will use idle slots from other reservations within the same admin project.
boolean	getMultiRegionAuxiliary() Applicable only for reservations located within one of the BigQuery multi-regions (US or EU).
String	getName() The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.
com.google.protobuf.ByteString	getNameBytes() The resource name of the reservation, e.g., `projects/*/locations/*/reservations/team1-prod`.
long	getSlotCapacity() Minimum slots available to this reservation.
com.google.protobuf.Timestamp	getUpdateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getUpdateTimeOrBuilder() Output only.
boolean	hasAutoscale() The configuration parameters for the auto scaling feature.
boolean	hasCreationTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 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.
 

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 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.
 

string name = 1;

Returns:

The bytes for name.

getSlotCapacity

long getSlotCapacity()

 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 total slot_capacity of the reservation and its siblings
 exceeds the total slot_count of all capacity commitments, 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.
 

int64 slot_capacity = 2;

Returns:

The slotCapacity.

getIgnoreIdleSlots

boolean getIgnoreIdleSlots()

 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.
 

bool ignore_idle_slots = 4;

Returns:

The ignoreIdleSlots.

hasAutoscale

boolean hasAutoscale()

 The configuration parameters for the auto scaling feature. Note this is an
 alpha feature.
 

.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;

Returns:

Whether the autoscale field is set.

getAutoscale

Reservation.Autoscale getAutoscale()

 The configuration parameters for the auto scaling feature. Note this is an
 alpha feature.
 

.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;

Returns:

The autoscale.

getAutoscaleOrBuilder

Reservation.AutoscaleOrBuilder getAutoscaleOrBuilder()

 The configuration parameters for the auto scaling feature. Note this is an
 alpha feature.
 

.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;

getConcurrency

long getConcurrency()

 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 BQ CLI.
 

int64 concurrency = 16;

Returns:

The concurrency.

hasCreationTime

boolean hasCreationTime()

 Output only. Creation time of the reservation.
 

.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the creationTime field is set.

getCreationTime

com.google.protobuf.Timestamp getCreationTime()

 Output only. Creation time of the reservation.
 

.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The creationTime.

getCreationTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()

 Output only. Creation time of the reservation.
 

.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasUpdateTime

boolean hasUpdateTime()

 Output only. Last update time of the reservation.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.Timestamp getUpdateTime()

 Output only. Last update time of the reservation.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

 Output only. Last update time of the reservation.
 

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

getMultiRegionAuxiliary

boolean getMultiRegionAuxiliary()

 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.
 

bool multi_region_auxiliary = 14;

Returns:

The multiRegionAuxiliary.

getEditionValue

int getEditionValue()

 Edition of the reservation.
 

.google.cloud.bigquery.reservation.v1.Edition edition = 17;

Returns:

The enum numeric value on the wire for edition.

getEdition

Edition getEdition()

 Edition of the reservation.
 

.google.cloud.bigquery.reservation.v1.Edition edition = 17;

Returns:

The edition.