Represents a Spoke.
Package
@google-cloud/network-connectivityConstructors
(constructor)(properties)
constructor(properties?: google.cloud.networkconnectivity.v1alpha1.ISpoke);Constructs a new Spoke.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISpoke
Properties to set |
Properties
createTime
public createTime?: (google.protobuf.ITimestamp|null);Spoke createTime.
description
public description: string;Spoke description.
hub
public hub: string;Spoke hub.
labels
public labels: { [k: string]: string };Spoke labels.
linkedInterconnectAttachments
public linkedInterconnectAttachments: string[];Spoke linkedInterconnectAttachments.
linkedRouterApplianceInstances
public linkedRouterApplianceInstances: google.cloud.networkconnectivity.v1alpha1.IRouterApplianceInstance[];Spoke linkedRouterApplianceInstances.
linkedVpnTunnels
public linkedVpnTunnels: string[];Spoke linkedVpnTunnels.
name
public name: string;Spoke name.
state
public state: (google.cloud.networkconnectivity.v1alpha1.State|keyof typeof google.cloud.networkconnectivity.v1alpha1.State);Spoke state.
uniqueId
public uniqueId: string;Spoke uniqueId.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Spoke updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.networkconnectivity.v1alpha1.ISpoke): google.cloud.networkconnectivity.v1alpha1.Spoke;Creates a new Spoke instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ISpoke
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Spoke | Spoke instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1alpha1.Spoke;Decodes a Spoke 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 |
Spoke | Spoke |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1alpha1.Spoke;Decodes a Spoke message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Spoke | Spoke |
encode(message, writer)
public static encode(message: google.cloud.networkconnectivity.v1alpha1.ISpoke, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Spoke message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISpoke
Spoke 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.networkconnectivity.v1alpha1.ISpoke, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Spoke message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ISpoke
Spoke 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.networkconnectivity.v1alpha1.Spoke;Creates a Spoke 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 |
Spoke | Spoke |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Spoke
| 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 Spoke to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.networkconnectivity.v1alpha1.Spoke, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Spoke message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Spoke
Spoke |
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 Spoke message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|