Represents a Subnetwork.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1.ISubnetwork);Constructs a new Subnetwork.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISubnetwork
Properties to set |
Properties
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Subnetwork _creationTimestamp.
_description
public _description?: "description";Subnetwork _description.
_enableFlowLogs
public _enableFlowLogs?: "enableFlowLogs";Subnetwork _enableFlowLogs.
_externalIpv6Prefix
public _externalIpv6Prefix?: "externalIpv6Prefix";Subnetwork _externalIpv6Prefix.
_fingerprint
public _fingerprint?: "fingerprint";Subnetwork _fingerprint.
_gatewayAddress
public _gatewayAddress?: "gatewayAddress";Subnetwork _gatewayAddress.
_id
public _id?: "id";Subnetwork _id.
_internalIpv6Prefix
public _internalIpv6Prefix?: "internalIpv6Prefix";Subnetwork _internalIpv6Prefix.
_ipCidrRange
public _ipCidrRange?: "ipCidrRange";Subnetwork _ipCidrRange.
_ipv6AccessType
public _ipv6AccessType?: "ipv6AccessType";Subnetwork _ipv6AccessType.
_ipv6CidrRange
public _ipv6CidrRange?: "ipv6CidrRange";Subnetwork _ipv6CidrRange.
_kind
public _kind?: "kind";Subnetwork _kind.
_logConfig
public _logConfig?: "logConfig";Subnetwork _logConfig.
_name
public _name?: "name";Subnetwork _name.
_network
public _network?: "network";Subnetwork _network.
_privateIpGoogleAccess
public _privateIpGoogleAccess?: "privateIpGoogleAccess";Subnetwork _privateIpGoogleAccess.
_privateIpv6GoogleAccess
public _privateIpv6GoogleAccess?: "privateIpv6GoogleAccess";Subnetwork _privateIpv6GoogleAccess.
_purpose
public _purpose?: "purpose";Subnetwork _purpose.
_region
public _region?: "region";Subnetwork _region.
_reservedInternalRange
public _reservedInternalRange?: "reservedInternalRange";Subnetwork _reservedInternalRange.
_role
public _role?: "role";Subnetwork _role.
_selfLink
public _selfLink?: "selfLink";Subnetwork _selfLink.
_stackType
public _stackType?: "stackType";Subnetwork _stackType.
_state
public _state?: "state";Subnetwork _state.
creationTimestamp
public creationTimestamp?: (string|null);Subnetwork creationTimestamp.
description
public description?: (string|null);Subnetwork description.
enableFlowLogs
public enableFlowLogs?: (boolean|null);Subnetwork enableFlowLogs.
externalIpv6Prefix
public externalIpv6Prefix?: (string|null);Subnetwork externalIpv6Prefix.
fingerprint
public fingerprint?: (string|null);Subnetwork fingerprint.
gatewayAddress
public gatewayAddress?: (string|null);Subnetwork gatewayAddress.
id
public id?: (number|Long|string|null);Subnetwork id.
internalIpv6Prefix
public internalIpv6Prefix?: (string|null);Subnetwork internalIpv6Prefix.
ipCidrRange
public ipCidrRange?: (string|null);Subnetwork ipCidrRange.
ipv6AccessType
public ipv6AccessType?: (string|null);Subnetwork ipv6AccessType.
ipv6CidrRange
public ipv6CidrRange?: (string|null);Subnetwork ipv6CidrRange.
kind
public kind?: (string|null);Subnetwork kind.
logConfig
public logConfig?: (google.cloud.compute.v1.ISubnetworkLogConfig|null);Subnetwork logConfig.
name
public name?: (string|null);Subnetwork name.
network
public network?: (string|null);Subnetwork network.
privateIpGoogleAccess
public privateIpGoogleAccess?: (boolean|null);Subnetwork privateIpGoogleAccess.
privateIpv6GoogleAccess
public privateIpv6GoogleAccess?: (string|null);Subnetwork privateIpv6GoogleAccess.
purpose
public purpose?: (string|null);Subnetwork purpose.
region
public region?: (string|null);Subnetwork region.
reservedInternalRange
public reservedInternalRange?: (string|null);Subnetwork reservedInternalRange.
role
public role?: (string|null);Subnetwork role.
secondaryIpRanges
public secondaryIpRanges: google.cloud.compute.v1.ISubnetworkSecondaryRange[];Subnetwork secondaryIpRanges.
selfLink
public selfLink?: (string|null);Subnetwork selfLink.
stackType
public stackType?: (string|null);Subnetwork stackType.
state
public state?: (string|null);Subnetwork state.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1.ISubnetwork): google.cloud.compute.v1.Subnetwork;Creates a new Subnetwork instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISubnetwork
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Subnetwork |
Subnetwork instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1.Subnetwork;Decodes a Subnetwork message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
Subnetwork |
Subnetwork |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1.Subnetwork;Decodes a Subnetwork message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Subnetwork |
Subnetwork |
encode(message, writer)
public static encode(message: google.cloud.compute.v1.ISubnetwork, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Subnetwork message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISubnetwork
Subnetwork message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.compute.v1.ISubnetwork, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Subnetwork message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISubnetwork
Subnetwork message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer |
Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.compute.v1.Subnetwork;Creates a Subnetwork message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
Subnetwork |
Subnetwork |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Subnetwork
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this Subnetwork to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1.Subnetwork, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Subnetwork message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Subnetwork
Subnetwork |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a Subnetwork message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|