Address

google.cloud.compute.v1. Address

Represents an Address.

Constructor

new Address(propertiesopt)

Constructs a new Address.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IAddress <optional>

Properties to set

Implements:
  • IAddress

Members

_address

Address _address.

_addressType

Address _addressType.

_creationTimestamp

Address _creationTimestamp.

_description

Address _description.

_id

Address _id.

_ipVersion

Address _ipVersion.

_ipv6EndpointType

Address _ipv6EndpointType.

_kind

Address _kind.

_name

Address _name.

_network

Address _network.

_networkTier

Address _networkTier.

_prefixLength

Address _prefixLength.

_purpose

Address _purpose.

_region

Address _region.

Address _selfLink.

_status

Address _status.

_subnetwork

Address _subnetwork.

address

Address address.

addressType

Address addressType.

creationTimestamp

Address creationTimestamp.

description

Address description.

id

Address id.

ipVersion

Address ipVersion.

ipv6EndpointType

Address ipv6EndpointType.

kind

Address kind.

name

Address name.

network

Address network.

networkTier

Address networkTier.

prefixLength

Address prefixLength.

purpose

Address purpose.

region

Address region.

Address selfLink.

status

Address status.

subnetwork

Address subnetwork.

users

Address users.

AddressType

AddressType enum.

Properties:
Name Type Description
UNDEFINED_ADDRESS_TYPE number

UNDEFINED_ADDRESS_TYPE value

EXTERNAL number

EXTERNAL value

INTERNAL number

INTERNAL value

UNSPECIFIED_TYPE number

UNSPECIFIED_TYPE value

IpVersion

IpVersion enum.

Properties:
Name Type Description
UNDEFINED_IP_VERSION number

UNDEFINED_IP_VERSION value

IPV4 number

IPV4 value

IPV6 number

IPV6 value

UNSPECIFIED_VERSION number

UNSPECIFIED_VERSION value

Ipv6EndpointType

Ipv6EndpointType enum.

Properties:
Name Type Description
UNDEFINED_IPV6_ENDPOINT_TYPE number

UNDEFINED_IPV6_ENDPOINT_TYPE value

NETLB number

NETLB value

VM number

VM value

NetworkTier

NetworkTier enum.

Properties:
Name Type Description
UNDEFINED_NETWORK_TIER number

UNDEFINED_NETWORK_TIER value

FIXED_STANDARD number

FIXED_STANDARD value

PREMIUM number

PREMIUM value

STANDARD number

STANDARD value

STANDARD_OVERRIDES_FIXED_STANDARD number

STANDARD_OVERRIDES_FIXED_STANDARD value

Purpose

Purpose enum.

Properties:
Name Type Description
UNDEFINED_PURPOSE number

UNDEFINED_PURPOSE value

DNS_RESOLVER number

DNS_RESOLVER value

GCE_ENDPOINT number

GCE_ENDPOINT value

IPSEC_INTERCONNECT number

IPSEC_INTERCONNECT value

NAT_AUTO number

NAT_AUTO value

PRIVATE_SERVICE_CONNECT number

PRIVATE_SERVICE_CONNECT value

SERVERLESS number

SERVERLESS value

SHARED_LOADBALANCER_VIP number

SHARED_LOADBALANCER_VIP value

VPC_PEERING number

VPC_PEERING value

Status

Status enum.

Properties:
Name Type Description
UNDEFINED_STATUS number

UNDEFINED_STATUS value

IN_USE number

IN_USE value

RESERVED number

RESERVED value

RESERVING number

RESERVING value

Methods

toJSON() → {Object.<string, *>}

Converts this Address to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.compute.v1.Address}

Creates a new Address instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.compute.v1.IAddress <optional>

Properties to set

Returns:
Type Description
google.cloud.compute.v1.Address

Address instance

(static) decode(reader, lengthopt) → {google.cloud.compute.v1.Address}

Decodes an Address message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.compute.v1.Address

Address

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.compute.v1.Address}

Decodes an Address message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.compute.v1.Address

Address

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Address message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IAddress

Address message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Address message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.IAddress

Address message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.compute.v1.Address}

Creates an Address message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.compute.v1.Address

Address

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Address

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an Address message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.compute.v1.Address

Address

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Address message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not