Package com.google.cloud.bigquery.reservation.v1

Class Reservation.Builder

  • All Implemented Interfaces:
    ReservationOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Reservation
    public static final class Reservation.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>
implements ReservationOrBuilder
     A reservation is a mechanism used to guarantee slots to users.
    Protobuf type google.cloud.bigquery.reservation.v1.Reservation

    • Method Detail

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • clear

        public Reservation.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • getDefaultInstanceForType

        public Reservation getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

        public Reservation build()
        Specified by:
        build in interface com.google.protobuf.Message.Builder
        Specified by:
        build in interface com.google.protobuf.MessageLite.Builder

      • buildPartial

        public Reservation buildPartial()
        Specified by:
        buildPartial in interface com.google.protobuf.Message.Builder
        Specified by:
        buildPartial in interface com.google.protobuf.MessageLite.Builder

      • clone

        public Reservation.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • setField

        public Reservation.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • clearField

        public Reservation.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • clearOneof

        public Reservation.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • setRepeatedField

        public Reservation.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • addRepeatedField

        public Reservation.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • mergeFrom

        public Reservation.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Reservation.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • mergeFrom

        public Reservation.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Reservation.Builder>
        Throws:
        IOException

      • getName

        public String getName()
         The resource name of the reservation, e.g.,
 `projects/*/locations/*/reservations/team1-prod`.
 The reservation_id must only contain lower case alphanumeric characters or
 dashes. It must start with a letter and must not end with a dash. Its
 maximum length is 64 characters.
        string name = 1;
        Specified by:
        getName in interface ReservationOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         The resource name of the reservation, e.g.,
 `projects/*/locations/*/reservations/team1-prod`.
 The reservation_id must only contain lower case alphanumeric characters or
 dashes. It must start with a letter and must not end with a dash. Its
 maximum length is 64 characters.
        string name = 1;
        Specified by:
        getNameBytes in interface ReservationOrBuilder
        Returns:
        The bytes for name.

      • setName

        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;
        Parameters:
        value - The name to set.
        Returns:
        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:
        This builder for chaining.

      • setNameBytes

        public Reservation.Builder setNameBytes​(com.google.protobuf.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;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getSlotCapacity

        public long getSlotCapacity()
         Minimum slots available to this reservation. A slot is a unit of
 computational power in BigQuery, and serves as the unit of parallelism.

 Queries using this reservation might use more slots during runtime if
 ignore_idle_slots is set to false.

 If total slot_capacity of the reservation and its siblings
 exceeds the total slot_count of all capacity commitments, the request will
 fail with `google.rpc.Code.RESOURCE_EXHAUSTED`.


 NOTE: for reservations in US or EU multi-regions, slot capacity constraints
 are checked separately for default and auxiliary regions. See
 multi_region_auxiliary flag for more details.
        int64 slot_capacity = 2;
        Specified by:
        getSlotCapacity in interface ReservationOrBuilder
        Returns:
        The slotCapacity.

      • setSlotCapacity

        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;
        Parameters:
        value - The slotCapacity to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • getIgnoreIdleSlots

        public boolean getIgnoreIdleSlots()
         If false, any query or pipeline job using this reservation will use idle
 slots from other reservations within the same admin project. If true, a
 query or pipeline job using this reservation will execute with the slot
 capacity specified in the slot_capacity field at most.
        bool ignore_idle_slots = 4;
        Specified by:
        getIgnoreIdleSlots in interface ReservationOrBuilder
        Returns:
        The ignoreIdleSlots.

      • setIgnoreIdleSlots

        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;
        Parameters:
        value - The ignoreIdleSlots to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • hasAutoscale

        public boolean hasAutoscale()
         The configuration parameters for the auto scaling feature. Note this is an
 alpha feature.
        .google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
        Specified by:
        hasAutoscale in interface ReservationOrBuilder
        Returns:
        Whether the autoscale field is set.

      • getAutoscale

        public Reservation.Autoscale getAutoscale()
         The configuration parameters for the auto scaling feature. Note this is an
 alpha feature.
        .google.cloud.bigquery.reservation.v1.Reservation.Autoscale autoscale = 7;
        Specified by:
        getAutoscale in interface ReservationOrBuilder
        Returns:
        The autoscale.

      • setAutoscale

        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;

      • setAutoscale

        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;

      • mergeAutoscale

        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;

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

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

      • getConcurrency

        public long getConcurrency()
         Job concurrency target which sets a soft upper bound on the number of jobs
 that can run concurrently in this reservation. This is a soft target due to
 asynchronous nature of the system and various optimizations for small
 queries.
 Default value is 0 which means that concurrency target will be
 automatically computed by the system.
 NOTE: this field is exposed as `target_job_concurrency` in the Information
 Schema, DDL and BQ CLI.
        int64 concurrency = 16;
        Specified by:
        getConcurrency in interface ReservationOrBuilder
        Returns:
        The concurrency.

      • setConcurrency

        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;
        Parameters:
        value - The concurrency to set.
        Returns:
        This builder for chaining.

      • 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:
        This builder for chaining.

      • hasCreationTime

        public boolean hasCreationTime()
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreationTime in interface ReservationOrBuilder
        Returns:
        Whether the creationTime field is set.

      • getCreationTime

        public com.google.protobuf.Timestamp getCreationTime()
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreationTime in interface ReservationOrBuilder
        Returns:
        The creationTime.

      • setCreationTime

        public Reservation.Builder setCreationTime​(com.google.protobuf.Timestamp value)
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setCreationTime

        public Reservation.Builder setCreationTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeCreationTime

        public Reservation.Builder mergeCreationTime​(com.google.protobuf.Timestamp value)
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • clearCreationTime

        public Reservation.Builder clearCreationTime()
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreationTimeBuilder

        public com.google.protobuf.Timestamp.Builder getCreationTimeBuilder()
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getCreationTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getCreationTimeOrBuilder()
         Output only. Creation time of the reservation.
        .google.protobuf.Timestamp creation_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getCreationTimeOrBuilder in interface ReservationOrBuilder

      • hasUpdateTime

        public boolean hasUpdateTime()
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasUpdateTime in interface ReservationOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public com.google.protobuf.Timestamp getUpdateTime()
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTime in interface ReservationOrBuilder
        Returns:
        The updateTime.

      • setUpdateTime

        public Reservation.Builder setUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • setUpdateTime

        public Reservation.Builder setUpdateTime​(com.google.protobuf.Timestamp.Builder builderForValue)
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • mergeUpdateTime

        public Reservation.Builder mergeUpdateTime​(com.google.protobuf.Timestamp value)
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

      • getUpdateTimeBuilder

        public com.google.protobuf.Timestamp.Builder getUpdateTimeBuilder()
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getUpdateTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
         Output only. Last update time of the reservation.
        .google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getUpdateTimeOrBuilder in interface ReservationOrBuilder

      • getMultiRegionAuxiliary

        public boolean getMultiRegionAuxiliary()
         Applicable only for reservations located within one of the BigQuery
 multi-regions (US or EU).

 If set to true, this reservation is placed in the organization's
 secondary region which is designated for disaster recovery purposes.
 If false, this reservation is placed in the organization's default region.

 NOTE: this is a preview feature. Project must be allow-listed in order to
 set this field.
        bool multi_region_auxiliary = 14;
        Specified by:
        getMultiRegionAuxiliary in interface ReservationOrBuilder
        Returns:
        The multiRegionAuxiliary.

      • setMultiRegionAuxiliary

        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;
        Parameters:
        value - The multiRegionAuxiliary to set.
        Returns:
        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:
        This builder for chaining.

      • getEditionValue

        public int getEditionValue()
         Edition of the reservation.
        .google.cloud.bigquery.reservation.v1.Edition edition = 17;
        Specified by:
        getEditionValue in interface ReservationOrBuilder
        Returns:
        The enum numeric value on the wire for edition.

      • setEditionValue

        public Reservation.Builder setEditionValue​(int value)
         Edition of the reservation.
        .google.cloud.bigquery.reservation.v1.Edition edition = 17;
        Parameters:
        value - The enum numeric value on the wire for edition to set.
        Returns:
        This builder for chaining.

      • getEdition

        public Edition getEdition()
         Edition of the reservation.
        .google.cloud.bigquery.reservation.v1.Edition edition = 17;
        Specified by:
        getEdition in interface ReservationOrBuilder
        Returns:
        The edition.

      • setEdition

        public Reservation.Builder setEdition​(Edition value)
         Edition of the reservation.
        .google.cloud.bigquery.reservation.v1.Edition edition = 17;
        Parameters:
        value - The edition to set.
        Returns:
        This builder for chaining.

      • clearEdition

        public Reservation.Builder clearEdition()
         Edition of the reservation.
        .google.cloud.bigquery.reservation.v1.Edition edition = 17;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Reservation.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>

      • mergeUnknownFields

        public final Reservation.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Reservation.Builder>