Class: Google::Apis::ComputeV1::Reservation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Reservation

Returns a new instance of Reservation.



30875
30876
30877
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30875

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

Instance Attribute Details

#commitment ⇒ String

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. Corresponds to the JSON property commitment

Returns:

  • (String) 


30786
30787
30788
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30786

def commitment
  @commitment
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


30791
30792
30793
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30791

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


30797
30798
30799
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30797

def description
  @description
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


30803
30804
30805
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30803

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#reservations for reservations. Corresponds to the JSON property kind

Returns:

  • (String) 


30809
30810
30811
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30809

def kind
  @kind
end

#name ⇒ String

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


30820
30821
30822
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30820

def name
  @name
end

#resource_policies ⇒ Hash<String,String>

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation. Corresponds to the JSON property resourcePolicies

Returns:

  • (Hash<String,String>) 


30827
30828
30829
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30827

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeV1::AllocationResourceStatus

[Output Only] Contains output only fields. Corresponds to the JSON property resourceStatus

Returns:



30832
30833
30834
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30832

def resource_status
  @resource_status
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


30837
30838
30839
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30837

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

[Output Only] Server-defined fully-qualified URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


30843
30844
30845
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30843

def self_link
  @self_link
end

#share_settings ⇒ Google::Apis::ComputeV1::ShareSettings

The share setting for reservations and sole tenancy node groups. Corresponds to the JSON property shareSettings

Returns:



30848
30849
30850
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30848

def share_settings
  @share_settings
end

#specific_reservation ⇒ Google::Apis::ComputeV1::AllocationSpecificSkuReservation

This reservation type allows to pre allocate specific instance configuration. Next ID: 6 Corresponds to the JSON property specificReservation

Returns:



30854
30855
30856
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30854

def specific_reservation
  @specific_reservation
end

#specific_reservation_required ⇒ Boolean Also known as: specific_reservation_required?

Indicates whether the reservation can be consumed by VMs with affinity for " any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation. Corresponds to the JSON property specificReservationRequired

Returns:

  • (Boolean) 


30861
30862
30863
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30861

def specific_reservation_required
  @specific_reservation_required
end

#status ⇒ String

[Output Only] The status of the reservation. Corresponds to the JSON property status

Returns:

  • (String) 


30867
30868
30869
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30867

def status
  @status
end

#zone ⇒ String

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. Corresponds to the JSON property zone

Returns:

  • (String) 


30873
30874
30875
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30873

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30880
30881
30882
30883
30884
30885
30886
30887
30888
30889
30890
30891
30892
30893
30894
30895
30896
 
# File 'lib/google/apis/compute_v1/classes.rb', line 30880

def update!(**args)
  @commitment = args[:commitment] if args.key?(:commitment)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @share_settings = args[:share_settings] if args.key?(:share_settings)
  @specific_reservation = args[:specific_reservation] if args.key?(:specific_reservation)
  @specific_reservation_required = args[:specific_reservation_required] if args.key?(:specific_reservation_required)
  @status = args[:status] if args.key?(:status)
  @zone = args[:zone] if args.key?(:zone)
end