Subnetwork

google.cloud.compute.v1. Subnetwork

Represents a Subnetwork.

Constructor

new Subnetwork(propertiesopt)

Constructs a new Subnetwork.

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

Properties to set
Implements:
  • ISubnetwork

Members

_creationTimestamp

Subnetwork _creationTimestamp.

_description

Subnetwork _description.

_enableFlowLogs

Subnetwork _enableFlowLogs.

_externalIpv6Prefix

Subnetwork _externalIpv6Prefix.

_fingerprint

Subnetwork _fingerprint.

_gatewayAddress

Subnetwork _gatewayAddress.

_id

Subnetwork _id.

_internalIpv6Prefix

Subnetwork _internalIpv6Prefix.

_ipCidrRange

Subnetwork _ipCidrRange.

_ipv6AccessType

Subnetwork _ipv6AccessType.

_ipv6CidrRange

Subnetwork _ipv6CidrRange.

_kind

Subnetwork _kind.

_logConfig

Subnetwork _logConfig.

_name

Subnetwork _name.

_network

Subnetwork _network.

_privateIpGoogleAccess

Subnetwork _privateIpGoogleAccess.

_privateIpv6GoogleAccess

Subnetwork _privateIpv6GoogleAccess.

_purpose

Subnetwork _purpose.

_region

Subnetwork _region.

_role

Subnetwork _role.

_selfLink

Subnetwork _selfLink.

_stackType

Subnetwork _stackType.

_state

Subnetwork _state.

creationTimestamp

Subnetwork creationTimestamp.

description

Subnetwork description.

enableFlowLogs

Subnetwork enableFlowLogs.

externalIpv6Prefix

Subnetwork externalIpv6Prefix.

fingerprint

Subnetwork fingerprint.

gatewayAddress

Subnetwork gatewayAddress.

id

Subnetwork id.

internalIpv6Prefix

Subnetwork internalIpv6Prefix.

ipCidrRange

Subnetwork ipCidrRange.

ipv6AccessType

Subnetwork ipv6AccessType.

ipv6CidrRange

Subnetwork ipv6CidrRange.

kind

Subnetwork kind.

logConfig

Subnetwork logConfig.

name

Subnetwork name.

network

Subnetwork network.

privateIpGoogleAccess

Subnetwork privateIpGoogleAccess.

privateIpv6GoogleAccess

Subnetwork privateIpv6GoogleAccess.

purpose

Subnetwork purpose.

region

Subnetwork region.

role

Subnetwork role.

secondaryIpRanges

Subnetwork secondaryIpRanges.

Subnetwork selfLink.

stackType

Subnetwork stackType.

state

Subnetwork state.

Ipv6AccessType

Ipv6AccessType enum.

Properties:
Name Type Description
UNDEFINED_IPV6_ACCESS_TYPE number

UNDEFINED_IPV6_ACCESS_TYPE value
EXTERNAL number

EXTERNAL value
INTERNAL number

INTERNAL value
UNSPECIFIED_IPV6_ACCESS_TYPE number

UNSPECIFIED_IPV6_ACCESS_TYPE value

PrivateIpv6GoogleAccess

PrivateIpv6GoogleAccess enum.

Properties:
Name Type Description
UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS number

UNDEFINED_PRIVATE_IPV6_GOOGLE_ACCESS value
DISABLE_GOOGLE_ACCESS number

DISABLE_GOOGLE_ACCESS value
ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE number

ENABLE_BIDIRECTIONAL_ACCESS_TO_GOOGLE value
ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE number

ENABLE_OUTBOUND_VM_ACCESS_TO_GOOGLE value

Purpose

Purpose enum.

Properties:
Name Type Description
UNDEFINED_PURPOSE number

UNDEFINED_PURPOSE value
INTERNAL_HTTPS_LOAD_BALANCER number

INTERNAL_HTTPS_LOAD_BALANCER value
PRIVATE number

PRIVATE value
PRIVATE_RFC_1918 number

PRIVATE_RFC_1918 value
PRIVATE_SERVICE_CONNECT number

PRIVATE_SERVICE_CONNECT value
REGIONAL_MANAGED_PROXY number

REGIONAL_MANAGED_PROXY value

Role

Role enum.

Properties:
Name Type Description
UNDEFINED_ROLE number

UNDEFINED_ROLE value
ACTIVE number

ACTIVE value
BACKUP number

BACKUP value

StackType

StackType enum.

Properties:
Name Type Description
UNDEFINED_STACK_TYPE number

UNDEFINED_STACK_TYPE value
IPV4_IPV6 number

IPV4_IPV6 value
IPV4_ONLY number

IPV4_ONLY value
UNSPECIFIED_STACK_TYPE number

UNSPECIFIED_STACK_TYPE value

State

State enum.

Properties:
Name Type Description
UNDEFINED_STATE number

UNDEFINED_STATE value
DRAINING number

DRAINING value
READY number

READY value

Methods

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

Converts this Subnetwork to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

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

Creates a new Subnetwork instance using the specified properties.

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

Properties to set
Returns:
Type Description
google.cloud.compute.v1.Subnetwork

Subnetwork instance

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

Decodes a Subnetwork 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.Subnetwork

Subnetwork
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.Subnetwork}

Decodes a Subnetwork 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.Subnetwork

Subnetwork
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 Subnetwork message. Does not implicitly verify messages.

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

Subnetwork 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 Subnetwork message, length delimited. Does not implicitly verify messages.

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

Subnetwork 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.Subnetwork}

Creates a Subnetwork 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.Subnetwork

Subnetwork

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Subnetwork

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 a Subnetwork message. Also converts values to other types if specified.

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

Subnetwork
options $protobuf.IConversionOptions <optional>

Conversion options
Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a Subnetwork 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