Represents an Address.
Package
@google-cloud/computeConstructors
(constructor)(properties)
constructor(properties?: google.cloud.compute.v1small.IAddress);Constructs a new Address.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAddress
Properties to set |
Properties
_address
public _address?: "address";Address _address.
_addressType
public _addressType?: "addressType";Address _addressType.
_creationTimestamp
public _creationTimestamp?: "creationTimestamp";Address _creationTimestamp.
_description
public _description?: "description";Address _description.
_id
public _id?: "id";Address _id.
_ipVersion
public _ipVersion?: "ipVersion";Address _ipVersion.
_kind
public _kind?: "kind";Address _kind.
_name
public _name?: "name";Address _name.
_network
public _network?: "network";Address _network.
_networkTier
public _networkTier?: "networkTier";Address _networkTier.
_prefixLength
public _prefixLength?: "prefixLength";Address _prefixLength.
_purpose
public _purpose?: "purpose";Address _purpose.
_region
public _region?: "region";Address _region.
_selfLink
public _selfLink?: "selfLink";Address _selfLink.
_status
public _status?: "status";Address _status.
_subnetwork
public _subnetwork?: "subnetwork";Address _subnetwork.
address
public address?: (string|null);Address address.
addressType
public addressType?: (string|null);Address addressType.
creationTimestamp
public creationTimestamp?: (string|null);Address creationTimestamp.
description
public description?: (string|null);Address description.
id
public id?: (number|Long|string|null);Address id.
ipVersion
public ipVersion?: (string|null);Address ipVersion.
kind
public kind?: (string|null);Address kind.
name
public name?: (string|null);Address name.
network
public network?: (string|null);Address network.
networkTier
public networkTier?: (string|null);Address networkTier.
prefixLength
public prefixLength?: (number|null);Address prefixLength.
purpose
public purpose?: (string|null);Address purpose.
region
public region?: (string|null);Address region.
selfLink
public selfLink?: (string|null);Address selfLink.
status
public status?: (string|null);Address status.
subnetwork
public subnetwork?: (string|null);Address subnetwork.
users
public users: string[];Address users.
Methods
create(properties)
public static create(properties?: google.cloud.compute.v1small.IAddress): google.cloud.compute.v1small.Address;Creates a new Address instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IAddress
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Address |
Address instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.compute.v1small.Address;Decodes an Address 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 |
Address |
Address |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.compute.v1small.Address;Decodes an Address message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Address |
Address |
encode(message, writer)
public static encode(message: google.cloud.compute.v1small.IAddress, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Address message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAddress
Address 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.v1small.IAddress, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Address message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IAddress
Address 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.v1small.Address;Creates an Address 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 |
Address |
Address |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Address
| 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 Address to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.compute.v1small.Address, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an Address message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Address
Address |
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 an Address message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|