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. Note this is an alpha 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 BQ 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. |
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 | |
clearSlotCapacity()
public Reservation.Builder clearSlotCapacity()Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism.
Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false.
If total slot_capacity of the reservation and its siblings
exceeds the total slot_count of all capacity commitments, the request will
fail with google.rpc.Code.RESOURCE_EXHAUSTED.
NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
int64 slot_capacity = 2;
| Returns | |
|---|---|
| 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. Note this is an alpha 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. Note this is an alpha 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. Note this is an alpha 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 BQ 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. |
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. |
getSlotCapacity()
public long getSlotCapacity()Minimum slots available to this reservation. A slot is a unit of computational power in BigQuery, and serves as the unit of parallelism.
Queries using this reservation might use more slots during runtime if ignore_idle_slots is set to false.
If total slot_capacity of the reservation and its siblings
exceeds the total slot_count of all capacity commitments, the request will
fail with google.rpc.Code.RESOURCE_EXHAUSTED.
NOTE: for reservations in US or EU multi-regions, slot capacity constraints are checked separately for default and auxiliary regions. See multi_region_auxiliary flag for more details.
int64 slot_capacity = 2;
| Returns | |
|---|---|
| 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. Note this is an alpha 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. |
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. Note this is an alpha 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 | |
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. Note this is an alpha 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. Note this is an alpha 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 BQ 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. |
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. |
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 | |
setSlotCapacity(long value)
public Reservation.Builder setSlotCapacity(long value)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;
| 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 | |