Skip to main content

Class: RemoveRemoteClusterRequest

operatorservice.v1.RemoveRemoteClusterRequest

Represents a RemoveRemoteClusterRequest.

Implements

Constructors

constructor

new RemoveRemoteClusterRequest(properties?): RemoveRemoteClusterRequest

Constructs a new RemoveRemoteClusterRequest.

Parameters

NameTypeDescription
properties?IRemoveRemoteClusterRequestProperties to set

Returns

RemoveRemoteClusterRequest

Properties

clusterName

clusterName: string

Remote cluster name to be removed.

Implementation of

IRemoveRemoteClusterRequest.clusterName

Methods

toJSON

toJSON(): Object

Converts this RemoveRemoteClusterRequest to JSON.

Returns

Object

JSON object


create

create(properties?): RemoveRemoteClusterRequest

Creates a new RemoveRemoteClusterRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IRemoveRemoteClusterRequestProperties to set

Returns

RemoveRemoteClusterRequest

RemoveRemoteClusterRequest instance


decode

decode(reader, length?): RemoveRemoteClusterRequest

Decodes a RemoveRemoteClusterRequest message from the specified reader or buffer.

Parameters

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

Returns

RemoveRemoteClusterRequest

RemoveRemoteClusterRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): RemoveRemoteClusterRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

RemoveRemoteClusterRequest

RemoveRemoteClusterRequest

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 RemoveRemoteClusterRequest message. Does not implicitly temporal.api.operatorservice.v1.RemoveRemoteClusterRequest.verify|verify messages.

Parameters

NameTypeDescription
messageIRemoveRemoteClusterRequestRemoveRemoteClusterRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified RemoveRemoteClusterRequest message, length delimited. Does not implicitly temporal.api.operatorservice.v1.RemoveRemoteClusterRequest.verify|verify messages.

Parameters

NameTypeDescription
messageIRemoveRemoteClusterRequestRemoveRemoteClusterRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): RemoveRemoteClusterRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

RemoveRemoteClusterRequest

RemoveRemoteClusterRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for RemoveRemoteClusterRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRemoveRemoteClusterRequestRemoveRemoteClusterRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object