Class: Google::Apis::ComputeAlpha::Address

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

Overview

A reserved address resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Address

Returns a new instance of Address



643
644
645
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 643

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

Instance Attribute Details

#address ⇒ String

The static external IP address represented by this resource. Corresponds to the JSON property address

Returns:

  • (String) 


542
543
544
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 542

def address
  @address
end

#address_type ⇒ String

The type of address to reserve. If unspecified, defaults to EXTERNAL. Corresponds to the JSON property addressType

Returns:

  • (String) 


547
548
549
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 547

def address_type
  @address_type
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


552
553
554
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 552

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) 


558
559
560
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 558

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) 


564
565
566
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 564

def id
  @id
end

#ip_version ⇒ String

The IP Version that will be used by this address. Valid options are IPV4 or IPV6. This can only be specified for a global address. Corresponds to the JSON property ipVersion

Returns:

  • (String) 


570
571
572
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 570

def ip_version
  @ip_version
end

#kind ⇒ String

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

Returns:

  • (String) 


575
576
577
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 575

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels. To see the latest fingerprint, make a get() request to retrieve an Address. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


586
587
588
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 586

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this Address resource. These can be later modified by the setLabels method. Each label key/value must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


593
594
595
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 593

def labels
  @labels
end

#name ⇒ String

Name of the resource. Provided by the client when the resource is created. The 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? 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) 


603
604
605
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 603

def name
  @name
end

#network_tier ⇒ String

This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM , STANDARD. If this field is not specified, it is assumed to be PREMIUM. Corresponds to the JSON property networkTier

Returns:

  • (String) 


610
611
612
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 610

def network_tier
  @network_tier
end

#region ⇒ String

[Output Only] URL of the region where the regional address resides. This field is not applicable to global addresses. Corresponds to the JSON property region

Returns:

  • (String) 


616
617
618
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 616

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


621
622
623
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 621

def self_link
  @self_link
end

#status ⇒ String

[Output Only] The status of the address, which can be either IN_USE or RESERVED. An address that is RESERVED is currently reserved and available to use. An IN_USE address is currently being used by another resource and is not available. Corresponds to the JSON property status

Returns:

  • (String) 


629
630
631
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 629

def status
  @status
end

#subnetwork ⇒ String

For external addresses, this field should not be used. The URL of the subnetwork in which to reserve the address. If an IP address is specified, it must be within the subnetwork's IP range. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


636
637
638
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 636

def subnetwork
  @subnetwork
end

#users ⇒ Array<String>

[Output Only] The URLs of the resources that are using this address. Corresponds to the JSON property users

Returns:

  • (Array<String>) 


641
642
643
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 641

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 648

def update!(**args)
  @address = args[:address] if args.key?(:address)
  @address_type = args[:address_type] if args.key?(:address_type)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @ip_version = args[:ip_version] if args.key?(:ip_version)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @network_tier = args[:network_tier] if args.key?(:network_tier)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @users = args[:users] if args.key?(:users)
end