Class: Google::Apis::BigqueryreservationV1::CapacityCommitment

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

Overview

Capacity commitment is a way to purchase compute capacity for BigQuery jobs ( in the form of slots) with some committed period of usage. Annual commitments renew by default. Commitments can be removed after their commitment end time passes. In order to remove annual commitment, its plan needs to be changed to monthly or flex first. A capacity commitment resource exists as a child resource of the admin project.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CapacityCommitment

Returns a new instance of CapacityCommitment.



156
157
158
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 156

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

Instance Attribute Details

#commitment_end_time ⇒ String

Output only. The end of the current commitment period. It is applicable only for ACTIVE capacity commitments. Corresponds to the JSON property commitmentEndTime

Returns:

  • (String) 


110
111
112
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 110

def commitment_end_time
  @commitment_end_time
end

#commitment_start_time ⇒ String

Output only. The start of the current commitment period. It is applicable only for ACTIVE capacity commitments. Corresponds to the JSON property commitmentStartTime

Returns:

  • (String) 


116
117
118
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 116

def commitment_start_time
  @commitment_start_time
end

#failure_status ⇒ Google::Apis::BigqueryreservationV1::Status

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide. Corresponds to the JSON property failureStatus

Returns:



126
127
128
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 126

def failure_status
  @failure_status
end

#name ⇒ String

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) 


132
133
134
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 132

def name
  @name
end

#plan ⇒ String

Capacity commitment commitment plan. Corresponds to the JSON property plan

Returns:

  • (String) 


137
138
139
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 137

def plan
  @plan
end

#renewal_plan ⇒ String

The plan this capacity commitment is converted to after commitment_end_time passes. Once the plan is changed, committed period is extended according to commitment plan. Only applicable for ANNUAL and TRIAL commitments. Corresponds to the JSON property renewalPlan

Returns:

  • (String) 


144
145
146
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 144

def renewal_plan
  @renewal_plan
end

#slot_count ⇒ Fixnum

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

Returns:

  • (Fixnum) 


149
150
151
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 149

def slot_count
  @slot_count
end

#state ⇒ String

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

Returns:

  • (String) 


154
155
156
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 154

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



161
162
163
164
165
166
167
168
169
170
 
# File 'generated/google/apis/bigqueryreservation_v1/classes.rb', line 161

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