Class Reservation (2.20.0)

public final class Reservation extends GeneratedMessageV3 implements ReservationOrBuilder

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

Protobuf type google.cloud.bigquery.reservation.v1.Reservation

Static Fields

AUTOSCALE_FIELD_NUMBER

public static final int AUTOSCALE_FIELD_NUMBER
Field Value
TypeDescription
int

CONCURRENCY_FIELD_NUMBER

public static final int CONCURRENCY_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

EDITION_FIELD_NUMBER

public static final int EDITION_FIELD_NUMBER
Field Value
TypeDescription
int

IGNORE_IDLE_SLOTS_FIELD_NUMBER

public static final int IGNORE_IDLE_SLOTS_FIELD_NUMBER
Field Value
TypeDescription
int

MULTI_REGION_AUXILIARY_FIELD_NUMBER

public static final int MULTI_REGION_AUXILIARY_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

SLOT_CAPACITY_FIELD_NUMBER

public static final int SLOT_CAPACITY_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Reservation getDefaultInstance()
Returns
TypeDescription
Reservation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Reservation.Builder newBuilder()
Returns
TypeDescription
Reservation.Builder

newBuilder(Reservation prototype)

public static Reservation.Builder newBuilder(Reservation prototype)
Parameter
NameDescription
prototypeReservation
Returns
TypeDescription
Reservation.Builder

parseDelimitedFrom(InputStream input)

public static Reservation parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Reservation parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Reservation parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Reservation parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Reservation parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Reservation parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Reservation
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Reservation> parser()
Returns
TypeDescription
Parser<Reservation>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAutoscale()

public 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
TypeDescription
Reservation.Autoscale

The autoscale.

getAutoscaleOrBuilder()

public 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;

Returns
TypeDescription
Reservation.AutoscaleOrBuilder

getConcurrency()

public 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
TypeDescription
long

The concurrency.

getCreationTime()

public Timestamp getCreationTime()

Output only. Creation time of the reservation.

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

Returns
TypeDescription
Timestamp

The creationTime.

getCreationTimeOrBuilder()

public TimestampOrBuilder getCreationTimeOrBuilder()

Output only. Creation time of the reservation.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Reservation getDefaultInstanceForType()
Returns
TypeDescription
Reservation

getEdition()

public Edition getEdition()

Edition of the reservation.

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

Returns
TypeDescription
Edition

The edition.

getEditionValue()

public int getEditionValue()

Edition of the reservation.

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

Returns
TypeDescription
int

The enum numeric value on the wire for edition.

getIgnoreIdleSlots()

public 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
TypeDescription
boolean

The ignoreIdleSlots.

getMultiRegionAuxiliary()

public 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
TypeDescription
boolean

The multiRegionAuxiliary.

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Reservation> getParserForType()
Returns
TypeDescription
Parser<Reservation>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSlotCapacity()

public 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
TypeDescription
long

The slotCapacity.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Last update time of the reservation.

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

Returns
TypeDescription
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Last update time of the reservation.

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

Returns
TypeDescription
TimestampOrBuilder

hasAutoscale()

public 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
TypeDescription
boolean

Whether the autoscale field is set.

hasCreationTime()

public boolean hasCreationTime()

Output only. Creation time of the reservation.

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

Returns
TypeDescription
boolean

Whether the creationTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Last update time of the reservation.

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

Returns
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Reservation.Builder newBuilderForType()
Returns
TypeDescription
Reservation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Reservation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Reservation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Reservation.Builder toBuilder()
Returns
TypeDescription
Reservation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException