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
CONCURRENCY_FIELD_NUMBER
public static final int CONCURRENCY_FIELD_NUMBER
Field Value
CREATION_TIME_FIELD_NUMBER
public static final int CREATION_TIME_FIELD_NUMBER
Field Value
IGNORE_IDLE_SLOTS_FIELD_NUMBER
public static final int IGNORE_IDLE_SLOTS_FIELD_NUMBER
Field Value
MULTI_REGION_AUXILIARY_FIELD_NUMBER
public static final int MULTI_REGION_AUXILIARY_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
SLOT_CAPACITY_FIELD_NUMBER
public static final int SLOT_CAPACITY_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Reservation getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Reservation.Builder newBuilder()
Returns
newBuilder(Reservation prototype)
public static Reservation.Builder newBuilder(Reservation prototype)
Parameter
Returns
public static Reservation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Reservation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Reservation parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Reservation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Reservation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Reservation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Reservation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Reservation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Reservation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Reservation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Reservation> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getConcurrency()
public long getConcurrency()
Maximum number of queries that are allowed to run concurrently in this
reservation. This is a soft limit due to asynchronous nature of the system
and various optimizations for small queries.
Default value is 0 which means that concurrency will be automatically set
based on the reservation size.
int64 concurrency = 16;
| 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];
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()
Returns
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;
| 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.
bool multi_region_auxiliary = 14;
| 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;
| 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;
getParserForType()
public Parser<Reservation> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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 the new reservation's slot capacity exceeds the project's slot capacity
or if total slot capacity of the new reservation and its siblings exceeds
the project's slot capacity, 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;
| Type | Description |
long | The slotCapacity.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUpdateTime()
public Timestamp getUpdateTime()
Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreationTime()
public boolean hasCreationTime()
Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Reservation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Reservation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Reservation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
