Skip to main content

Class: GetConnectivityRuleRequest

cloudservice.v1.GetConnectivityRuleRequest

Represents a GetConnectivityRuleRequest.

Properties​

connectivityRuleId​

• connectivityRuleId: string

The id of the connectivity rule to get.

Methods​

toJSON​

▸ toJSON(): Object

Converts this GetConnectivityRuleRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): GetConnectivityRuleRequest & $Properties

Creates a new GetConnectivityRuleRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

GetConnectivityRuleRequest & $Properties

GetConnectivityRuleRequest instance

▸ create(properties?): GetConnectivityRuleRequest

Parameters​

NameType
properties?$Properties

Returns​

GetConnectivityRuleRequest


decode​

▸ decode(reader, length?): GetConnectivityRuleRequest & $Properties

Decodes a GetConnectivityRuleRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

GetConnectivityRuleRequest & $Properties

GetConnectivityRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): GetConnectivityRuleRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

GetConnectivityRuleRequest & $Properties

GetConnectivityRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode​

▸ encode(message, writer?): Writer

Encodes the specified GetConnectivityRuleRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.GetConnectivityRuleRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesGetConnectivityRuleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesGetConnectivityRuleRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): GetConnectivityRuleRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

GetConnectivityRuleRequest

GetConnectivityRuleRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageGetConnectivityRuleRequestGetConnectivityRuleRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object