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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AUTOSCALE_FIELD_NUMBER
public static final int AUTOSCALE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONCURRENCY_FIELD_NUMBER
public static final int CONCURRENCY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATION_TIME_FIELD_NUMBER
public static final int CREATION_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EDITION_FIELD_NUMBER
public static final int EDITION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IGNORE_IDLE_SLOTS_FIELD_NUMBER
public static final int IGNORE_IDLE_SLOTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
MULTI_REGION_AUXILIARY_FIELD_NUMBER
public static final int MULTI_REGION_AUXILIARY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ORIGINAL_PRIMARY_LOCATION_FIELD_NUMBER
public static final int ORIGINAL_PRIMARY_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIMARY_LOCATION_FIELD_NUMBER
public static final int PRIMARY_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SECONDARY_LOCATION_FIELD_NUMBER
public static final int SECONDARY_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SLOT_CAPACITY_FIELD_NUMBER
public static final int SLOT_CAPACITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Reservation getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Reservation.Builder newBuilder()
newBuilder(Reservation prototype)
public static Reservation.Builder newBuilder(Reservation prototype)
public static Reservation parseDelimitedFrom(InputStream input)
public static Reservation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Reservation parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Reservation parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(CodedInputStream input)
public static Reservation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(InputStream input)
public static Reservation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Reservation parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Reservation> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAutoscale()
public Reservation.Autoscale getAutoscale()
The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
getAutoscaleOrBuilder()
public Reservation.AutoscaleOrBuilder getAutoscaleOrBuilder()
The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
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 BigQuery CLI.
int64 concurrency = 16;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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];
getDefaultInstanceForType()
public Reservation getDefaultInstanceForType()
getEdition()
public Edition getEdition()
Edition of the reservation.
.google.cloud.bigquery.reservation.v1.Edition edition = 17;
| Returns |
| Type |
Description |
Edition |
The edition.
|
getEditionValue()
public int getEditionValue()
Edition of the reservation.
.google.cloud.bigquery.reservation.v1.Edition edition = 17;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
The multiRegionAuxiliary.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getOriginalPrimaryLocation()
public String getOriginalPrimaryLocation()
Optional. 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.
string original_primary_location = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The originalPrimaryLocation.
|
getOriginalPrimaryLocationBytes()
public ByteString getOriginalPrimaryLocationBytes()
Optional. 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.
string original_primary_location = 20 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for originalPrimaryLocation.
|
getParserForType()
public Parser<Reservation> getParserForType()
Overrides
getPrimaryLocation()
public String getPrimaryLocation()
Optional. The current location of the reservation's primary replica. This
field is only set for reservations using the managed disaster recovery
feature.
string primary_location = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The primaryLocation.
|
getPrimaryLocationBytes()
public ByteString getPrimaryLocationBytes()
Optional. The current location of the reservation's primary replica. This
field is only set for reservations using the managed disaster recovery
feature.
string primary_location = 18 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for primaryLocation.
|
getSecondaryLocation()
public String getSecondaryLocation()
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).
string secondary_location = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The secondaryLocation.
|
getSecondaryLocationBytes()
public ByteString getSecondaryLocationBytes()
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).
string secondary_location = 19 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for secondaryLocation.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getSlotCapacity()
public long getSlotCapacity()
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.
If edition is EDITION_UNSPECIFIED and 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.
If edition is any value but EDITION_UNSPECIFIED, then the above requirement
is not needed. 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.
int64 slot_capacity = 2;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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];
hasAutoscale()
public boolean hasAutoscale()
The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Reservation.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Reservation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Reservation.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
