com.google.cloud.bigquery.reservation.v1

Class Reservation

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.bigquery.reservation.v1.Reservation

All Implemented Interfaces:

ReservationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Reservation
extends com.google.protobuf.GeneratedMessageV3
implements ReservationOrBuilder

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Reservation.Autoscale Auto scaling settings.
static interface	Reservation.AutoscaleOrBuilder
static class	Reservation.Builder A reservation is a mechanism used to guarantee slots to users.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTOSCALE_FIELD_NUMBER
static int	CONCURRENCY_FIELD_NUMBER
static int	CREATION_TIME_FIELD_NUMBER
static int	EDITION_FIELD_NUMBER
static int	IGNORE_IDLE_SLOTS_FIELD_NUMBER
static int	MULTI_REGION_AUXILIARY_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	SLOT_CAPACITY_FIELD_NUMBER
static int	UPDATE_TIME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
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.
static Reservation	getDefaultInstance()
Reservation	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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`.
com.google.protobuf.Parser<Reservation>	getParserForType()
int	getSerializedSize()
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.
int	hashCode()
boolean	hasUpdateTime() Output only.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Reservation.Builder	newBuilder()
static Reservation.Builder	newBuilder(Reservation prototype)
Reservation.Builder	newBuilderForType()
protected Reservation.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Reservation	parseDelimitedFrom(InputStream input)
static Reservation	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Reservation	parseFrom(byte[] data)
static Reservation	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Reservation	parseFrom(ByteBuffer data)
static Reservation	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Reservation	parseFrom(com.google.protobuf.ByteString data)
static Reservation	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Reservation	parseFrom(com.google.protobuf.CodedInputStream input)
static Reservation	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Reservation	parseFrom(InputStream input)
static Reservation	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Reservation>	parser()
Reservation.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

SLOT_CAPACITY_FIELD_NUMBER

public static final int SLOT_CAPACITY_FIELD_NUMBER

See Also:

Constant Field Values

IGNORE_IDLE_SLOTS_FIELD_NUMBER

public static final int IGNORE_IDLE_SLOTS_FIELD_NUMBER

See Also:

Constant Field Values

AUTOSCALE_FIELD_NUMBER

public static final int AUTOSCALE_FIELD_NUMBER

See Also:

Constant Field Values

CONCURRENCY_FIELD_NUMBER

public static final int CONCURRENCY_FIELD_NUMBER

See Also:

Constant Field Values

CREATION_TIME_FIELD_NUMBER

public static final int CREATION_TIME_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

See Also:

Constant Field Values

MULTI_REGION_AUXILIARY_FIELD_NUMBER

public static final int MULTI_REGION_AUXILIARY_FIELD_NUMBER

See Also:

Constant Field Values

EDITION_FIELD_NUMBER

public static final int EDITION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

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;

Specified by:

getName in interface ReservationOrBuilder

Returns:

The name.

getNameBytes

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

Specified by:

getNameBytes in interface ReservationOrBuilder

Returns:

The bytes for name.

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;

Specified by:

getSlotCapacity in interface ReservationOrBuilder

Returns:

The slotCapacity.

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;

Specified by:

getIgnoreIdleSlots in interface ReservationOrBuilder

Returns:

The ignoreIdleSlots.

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;

Specified by:

hasAutoscale in interface ReservationOrBuilder

Returns:

Whether the autoscale field is set.

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;

Specified by:

getAutoscale in interface ReservationOrBuilder

Returns:

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;

Specified by:

getAutoscaleOrBuilder in interface ReservationOrBuilder

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;

Specified by:

getConcurrency in interface ReservationOrBuilder

Returns:

The concurrency.

hasCreationTime

public boolean hasCreationTime()

 Output only. Creation time of the reservation.
 

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

Specified by:

hasCreationTime in interface ReservationOrBuilder

Returns:

Whether the creationTime field is set.

getCreationTime

public com.google.protobuf.Timestamp getCreationTime()

 Output only. Creation time of the reservation.
 

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

Specified by:

getCreationTime in interface ReservationOrBuilder

Returns:

The creationTime.

getCreationTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()

 Output only. Creation time of the reservation.
 

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

Specified by:

getCreationTimeOrBuilder in interface ReservationOrBuilder

hasUpdateTime

public boolean hasUpdateTime()

 Output only. Last update time of the reservation.
 

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

Specified by:

hasUpdateTime in interface ReservationOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime

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

Specified by:

getUpdateTime in interface ReservationOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder

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

Specified by:

getUpdateTimeOrBuilder in interface ReservationOrBuilder

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;

Specified by:

getMultiRegionAuxiliary in interface ReservationOrBuilder

Returns:

The multiRegionAuxiliary.

getEditionValue

public int getEditionValue()

 Edition of the reservation.
 

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

Specified by:

getEditionValue in interface ReservationOrBuilder

Returns:

The enum numeric value on the wire for edition.

getEdition

public Edition getEdition()

 Edition of the reservation.
 

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

Specified by:

getEdition in interface ReservationOrBuilder

Returns:

The edition.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Reservation parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Reservation parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Reservation parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static Reservation parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Reservation parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static Reservation parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static Reservation parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public Reservation.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Reservation.Builder newBuilder()

newBuilder

public static Reservation.Builder newBuilder(Reservation prototype)

toBuilder

public Reservation.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Reservation.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Reservation getDefaultInstance()

parser

public static com.google.protobuf.Parser<Reservation> parser()

getParserForType

public com.google.protobuf.Parser<Reservation> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Reservation getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder