Class: AddOrUpdateRemoteClusterRequest
Represents an AddOrUpdateRemoteClusterRequest.
Properties
enableRemoteClusterConnection
enableRemoteClusterConnection:
boolean
Flag to enable / disable the cross cluster connection.
enableReplication
enableReplication:
boolean
Controls whether replication streams are active.
frontendAddress
frontendAddress:
string
Frontend Address is a cross cluster accessible address for gRPC traffic. This field is required.
frontendHttpAddress
frontendHttpAddress:
string
Frontend HTTP Address is a cross cluster accessible address for HTTP traffic. This field is optional. If not provided on update, the existing HTTP address will be removed.
Methods
toJSON()
toJSON():
object
Converts this AddOrUpdateRemoteClusterRequest to JSON.
Returns
object
JSON object
create()
Call Signature
staticcreate(properties?):AddOrUpdateRemoteClusterRequest&$Properties
Creates a new AddOrUpdateRemoteClusterRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
AddOrUpdateRemoteClusterRequest & $Properties
AddOrUpdateRemoteClusterRequest instance
Call Signature
staticcreate(properties?):AddOrUpdateRemoteClusterRequest
Creates a new AddOrUpdateRemoteClusterRequest instance using the specified properties.
Parameters
properties?
Properties to set
Returns
AddOrUpdateRemoteClusterRequest
AddOrUpdateRemoteClusterRequest instance
decode()
staticdecode(reader,length?):AddOrUpdateRemoteClusterRequest&$Properties
Decodes an AddOrUpdateRemoteClusterRequest 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
AddOrUpdateRemoteClusterRequest & $Properties
AddOrUpdateRemoteClusterRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited()
staticdecodeDelimited(reader):AddOrUpdateRemoteClusterRequest&$Properties
Decodes an AddOrUpdateRemoteClusterRequest message from the specified reader or buffer, length delimited.
Parameters
reader
Uint8Array<ArrayBufferLike> | Reader
Reader or buffer to decode from
Returns
AddOrUpdateRemoteClusterRequest & $Properties
AddOrUpdateRemoteClusterRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
encode()
staticencode(message,writer?):Writer
Encodes the specified AddOrUpdateRemoteClusterRequest message. Does not implicitly temporal.api.operatorservice.v1.AddOrUpdateRemoteClusterRequest.verify|verify messages.
Parameters
message
AddOrUpdateRemoteClusterRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
encodeDelimited()
staticencodeDelimited(message,writer?):Writer
Encodes the specified AddOrUpdateRemoteClusterRequest message, length delimited. Does not implicitly temporal.api.operatorservice.v1.AddOrUpdateRemoteClusterRequest.verify|verify messages.
Parameters
message
AddOrUpdateRemoteClusterRequest message or plain object to encode
writer?
Writer
Writer to encode to
Returns
Writer
Writer
fromObject()
staticfromObject(object):AddOrUpdateRemoteClusterRequest
Creates an AddOrUpdateRemoteClusterRequest message from a plain object. Also converts values to their respective internal types.
Parameters
object
Plain object
Returns
AddOrUpdateRemoteClusterRequest
AddOrUpdateRemoteClusterRequest
toObject()
statictoObject(message,options?):object
Creates a plain object from an AddOrUpdateRemoteClusterRequest message. Also converts values to other types if specified.
Parameters
message
AddOrUpdateRemoteClusterRequest
AddOrUpdateRemoteClusterRequest
options?
IConversionOptions
Conversion options
Returns
object
Plain object