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



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

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, either INTERNAL or EXTERNAL. If unspecified, defaults to EXTERNAL. Corresponds to the JSON property addressType

Returns:

  • (String) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

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) 


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

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

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


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

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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