Compute Engine v1 API - Class Address (3.21.0)

public sealed class Address : IMessage<Address>, IEquatable<Address>, IDeepCloneable<Address>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Address.

Represents an IP Address resource.

Google Compute Engine has two IP Address resources:

For more information, see Reserving a static external IP address.

Inheritance

object > Address

Implements

IMessage Address, IEquatable Address, IDeepCloneable Address, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Address()

public Address()

Address(Address)

public Address(Address other)

Parameter
Name	Description
`other`	`Address`

Properties

AddressType

public string AddressType { get; set; }

The type of address to reserve, either INTERNAL orEXTERNAL. If unspecified, defaults to EXTERNAL. Check the AddressType enum for the list of possible values.

Property Value
Type	Description
`string`

Address_

public string Address_ { get; set; }

The static IP address represented by this resource.

Property Value
Type	Description
`string`

CreationTimestamp

public string CreationTimestamp { get; set; }

Output only. [Output Only] Creation timestamp inRFC3339 text format.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

An optional description of this resource. Provide this field when you create the resource.

Property Value
Type	Description
`string`

HasAddressType

public bool HasAddressType { get; }

Gets whether the "address_type" field is set

Property Value
Type	Description
`bool`

HasAddress_

public bool HasAddress_ { get; }

Gets whether the "address" field is set

Property Value
Type	Description
`bool`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasIpCollection

public bool HasIpCollection { get; }

Gets whether the "ip_collection" field is set

Property Value
Type	Description
`bool`

HasIpVersion

public bool HasIpVersion { get; }

Gets whether the "ip_version" field is set

Property Value
Type	Description
`bool`

HasIpv6EndpointType

public bool HasIpv6EndpointType { get; }

Gets whether the "ipv6_endpoint_type" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasLabelFingerprint

public bool HasLabelFingerprint { get; }

Gets whether the "label_fingerprint" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasNetwork

public bool HasNetwork { get; }

Gets whether the "network" field is set

Property Value
Type	Description
`bool`

HasNetworkTier

public bool HasNetworkTier { get; }

Gets whether the "network_tier" field is set

Property Value
Type	Description
`bool`

HasPrefixLength

public bool HasPrefixLength { get; }

Gets whether the "prefix_length" field is set

Property Value
Type	Description
`bool`

HasPurpose

public bool HasPurpose { get; }

Gets whether the "purpose" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HasStatus

public bool HasStatus { get; }

Gets whether the "status" field is set

Property Value
Type	Description
`bool`

HasSubnetwork

public bool HasSubnetwork { get; }

Gets whether the "subnetwork" field is set

Property Value
Type	Description
`bool`

Id

public ulong Id { get; set; }

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
Type	Description
`ulong`

IpCollection

public string IpCollection { get; set; }

Reference to the source of external IPv4 addresses, like a PublicDelegatedPrefix (PDP) for BYOIP. The PDP must support enhanced IPv4 allocations.

Use one of the following formats to specify a PDP when reserving an external IPv4 address using BYOIP.

- Full resource URL, as inhttps://www.googleapis.com/compute/v1/projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name - Partial URL, as in

      - projects/projectId/regions/region/publicDelegatedPrefixes/pdp-name
      - regions/region/publicDelegatedPrefixes/pdp-name

Property Value
Type	Description
`string`

IpVersion

public string IpVersion { get; set; }

The IP version that will be used by this address. Valid options areIPV4 or IPV6. Check the IpVersion enum for the list of possible values.

Property Value
Type	Description
`string`

Ipv6EndpointType

public string Ipv6EndpointType { get; set; }

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. Check the Ipv6EndpointType enum for the list of possible values.

Property Value
Type	Description
`string`

Kind

public string Kind { get; set; }

Output only. [Output Only] Type of the resource. Always compute#address for addresses.

Property Value
Type	Description
`string`

LabelFingerprint

public string LabelFingerprint { get; set; }

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 error412 conditionNotMet.

To see the latest fingerprint, make a get() request to retrieve an Address.

Property Value
Type	Description
`string`

Labels

public MapField<string, string> Labels { get; }

Labels for this resource. These can only be added or modified by thesetLabels method. Each label key/value pair must comply withRFC1035. Label values may be empty.

Property Value
Type	Description
`MapFieldstringstring`

Name

public string Name { get; set; }

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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.

Property Value
Type	Description
`string`

Network

public string Network { get; set; }

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

Property Value
Type	Description
`string`

NetworkTier

public string NetworkTier { get; set; }

This signifies the networking tier used for configuring this address and can only take the following values: PREMIUM orSTANDARD. 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. Check the NetworkTier enum for the list of possible values.

Property Value
Type	Description
`string`

PrefixLength

public int PrefixLength { get; set; }

The prefix length if the resource represents an IP range.

Property Value
Type	Description
`int`

Purpose

public string Purpose { get; set; }

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.

Check the Purpose enum for the list of possible values.

Property Value
Type	Description
`string`

Region

public string Region { get; set; }

Output only. [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.

Property Value
Type	Description
`string`

SelfLink

public string SelfLink { get; set; }

[Output Only] Server-defined URL for the resource.

Property Value
Type	Description
`string`

Status

public string Status { get; set; }

Output only. [Output Only] The status of the address, which can be one ofRESERVING, 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. Check the Status enum for the list of possible values.

Property Value
Type	Description
`string`

Subnetwork

public string Subnetwork { get; set; }

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 aGCE_ENDPOINT or DNS_RESOLVER purpose.

Property Value
Type	Description
`string`

Users

public RepeatedField<string> Users { get; }

[Output Only] The URLs of the resources that are using this address.

Property Value
Type	Description
`RepeatedFieldstring`

Compute Engine v1 API - Class Address (3.21.0) Stay organized with collections Save and categorize content based on your preferences.