Class: Google::Cloud::Bigquery::Reservation::V1::Reservation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb

Overview

A reservation is a mechanism used to guarantee slots to users.

Defined Under Namespace

Classes: Autoscale

Instance Attribute Summary collapse

Instance Attribute Details

#autoscale ⇒ ::Google::Cloud::Bigquery::Reservation::V1::Reservation::Autoscale

Returns The configuration parameters for the auto scaling feature. Note this is an alpha feature.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#concurrency ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#creation_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Creation time of the reservation.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#edition ⇒ ::Google::Cloud::Bigquery::Reservation::V1::Edition

Returns Edition of the reservation.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_idle_slots ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#multi_region_auxiliary ⇒ ::Boolean

Returns 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.

Returns:

  • (::Boolean) —

    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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#slot_capacity ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Last update time of the reservation.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'proto_docs/google/cloud/bigquery/reservation/v1/reservation.rb', line 89

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Auto scaling settings.
  # @!attribute [r] current_slots
  #   @return [::Integer]
  #     Output only. The slot capacity added to this reservation when autoscale
  #     happens. Will be between [0, max_slots].
  # @!attribute [rw] max_slots
  #   @return [::Integer]
  #     Number of slots to be scaled when needed.
  class Autoscale
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end