Class protos.google.cloud.networkconnectivity.v1alpha1.Hub

Represents a Hub.

Package

@google-cloud/network-connectivity

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.networkconnectivity.v1alpha1.IHub);

Constructs a new Hub.

Parameter
NameDescription
properties IHub

Properties to set

Properties

createTime

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

Hub createTime.

description

public description: string;

Hub description.

labels

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

Hub labels.

name

public name: string;

Hub name.

spokes

public spokes: string[];

Hub spokes.

state

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

Hub state.

uniqueId

public uniqueId: string;

Hub uniqueId.

updateTime

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

Hub updateTime.

Methods

create(properties)

public static create(properties?: google.cloud.networkconnectivity.v1alpha1.IHub): google.cloud.networkconnectivity.v1alpha1.Hub;

Creates a new Hub instance using the specified properties.

Parameter
NameDescription
properties IHub

Properties to set

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.Hub

Hub instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.networkconnectivity.v1alpha1.Hub;

Decodes a Hub message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.Hub

Hub

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.networkconnectivity.v1alpha1.Hub;

Decodes a Hub message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.Hub

Hub

encode(message, writer)

public static encode(message: google.cloud.networkconnectivity.v1alpha1.IHub, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Hub message. Does not implicitly messages.

Parameters
NameDescription
message IHub

Hub message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.networkconnectivity.v1alpha1.IHub, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Hub message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IHub

Hub message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.networkconnectivity.v1alpha1.Hub;

Creates a Hub message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.networkconnectivity.v1alpha1.Hub

Hub

toJSON()

public toJSON(): { [k: string]: any };

Converts this Hub to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.networkconnectivity.v1alpha1.Hub, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a Hub message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.networkconnectivity.v1alpha1.Hub

Hub

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Hub message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not