- 2.74.0 (latest)
- 2.73.0
- 2.71.0
- 2.69.0
- 2.68.0
- 2.65.0
- 2.64.0
- 2.63.0
- 2.61.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.6
- 2.3.1
- 2.2.7
- 2.1.4
public static final class Reservation.Builder extends GeneratedMessageV3.Builder<Reservation.Builder> implements ReservationOrBuilderA reservation is a mechanism used to guarantee slots to users.
Protobuf type google.cloud.bigquery.reservation.v1.Reservation
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Reservation.BuilderImplements
ReservationOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Reservation.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
build()
public Reservation build()| Returns | |
|---|---|
| Type | Description |
Reservation |
|
buildPartial()
public Reservation buildPartial()| Returns | |
|---|---|
| Type | Description |
Reservation |
|
clear()
public Reservation.Builder clear()| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearAutoscale()
public Reservation.Builder clearAutoscale()The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearConcurrency()
public Reservation.Builder clearConcurrency()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 |
Reservation.Builder |
This builder for chaining. |
clearCreationTime()
public Reservation.Builder clearCreationTime()Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearEdition()
public Reservation.Builder clearEdition()Edition of the reservation.
.google.cloud.bigquery.reservation.v1.Edition edition = 17;
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Reservation.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearIgnoreIdleSlots()
public Reservation.Builder clearIgnoreIdleSlots()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 |
Reservation.Builder |
This builder for chaining. |
clearMaxSlots()
public Reservation.Builder clearMaxSlots()Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline.
This field must be set together with the scaling_mode enum value.
If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000.
If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700.
If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null.
If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments).
Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots.
Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature.
optional int64 max_slots = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
clearMultiRegionAuxiliary()
public Reservation.Builder clearMultiRegionAuxiliary()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 |
Reservation.Builder |
This builder for chaining. |
clearName()
public Reservation.Builder clearName() 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 |
Reservation.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Reservation.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearOriginalPrimaryLocation()
public Reservation.Builder clearOriginalPrimaryLocation()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
clearPrimaryLocation()
public Reservation.Builder clearPrimaryLocation()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
clearReplicationStatus()
public Reservation.Builder clearReplicationStatus()Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clearScalingMode()
public Reservation.Builder clearScalingMode()Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
.google.cloud.bigquery.reservation.v1.Reservation.ScalingMode scaling_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
clearSecondaryLocation()
public Reservation.Builder clearSecondaryLocation()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 |
Reservation.Builder |
This builder for chaining. |
clearSlotCapacity()
public Reservation.Builder clearSlotCapacity()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.
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 |
Reservation.Builder |
This builder for chaining. |
clearUpdateTime()
public Reservation.Builder clearUpdateTime()Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
clone()
public Reservation.Builder clone()| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
getAutoscale()
public Reservation.Autoscale getAutoscale()The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Returns | |
|---|---|
| Type | Description |
Reservation.Autoscale |
The autoscale. |
getAutoscaleBuilder()
public Reservation.Autoscale.Builder getAutoscaleBuilder()The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Returns | |
|---|---|
| Type | Description |
Reservation.Autoscale.Builder |
|
getAutoscaleOrBuilder()
public Reservation.AutoscaleOrBuilder getAutoscaleOrBuilder()The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Returns | |
|---|---|
| Type | Description |
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 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. |
getCreationTimeBuilder()
public Timestamp.Builder getCreationTimeBuilder()Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getCreationTimeOrBuilder()
public TimestampOrBuilder getCreationTimeOrBuilder()Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDefaultInstanceForType()
public Reservation getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Reservation |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getMaxSlots()
public long getMaxSlots()Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline.
This field must be set together with the scaling_mode enum value.
If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000.
If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700.
If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null.
If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments).
Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots.
Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature.
optional int64 max_slots = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The maxSlots. |
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()
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 | |
|---|---|
| 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()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The originalPrimaryLocation. |
getOriginalPrimaryLocationBytes()
public ByteString getOriginalPrimaryLocationBytes()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for originalPrimaryLocation. |
getPrimaryLocation()
public String getPrimaryLocation()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The primaryLocation. |
getPrimaryLocationBytes()
public ByteString getPrimaryLocationBytes()Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for primaryLocation. |
getReplicationStatus()
public Reservation.ReplicationStatus getReplicationStatus()Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.ReplicationStatus |
The replicationStatus. |
getReplicationStatusBuilder()
public Reservation.ReplicationStatus.Builder getReplicationStatusBuilder()Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.ReplicationStatus.Builder |
|
getReplicationStatusOrBuilder()
public Reservation.ReplicationStatusOrBuilder getReplicationStatusOrBuilder()Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Reservation.ReplicationStatusOrBuilder |
|
getScalingMode()
public Reservation.ScalingMode getScalingMode()Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
.google.cloud.bigquery.reservation.v1.Reservation.ScalingMode scaling_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Reservation.ScalingMode |
The scalingMode. |
getScalingModeValue()
public int getScalingModeValue()Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
.google.cloud.bigquery.reservation.v1.Reservation.ScalingMode scaling_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for scalingMode. |
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. |
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.
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. |
getUpdateTimeBuilder()
public Timestamp.Builder getUpdateTimeBuilder()Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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 | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
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. |
hasMaxSlots()
public boolean hasMaxSlots()Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline.
This field must be set together with the scaling_mode enum value.
If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000.
If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700.
If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null.
If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments).
Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots.
Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature.
optional int64 max_slots = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxSlots field is set. |
hasReplicationStatus()
public boolean hasReplicationStatus()Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the replicationStatus 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAutoscale(Reservation.Autoscale value)
public Reservation.Builder mergeAutoscale(Reservation.Autoscale value)The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
Reservation.Autoscale |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeCreationTime(Timestamp value)
public Reservation.Builder mergeCreationTime(Timestamp value)Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeFrom(Reservation other)
public Reservation.Builder mergeFrom(Reservation other)| Parameter | |
|---|---|
| Name | Description |
other |
Reservation |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Reservation.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public Reservation.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeReplicationStatus(Reservation.ReplicationStatus value)
public Reservation.Builder mergeReplicationStatus(Reservation.ReplicationStatus value)Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Reservation.ReplicationStatus |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Reservation.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
mergeUpdateTime(Timestamp value)
public Reservation.Builder mergeUpdateTime(Timestamp value)Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setAutoscale(Reservation.Autoscale value)
public Reservation.Builder setAutoscale(Reservation.Autoscale value)The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
Reservation.Autoscale |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setAutoscale(Reservation.Autoscale.Builder builderForValue)
public Reservation.Builder setAutoscale(Reservation.Autoscale.Builder builderForValue)The configuration parameters for the auto scaling feature.
.google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Reservation.Autoscale.Builder |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setConcurrency(long value)
public Reservation.Builder setConcurrency(long value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe concurrency to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setCreationTime(Timestamp value)
public Reservation.Builder setCreationTime(Timestamp value)Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setCreationTime(Timestamp.Builder builderForValue)
public Reservation.Builder setCreationTime(Timestamp.Builder builderForValue)Output only. Creation time of the reservation.
.google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setEdition(Edition value)
public Reservation.Builder setEdition(Edition value)Edition of the reservation.
.google.cloud.bigquery.reservation.v1.Edition edition = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
EditionThe edition to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setEditionValue(int value)
public Reservation.Builder setEditionValue(int value)Edition of the reservation.
.google.cloud.bigquery.reservation.v1.Edition edition = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for edition to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Reservation.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setIgnoreIdleSlots(boolean value)
public Reservation.Builder setIgnoreIdleSlots(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe ignoreIdleSlots to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setMaxSlots(long value)
public Reservation.Builder setMaxSlots(long value)Optional. The overall max slots for the reservation, covering slot_capacity (baseline), idle slots (if ignore_idle_slots is false) and scaled slots. If present, the reservation won't use more than the specified number of slots, even if there is demand and supply (from idle slots). NOTE: capping a reservation's idle slot usage is best effort and its usage may exceed the max_slots value. However, in terms of autoscale.current_slots (which accounts for the additional added slots), it will never exceed the max_slots - baseline.
This field must be set together with the scaling_mode enum value.
If the max_slots and scaling_mode are set, the autoscale or autoscale.max_slots field must be unset. However, the autoscale field may still be in the output. The autopscale.max_slots will always show as 0 and the autoscaler.current_slots will represent the current slots from autoscaler excluding idle slots. For example, if the max_slots is 1000 and scaling_mode is AUTOSCALE_ONLY, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots may be any value between 0 and 1000.
If the max_slots is 1000, scaling_mode is ALL_SLOTS, the baseline is 100 and idle slots usage is 200, then in the output, the autoscaler.max_slots will be 0 and the autoscaler.current_slots will not be higher than 700.
If the max_slots is 1000, scaling_mode is IDLE_SLOTS_ONLY, then in the output, the autoscaler field will be null.
If the max_slots and scaling_mode are set, then the ignore_idle_slots field must be aligned with the scaling_mode enum value.(See details in ScalingMode comments).
Please note, the max_slots is for user to manage the part of slots greater than the baseline. Therefore, we don't allow users to set max_slots smaller or equal to the baseline as it will not be meaningful. If the field is present and slot_capacity>=max_slots.
Please note that if max_slots is set to 0, we will treat it as unset. Customers can set max_slots to 0 and set scaling_mode to SCALING_MODE_UNSPECIFIED to disable the max_slots feature.
optional int64 max_slots = 21 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxSlots to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setMultiRegionAuxiliary(boolean value)
public Reservation.Builder setMultiRegionAuxiliary(boolean value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe multiRegionAuxiliary to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setName(String value)
public Reservation.Builder setName(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe name to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Reservation.Builder setNameBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for name to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setOriginalPrimaryLocation(String value)
public Reservation.Builder setOriginalPrimaryLocation(String value)Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe originalPrimaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setOriginalPrimaryLocationBytes(ByteString value)
public Reservation.Builder setOriginalPrimaryLocationBytes(ByteString value)Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for originalPrimaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setPrimaryLocation(String value)
public Reservation.Builder setPrimaryLocation(String value)Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe primaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setPrimaryLocationBytes(ByteString value)
public Reservation.Builder setPrimaryLocationBytes(ByteString value)Output only. 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) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for primaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Reservation.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setReplicationStatus(Reservation.ReplicationStatus value)
public Reservation.Builder setReplicationStatus(Reservation.ReplicationStatus value)Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Reservation.ReplicationStatus |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setReplicationStatus(Reservation.ReplicationStatus.Builder builderForValue)
public Reservation.Builder setReplicationStatus(Reservation.ReplicationStatus.Builder builderForValue)Output only. The Disaster Recovery(DR) replication status of the reservation. This is only available for the primary replicas of DR/failover reservations and provides information about the both the staleness of the secondary and the last error encountered while trying to replicate changes from the primary to the secondary. If this field is blank, it means that the reservation is either not a DR reservation or the reservation is a DR secondary or that any replication operations on the reservation have succeeded.
.google.cloud.bigquery.reservation.v1.Reservation.ReplicationStatus replication_status = 24 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Reservation.ReplicationStatus.Builder |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setScalingMode(Reservation.ScalingMode value)
public Reservation.Builder setScalingMode(Reservation.ScalingMode value)Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
.google.cloud.bigquery.reservation.v1.Reservation.ScalingMode scaling_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
Reservation.ScalingModeThe scalingMode to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setScalingModeValue(int value)
public Reservation.Builder setScalingModeValue(int value)Optional. The scaling mode for the reservation. If the field is present but max_slots is not present.
.google.cloud.bigquery.reservation.v1.Reservation.ScalingMode scaling_mode = 22 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for scalingMode to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setSecondaryLocation(String value)
public Reservation.Builder setSecondaryLocation(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe secondaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setSecondaryLocationBytes(ByteString value)
public Reservation.Builder setSecondaryLocationBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for secondaryLocation to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setSlotCapacity(long value)
public Reservation.Builder setSlotCapacity(long value)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.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe slotCapacity to set. |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Reservation.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setUpdateTime(Timestamp value)
public Reservation.Builder setUpdateTime(Timestamp value)Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|
setUpdateTime(Timestamp.Builder builderForValue)
public Reservation.Builder setUpdateTime(Timestamp.Builder builderForValue)Output only. Last update time of the reservation.
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
Reservation.Builder |
|