Class: AddOrUpdateRemoteClusterRequest
operatorservice.v1.AddOrUpdateRemoteClusterRequest
Represents an AddOrUpdateRemoteClusterRequest.
Implements
Constructors
constructor
• new AddOrUpdateRemoteClusterRequest(properties?): AddOrUpdateRemoteClusterRequest
Constructs a new AddOrUpdateRemoteClusterRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IAddOrUpdateRemoteClusterRequest | Properties 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 for gRPC traffic. This field is required.
Implementation of
IAddOrUpdateRemoteClusterRequest.frontendAddress
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.
Implementation of
IAddOrUpdateRemoteClusterRequest.frontendHttpAddress
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
| Name | Type | Description |
|---|---|---|
properties? | IAddOrUpdateRemoteClusterRequest | Properties to set |
Returns
AddOrUpdateRemoteClusterRequest
AddOrUpdateRemoteClusterRequest instance
decode
▸ decode(reader, length?): AddOrUpdateRemoteClusterRequest
Decodes an AddOrUpdateRemoteClusterRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message 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
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader 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
| Name | Type | Description |
|---|---|---|
message | IAddOrUpdateRemoteClusterRequest | AddOrUpdateRemoteClusterRequest message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IAddOrUpdateRemoteClusterRequest | AddOrUpdateRemoteClusterRequest message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
AddOrUpdateRemoteClusterRequest
AddOrUpdateRemoteClusterRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for AddOrUpdateRemoteClusterRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your 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
| Name | Type | Description |
|---|---|---|
message | AddOrUpdateRemoteClusterRequest | AddOrUpdateRemoteClusterRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object