Class protos.google.cloud.networkconnectivity.v1.Hub (1.3.0)

Version 1.3.0

• 3.2.0 (latest)
• 2.3.3
• 2.2.0
• 2.1.2
• 1.5.0
• 1.4.2
• 1.3.0
• 1.2.1
• 1.1.6

Represents a Hub.

Package

@google-cloud/network-connectivity!

Constructors

(constructor)(properties)

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

Constructs a new Hub.

Parameter

Name	Description
properties	IHub Properties to set

Properties

createTime

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

Hub createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

description

public description: string;

Hub description.

Property Value

Type	Description
string

labels

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

Hub labels.

Property Value

Type	Description
{ [k: string]: string }

name

public name: string;

Hub name.

Property Value

Type	Description
string

state

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

Hub state.

Property Value

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

uniqueId

public uniqueId: string;

Hub uniqueId.

Property Value

Type	Description
string

updateTime

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

Hub updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

Methods

create(properties)

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

Creates a new Hub instance using the specified properties.

Parameter

Name	Description
properties	IHub Properties to set

Returns

Type	Description
google.cloud.networkconnectivity.v1.Hub	Hub instance

decode(reader, length)

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

Decodes a Hub 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.v1.Hub	Hub

decodeDelimited(reader)

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

Decodes a Hub 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.v1.Hub	Hub

encode(message, writer)

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

Encodes the specified Hub message. Does not implicitly messages.

Parameters

Name	Description
message	IHub Hub 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.v1.IHub, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IHub Hub 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.v1.Hub;

Creates a Hub 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.v1.Hub	Hub

toJSON()

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

Converts this Hub to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.networkconnectivity.v1.Hub Hub
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 Hub 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