Skip to main content

Class: ConnectivityRule

Represents a ConnectivityRule.

Properties​

asyncOperationId​

asyncOperationId: string

The id of the async operation that is creating/updating/deleting the connectivity rule, if any.

createdTime?​

optional createdTime?: $Properties | null

The date and time when the connectivity rule was created.

id​

id: string

The id of the private connectivity rule.

resourceVersion​

resourceVersion: string

The current version of the connectivity rule specification. The next update operation will have to include this version.

spec?​

optional spec?: $Properties | null

The connectivity rule specification.

state​

state: ResourceState

ConnectivityRule state.

Methods​

toJSON()​

toJSON(): object

Converts this ConnectivityRule to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ConnectivityRule & $Shape

Creates a new ConnectivityRule instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ConnectivityRule & $Shape

ConnectivityRule instance

Call Signature​

static create(properties?): ConnectivityRule

Creates a new ConnectivityRule instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ConnectivityRule

ConnectivityRule instance

decode()​

static decode(reader, length?): ConnectivityRule & $Shape

Decodes a ConnectivityRule message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

ConnectivityRule & $Shape

ConnectivityRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ConnectivityRule & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ConnectivityRule & $Shape

ConnectivityRule

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified ConnectivityRule message. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRule.verify|verify messages.

Parameters​

message​

$Properties

ConnectivityRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified ConnectivityRule message, length delimited. Does not implicitly temporal.api.cloud.connectivityrule.v1.ConnectivityRule.verify|verify messages.

Parameters​

message​

$Properties

ConnectivityRule message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ConnectivityRule

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

ConnectivityRule

ConnectivityRule

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ConnectivityRule

ConnectivityRule

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object