Class: Google::Apis::BigqueryreservationV1beta1::CapacityCommitment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/bigqueryreservation_v1beta1/classes.rb,
generated/google/apis/bigqueryreservation_v1beta1/representations.rb,
generated/google/apis/bigqueryreservation_v1beta1/representations.rb

Overview

Capacity commitment is a way to purchase compute capacity for BigQuery jobs (in the form of slots) with some minimum committed period of usage. Capacity commitment is immutable and cannot be deleted until the end of the commitment period. After the end of the commitment period, slots are still available but can be freely removed any time. A capacity commitment resource exists as a child resource of the admin project.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CapacityCommitment

Returns a new instance of CapacityCommitment



98
99
100
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 98

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#commitment_end_timeString

Output only. The end of the commitment period. Capacity commitment cannot be removed before commitment_end_time. It is applicable only for ACTIVE capacity commitments and is computed as a combination of the plan and the time when the capacity commitment became ACTIVE. Corresponds to the JSON property commitmentEndTime

Returns:

  • (String)


75
76
77
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 75

def commitment_end_time
  @commitment_end_time
end

#nameString

Output only. The resource name of the capacity commitment, e.g., projects/myproject/locations/US/capacityCommitments/123 Corresponds to the JSON property name

Returns:

  • (String)


81
82
83
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 81

def name
  @name
end

#planString

Capacity commitment commitment plan. Corresponds to the JSON property plan

Returns:

  • (String)


86
87
88
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 86

def plan
  @plan
end

#slot_countFixnum

Number of slots in this commitment. Corresponds to the JSON property slotCount

Returns:

  • (Fixnum)


91
92
93
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 91

def slot_count
  @slot_count
end

#stateString

Output only. State of the commitment. Corresponds to the JSON property state

Returns:

  • (String)


96
97
98
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 96

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



103
104
105
106
107
108
109
# File 'generated/google/apis/bigqueryreservation_v1beta1/classes.rb', line 103

def update!(**args)
  @commitment_end_time = args[:commitment_end_time] if args.key?(:commitment_end_time)
  @name = args[:name] if args.key?(:name)
  @plan = args[:plan] if args.key?(:plan)
  @slot_count = args[:slot_count] if args.key?(:slot_count)
  @state = args[:state] if args.key?(:state)
end