Class: Google::Apis::ComputeV1::Address
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Address
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb
Overview
Represents an IP Address resource. Google Compute Engine has two IP Address resources: * Global (external and internal) * Regional (external and internal) For more information, see Reserving a static external IP address.
Instance Attribute Summary collapse
-
#address ⇒ String
The static IP address represented by this resource.
-
#address_type ⇒ String
The type of address to reserve, either INTERNAL or EXTERNAL.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#ip_version ⇒ String
The IP version that will be used by this address.
-
#ipv6_endpoint_type ⇒ String
The endpoint type of this address, which should be VM or NETLB.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this Address, which is essentially a hash of the labels set used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels for this resource.
-
#name ⇒ String
Name of the resource.
-
#network ⇒ String
The URL of the network in which to reserve the address.
-
#network_tier ⇒ String
This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM or STANDARD.
-
#prefix_length ⇒ Fixnum
The prefix length if the resource represents an IP range.
-
#purpose ⇒ String
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, load balancers, and similar resources.
-
#region ⇒ String
[Output Only] The URL of the region where a regional address resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#status ⇒ String
[Output Only] The status of the address, which can be one of RESERVING, RESERVED, or IN_USE.
-
#subnetwork ⇒ String
The URL of the subnetwork in which to reserve the address.
-
#users ⇒ Array<String>
[Output Only] The URLs of the resources that are using this address.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Address
constructor
A new instance of Address.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Address
Returns a new instance of Address.
766 767 768 |
# File 'lib/google/apis/compute_v1/classes.rb', line 766 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
622 623 624 |
# File 'lib/google/apis/compute_v1/classes.rb', line 622 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
628 629 630 |
# File 'lib/google/apis/compute_v1/classes.rb', line 628 def address_type @address_type end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
633 634 635 |
# File 'lib/google/apis/compute_v1/classes.rb', line 633 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this field when you create
the resource.
Corresponds to the JSON property description
639 640 641 |
# File 'lib/google/apis/compute_v1/classes.rb', line 639 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
645 646 647 |
# File 'lib/google/apis/compute_v1/classes.rb', line 645 def id @id end |
#ip_version ⇒ String
The IP version that will be used by this address. Valid options are IPV4 or
IPV6.
Corresponds to the JSON property ipVersion
651 652 653 |
# File 'lib/google/apis/compute_v1/classes.rb', line 651 def ip_version @ip_version end |
#ipv6_endpoint_type ⇒ String
The endpoint type of this address, which should be VM or NETLB. This is used
for deciding which type of endpoint this address can be used after the
external IPv6 address reservation.
Corresponds to the JSON property ipv6EndpointType
658 659 660 |
# File 'lib/google/apis/compute_v1/classes.rb', line 658 def ipv6_endpoint_type @ipv6_endpoint_type end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#address for addresses.
Corresponds to the JSON property kind
663 664 665 |
# File 'lib/google/apis/compute_v1/classes.rb', line 663 def kind @kind end |
#label_fingerprint ⇒ String
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.
675 676 677 |
# File 'lib/google/apis/compute_v1/classes.rb', line 675 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<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
682 683 684 |
# File 'lib/google/apis/compute_v1/classes.rb', line 682 def labels @labels 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])?
. 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
692 693 694 |
# File 'lib/google/apis/compute_v1/classes.rb', line 692 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 the VPC_PEERING purpose.
Corresponds to the JSON property network
698 699 700 |
# File 'lib/google/apis/compute_v1/classes.rb', line 698 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 or STANDARD. Internal IP addresses are
always Premium Tier; global external IP addresses are always Premium Tier;
regional external IP addresses can be either Standard or Premium Tier. If this
field is not specified, it is assumed to be PREMIUM.
Corresponds to the JSON property networkTier
707 708 709 |
# File 'lib/google/apis/compute_v1/classes.rb', line 707 def network_tier @network_tier end |
#prefix_length ⇒ Fixnum
The prefix length if the resource represents an IP range.
Corresponds to the JSON property prefixLength
712 713 714 |
# File 'lib/google/apis/compute_v1/classes.rb', line 712 def prefix_length @prefix_length end |
#purpose ⇒ String
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, load balancers, and similar resources. - DNS_RESOLVER for a DNS resolver address in a subnetwork for a Cloud DNS inbound forwarder IP addresses ( regional internal IP address in a subnet of a VPC network) - VPC_PEERING for global internal IP addresses used for private services access allocated ranges.
- NAT_AUTO for the regional external IP addresses used by Cloud NAT when
allocating addresses using automatic NAT IP address allocation. -
IPSEC_INTERCONNECT for addresses created from a private IP range that are
reserved for a VLAN attachment in an HA VPN over Cloud Interconnect
configuration. These addresses are regional resources. -
SHARED_LOADBALANCER_VIP
for an internal IP address that is assigned to multiple internal forwarding rules. -PRIVATE_SERVICE_CONNECT
for a private network address that is used to configure Private Service Connect. Only global internal addresses can use this purpose. Corresponds to the JSON propertypurpose
731 732 733 |
# File 'lib/google/apis/compute_v1/classes.rb', line 731 def purpose @purpose end |
#region ⇒ String
[Output Only] The URL of the region where a regional address resides. For
regional addresses, you must specify the region as a path parameter in the
HTTP request URL. This field is not applicable to global addresses.
Corresponds to the JSON property region
738 739 740 |
# File 'lib/google/apis/compute_v1/classes.rb', line 738 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
743 744 745 |
# File 'lib/google/apis/compute_v1/classes.rb', line 743 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
752 753 754 |
# File 'lib/google/apis/compute_v1/classes.rb', line 752 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 a GCE_ENDPOINT or DNS_RESOLVER purpose.
Corresponds to the JSON property subnetwork
759 760 761 |
# File 'lib/google/apis/compute_v1/classes.rb', line 759 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
764 765 766 |
# File 'lib/google/apis/compute_v1/classes.rb', line 764 def users @users end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
# File 'lib/google/apis/compute_v1/classes.rb', line 771 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) @ipv6_endpoint_type = args[:ipv6_endpoint_type] if args.key?(:ipv6_endpoint_type) @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) @status = args[:status] if args.key?(:status) @subnetwork = args[:subnetwork] if args.key?(:subnetwork) @users = args[:users] if args.key?(:users) end |