Skip to main content

Class: DeleteConnectivityRuleRequest

cloudservice.v1.DeleteConnectivityRuleRequest

Represents a DeleteConnectivityRuleRequest.

Properties

asyncOperationId

asyncOperationId: string

The id to use for this async operation. Optional, if not provided a random id will be generated.


connectivityRuleId

connectivityRuleId: string

The ID of the connectivity rule that need be deleted, required.


resourceVersion

resourceVersion: string

The resource version which should be the same from the the db, required The latest version can be found in the GetConnectivityRule operation response

Methods

toJSON

toJSON(): Object

Converts this DeleteConnectivityRuleRequest to JSON.

Returns

Object

JSON object


create

create(properties?): DeleteConnectivityRuleRequest & $Properties

Creates a new DeleteConnectivityRuleRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

DeleteConnectivityRuleRequest & $Properties

DeleteConnectivityRuleRequest instance

create(properties?): DeleteConnectivityRuleRequest

Parameters

NameType
properties?$Properties

Returns

DeleteConnectivityRuleRequest


decode

decode(reader, length?): DeleteConnectivityRuleRequest & $Properties

Decodes a DeleteConnectivityRuleRequest message from the specified reader or buffer.

Parameters

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

Returns

DeleteConnectivityRuleRequest & $Properties

DeleteConnectivityRuleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): DeleteConnectivityRuleRequest & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

DeleteConnectivityRuleRequest & $Properties

DeleteConnectivityRuleRequest

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 DeleteConnectivityRuleRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.DeleteConnectivityRuleRequest.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): DeleteConnectivityRuleRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

DeleteConnectivityRuleRequest

DeleteConnectivityRuleRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageDeleteConnectivityRuleRequestDeleteConnectivityRuleRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object