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

Use global external addresses for GFE-based external HTTP(S) load balancers in Premium Tier. Use global internal addresses for reserved peering network range. Use regional external addresses for the following resources:

  • External IP addresses for VM instances - Regional external forwarding rules - Cloud NAT external IP addresses - GFE based LBs in Standard Tier - Network LBs in Premium or Standard Tier - Cloud VPN gateways (both Classic and HA) Use regional internal IP addresses for subnet IP ranges (primary and secondary) . This includes:
  • Internal IP addresses for VM instances - Alias IP ranges of VM instances (/ 32 only) - Regional internal forwarding rules - Internal TCP/UDP load balancer addresses - Internal HTTP(S) load balancer addresses - Cloud DNS inbound forwarding IP addresses For more information, read reserved IP address. (== resource_for $api_version.addresses ==) (== resource_for $api_version. 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.


713
714
715
# File 'generated/google/apis/compute_alpha/classes.rb', line 713

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

Instance Attribute Details

#addressString

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

Returns:

  • (String)

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

def address
  @address
end

#address_typeString

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

Returns:

  • (String)

583
584
585
# File 'generated/google/apis/compute_alpha/classes.rb', line 583

def address_type
  @address_type
end

#creation_timestampString

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

Returns:

  • (String)

588
589
590
# File 'generated/google/apis/compute_alpha/classes.rb', line 588

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this field when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)

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

def description
  @description
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)

600
601
602
# File 'generated/google/apis/compute_alpha/classes.rb', line 600

def id
  @id
end

#ip_versionString

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)

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

def ip_version
  @ip_version
end

#kindString

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

Returns:

  • (String)

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

def kind
  @kind
end

#label_fingerprintString

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, otherwise the request will fail with error 412 conditionNotMet. 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)

623
624
625
# File 'generated/google/apis/compute_alpha/classes.rb', line 623

def label_fingerprint
  @label_fingerprint
end

#labelsHash<String,String>

Labels for this resource. These can only be added or modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)

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

def labels
  @labels
end

#nameString

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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. Corresponds to the JSON property name

Returns:

  • (String)

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

def name
  @name
end

#networkString

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

Returns:

  • (String)

646
647
648
# File 'generated/google/apis/compute_alpha/classes.rb', line 646

def network
  @network
end

#network_tierString

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or 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)

657
658
659
# File 'generated/google/apis/compute_alpha/classes.rb', line 657

def network_tier
  @network_tier
end

#prefix_lengthFixnum

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

Returns:

  • (Fixnum)

662
663
664
# File 'generated/google/apis/compute_alpha/classes.rb', line 662

def prefix_length
  @prefix_length
end

#purposeString

The purpose of this resource, which can be one of the following values:

  • GCE_ENDPOINT for addresses that are used by VM instances, alias IP ranges, internal load balancers, and similar resources.
  • DNS_RESOLVER for a DNS resolver address in a subnetwork
  • VPC_PEERING for addresses that are reserved for VPC peer networks.
  • NAT_AUTO for addresses that are external IP addresses automatically reserved for Cloud NAT. Corresponds to the JSON property purpose

Returns:

  • (String)

673
674
675
# File 'generated/google/apis/compute_alpha/classes.rb', line 673

def purpose
  @purpose
end

#regionString

[Output Only] The 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. Corresponds to the JSON property region

Returns:

  • (String)

680
681
682
# File 'generated/google/apis/compute_alpha/classes.rb', line 680

def region
  @region
end

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

Returns:

  • (String)

685
686
687
# File 'generated/google/apis/compute_alpha/classes.rb', line 685

def self_link
  @self_link
end

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String)

690
691
692
# File 'generated/google/apis/compute_alpha/classes.rb', line 690

def self_link_with_id
  @self_link_with_id
end

#statusString

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

699
700
701
# File 'generated/google/apis/compute_alpha/classes.rb', line 699

def status
  @status
end

#subnetworkString

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 a GCE_ENDPOINT or DNS_RESOLVER purpose. Corresponds to the JSON property subnetwork

Returns:

  • (String)

706
707
708
# File 'generated/google/apis/compute_alpha/classes.rb', line 706

def subnetwork
  @subnetwork
end

#usersArray<String>

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

Returns:

  • (Array<String>)

711
712
713
# File 'generated/google/apis/compute_alpha/classes.rb', line 711

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
# File 'generated/google/apis/compute_alpha/classes.rb', line 718

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 = 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)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @status = args[:status] if args.key?(:status)
  @subnetwork = args[:subnetwork] if args.key?(:subnetwork)
  @users = args[:users] if args.key?(:users)
end