Class protos.google.cloud.networkconnectivity.v1alpha1.Spoke (1.1.6)

Represents a Spoke.

Package

@google-cloud/network-connectivity!

Constructors

(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.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

description

public description: string;

Spoke description.

Property Value

Type	Description
string

hub

public hub: string;

Spoke hub.

Property Value

Type	Description
string

labels

public labels: { [k: string]: string };

Spoke labels.

Property Value

Type	Description
{ [k: string]: string }

linkedInterconnectAttachments

public linkedInterconnectAttachments: string[];

Spoke linkedInterconnectAttachments.

Property Value

Type	Description
string[]

linkedRouterApplianceInstances

public linkedRouterApplianceInstances: google.cloud.networkconnectivity.v1alpha1.IRouterApplianceInstance[];

Spoke linkedRouterApplianceInstances.

Property Value

Type	Description
google.cloud.networkconnectivity.v1alpha1.IRouterApplianceInstance[]

linkedVpnTunnels

public linkedVpnTunnels: string[];

Spoke linkedVpnTunnels.

Property Value

Type	Description
string[]

name

public name: string;

Spoke name.

Property Value

Type	Description
string

state

public state: (google.cloud.networkconnectivity.v1alpha1.State|keyof typeof google.cloud.networkconnectivity.v1alpha1.State);

Spoke state.

Property Value

Type	Description
(google.cloud.networkconnectivity.v1alpha1.State\|keyof typeof google.cloud.networkconnectivity.v1alpha1.State)

uniqueId

public uniqueId: string;

Spoke uniqueId.

Property Value

Type	Description
string

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

Spoke updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

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
google.cloud.networkconnectivity.v1alpha1.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.networkconnectivity.v1alpha1.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	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.networkconnectivity.v1alpha1.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
google.cloud.networkconnectivity.v1alpha1.Spoke	Spoke

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	`google.cloud.networkconnectivity.v1alpha1.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)	`null` if valid, otherwise the reason why it is not