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.

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



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

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) 


501
502
503
 
# File 'generated/google/apis/compute_v1/classes.rb', line 501

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) 


506
507
508
 
# File 'generated/google/apis/compute_v1/classes.rb', line 506

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) 


511
512
513
 
# File 'generated/google/apis/compute_v1/classes.rb', line 511

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) 


517
518
519
 
# File 'generated/google/apis/compute_v1/classes.rb', line 517

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) 


523
524
525
 
# File 'generated/google/apis/compute_v1/classes.rb', line 523

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) 


529
530
531
 
# File 'generated/google/apis/compute_v1/classes.rb', line 529

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) 


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

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


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

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


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

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


571
572
573
 
# File 'generated/google/apis/compute_v1/classes.rb', line 571

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


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

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
 
# File 'generated/google/apis/compute_v1/classes.rb', line 583

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