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



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

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) 


535
536
537
 
# File 'generated/google/apis/compute_v1/classes.rb', line 535

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) 


541
542
543
 
# File 'generated/google/apis/compute_v1/classes.rb', line 541

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) 


546
547
548
 
# File 'generated/google/apis/compute_v1/classes.rb', line 546

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) 


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

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) 


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

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) 


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

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) 


569
570
571
 
# File 'generated/google/apis/compute_v1/classes.rb', line 569

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) 


579
580
581
 
# File 'generated/google/apis/compute_v1/classes.rb', line 579

def name
  @name
end

#network ⇒ String

The URL of the network in which to reserve the address. This field can only be used with INTERNAL type with VPC_PEERING purpose. Corresponds to the JSON property network

Returns:

  • (String) 


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

def network
  @network
end

#network_tier ⇒ String

This signifies the networking tier used for configuring this Address and can only take the following values: PREMIUM, STANDARD. Global forwarding rules can only be Premium Tier. Regional forwarding rules can be either Premium or Standard Tier. Standard Tier addresses applied to regional forwarding rules can be used with any external load balancer. Regional forwarding rules in Premium Tier can only be used with a Network load balancer. If this field is not specified, it is assumed to be PREMIUM. Corresponds to the JSON property networkTier

Returns:

  • (String) 


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

def network_tier
  @network_tier
end

#prefix_length ⇒ Fixnum

The prefix length if the resource reprensents an IP range. Corresponds to the JSON property prefixLength

Returns:

  • (Fixnum) 


601
602
603
 
# File 'generated/google/apis/compute_v1/classes.rb', line 601

def prefix_length
  @prefix_length
end

#purpose ⇒ String

The purpose of resource, only used with INTERNAL type. Corresponds to the JSON property purpose

Returns:

  • (String) 


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

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


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

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

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) 


627
628
629
 
# File 'generated/google/apis/compute_v1/classes.rb', line 627

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) 


634
635
636
 
# File 'generated/google/apis/compute_v1/classes.rb', line 634

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


639
640
641
 
# File 'generated/google/apis/compute_v1/classes.rb', line 639

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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 = args[:network] if args.key?(:network)
  @network_tier = args[:network_tier] if args.key?(:network_tier)
  @prefix_length = args[:prefix_length] if args.key?(:prefix_length)
  @purpose = args[:purpose] if args.key?(:purpose)
  @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