Class: Google::Apis::ComputeV1::Address

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

Overview

A reserved address resource. (== resource_for beta.addresses ==) (== resource_for v1.addresses ==) (== resource_for beta.globalAddresses ==) (== resource_for v1.globalAddresses ==)

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



619
620
621
 
# File 'generated/google/apis/compute_v1/classes.rb', line 619

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

Instance Attribute Details

#address ⇒ String

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

Returns:

  • (String) 


533
534
535
 
# File 'generated/google/apis/compute_v1/classes.rb', line 533

def address
  @address
end

#address_type ⇒ String

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

Returns:

  • (String) 


539
540
541
 
# File 'generated/google/apis/compute_v1/classes.rb', line 539

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) 


544
545
546
 
# File 'generated/google/apis/compute_v1/classes.rb', line 544

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) 


550
551
552
 
# File 'generated/google/apis/compute_v1/classes.rb', line 550

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) 


556
557
558
 
# File 'generated/google/apis/compute_v1/classes.rb', line 556

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) 


562
563
564
 
# File 'generated/google/apis/compute_v1/classes.rb', line 562

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) 


567
568
569
 
# File 'generated/google/apis/compute_v1/classes.rb', line 567

def kind
  @kind
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]([-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) 


577
578
579
 
# File 'generated/google/apis/compute_v1/classes.rb', line 577

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) 


584
585
586
 
# File 'generated/google/apis/compute_v1/classes.rb', line 584

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. You must specify this field as part of the HTTP request URL. You cannot set this field in the request body. Corresponds to the JSON property region

Returns:

  • (String) 


591
592
593
 
# File 'generated/google/apis/compute_v1/classes.rb', line 591

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


596
597
598
 
# File 'generated/google/apis/compute_v1/classes.rb', line 596

def self_link
  @self_link
end

#status ⇒ String

[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE. An address that is RESERVING is currently in the process of being reserved. A RESERVED address 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) 


605
606
607
 
# File 'generated/google/apis/compute_v1/classes.rb', line 605

def status
  @status
end

#subnetwork ⇒ String

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. This field can only be used with INTERNAL type with GCE_ENDPOINT/DNS_RESOLVER purposes. Corresponds to the JSON property subnetwork

Returns:

  • (String) 


612
613
614
 
# File 'generated/google/apis/compute_v1/classes.rb', line 612

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>) 


617
618
619
 
# File 'generated/google/apis/compute_v1/classes.rb', line 617

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'generated/google/apis/compute_v1/classes.rb', line 624

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)
  @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