Skip to main content

Class: AddOrUpdateRemoteClusterRequest

operatorservice.v1.AddOrUpdateRemoteClusterRequest

Represents an AddOrUpdateRemoteClusterRequest.

Implements

Constructors

constructor

new AddOrUpdateRemoteClusterRequest(properties?): AddOrUpdateRemoteClusterRequest

Constructs a new AddOrUpdateRemoteClusterRequest.

Parameters

NameTypeDescription
properties?IAddOrUpdateRemoteClusterRequestProperties to set

Returns

AddOrUpdateRemoteClusterRequest

Properties

enableRemoteClusterConnection

enableRemoteClusterConnection: boolean

Flag to enable / disable the cross cluster connection.

Implementation of

IAddOrUpdateRemoteClusterRequest.enableRemoteClusterConnection


frontendAddress

frontendAddress: string

Frontend Address is a cross cluster accessible address.

Implementation of

IAddOrUpdateRemoteClusterRequest.frontendAddress

Methods

toJSON

toJSON(): Object

Converts this AddOrUpdateRemoteClusterRequest to JSON.

Returns

Object

JSON object


create

create(properties?): AddOrUpdateRemoteClusterRequest

Creates a new AddOrUpdateRemoteClusterRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?IAddOrUpdateRemoteClusterRequestProperties to set

Returns

AddOrUpdateRemoteClusterRequest

AddOrUpdateRemoteClusterRequest instance


decode

decode(reader, length?): AddOrUpdateRemoteClusterRequest

Decodes an AddOrUpdateRemoteClusterRequest message from the specified reader or buffer.

Parameters

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

Returns

AddOrUpdateRemoteClusterRequest

AddOrUpdateRemoteClusterRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): AddOrUpdateRemoteClusterRequest

Decodes an AddOrUpdateRemoteClusterRequest message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

AddOrUpdateRemoteClusterRequest

AddOrUpdateRemoteClusterRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): AddOrUpdateRemoteClusterRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

AddOrUpdateRemoteClusterRequest

AddOrUpdateRemoteClusterRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for AddOrUpdateRemoteClusterRequest

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 an AddOrUpdateRemoteClusterRequest message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageAddOrUpdateRemoteClusterRequestAddOrUpdateRemoteClusterRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object