Class: Temporalio::Client::Connection::OperatorService

Inherits:
Service
  • Object
show all
Defined in:
lib/temporalio/client/connection/operator_service.rb

Overview

OperatorService API.

Instance Method Summary collapse

Instance Method Details

#add_or_update_remote_cluster(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::AddOrUpdateRemoteClusterResponse

Calls OperatorService.AddOrUpdateRemoteCluster API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::AddOrUpdateRemoteClusterRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 102

def add_or_update_remote_cluster(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'add_or_update_remote_cluster',
    request_class: Temporalio::Api::OperatorService::V1::AddOrUpdateRemoteClusterRequest,
    response_class: Temporalio::Api::OperatorService::V1::AddOrUpdateRemoteClusterResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#add_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::AddSearchAttributesResponse

Calls OperatorService.AddSearchAttributes API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::AddSearchAttributesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 26

def add_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'add_search_attributes',
    request_class: Temporalio::Api::OperatorService::V1::AddSearchAttributesRequest,
    response_class: Temporalio::Api::OperatorService::V1::AddSearchAttributesResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#create_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::CreateNexusEndpointResponse

Calls OperatorService.CreateNexusEndpoint API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::CreateNexusEndpointRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 178

def create_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'create_nexus_endpoint',
    request_class: Temporalio::Api::OperatorService::V1::CreateNexusEndpointRequest,
    response_class: Temporalio::Api::OperatorService::V1::CreateNexusEndpointResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#delete_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::DeleteNamespaceResponse

Calls OperatorService.DeleteNamespace API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::DeleteNamespaceRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 83

def delete_namespace(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'delete_namespace',
    request_class: Temporalio::Api::OperatorService::V1::DeleteNamespaceRequest,
    response_class: Temporalio::Api::OperatorService::V1::DeleteNamespaceResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#delete_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::DeleteNexusEndpointResponse

Calls OperatorService.DeleteNexusEndpoint API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::DeleteNexusEndpointRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 216

def delete_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'delete_nexus_endpoint',
    request_class: Temporalio::Api::OperatorService::V1::DeleteNexusEndpointRequest,
    response_class: Temporalio::Api::OperatorService::V1::DeleteNexusEndpointResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#get_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::GetNexusEndpointResponse

Calls OperatorService.GetNexusEndpoint API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::GetNexusEndpointRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 159

def get_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'get_nexus_endpoint',
    request_class: Temporalio::Api::OperatorService::V1::GetNexusEndpointRequest,
    response_class: Temporalio::Api::OperatorService::V1::GetNexusEndpointResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#list_clusters(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::ListClustersResponse

Calls OperatorService.ListClusters API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::ListClustersRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 140

def list_clusters(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'list_clusters',
    request_class: Temporalio::Api::OperatorService::V1::ListClustersRequest,
    response_class: Temporalio::Api::OperatorService::V1::ListClustersResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#list_nexus_endpoints(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::ListNexusEndpointsResponse

Calls OperatorService.ListNexusEndpoints API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::ListNexusEndpointsRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 235

def list_nexus_endpoints(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'list_nexus_endpoints',
    request_class: Temporalio::Api::OperatorService::V1::ListNexusEndpointsRequest,
    response_class: Temporalio::Api::OperatorService::V1::ListNexusEndpointsResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#list_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::ListSearchAttributesResponse

Calls OperatorService.ListSearchAttributes API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::ListSearchAttributesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 64

def list_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'list_search_attributes',
    request_class: Temporalio::Api::OperatorService::V1::ListSearchAttributesRequest,
    response_class: Temporalio::Api::OperatorService::V1::ListSearchAttributesResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#remove_remote_cluster(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::RemoveRemoteClusterResponse

Calls OperatorService.RemoveRemoteCluster API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::RemoveRemoteClusterRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 121

def remove_remote_cluster(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'remove_remote_cluster',
    request_class: Temporalio::Api::OperatorService::V1::RemoveRemoteClusterRequest,
    response_class: Temporalio::Api::OperatorService::V1::RemoveRemoteClusterResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#remove_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::RemoveSearchAttributesResponse

Calls OperatorService.RemoveSearchAttributes API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::RemoveSearchAttributesRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 45

def remove_search_attributes(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'remove_search_attributes',
    request_class: Temporalio::Api::OperatorService::V1::RemoveSearchAttributesRequest,
    response_class: Temporalio::Api::OperatorService::V1::RemoveSearchAttributesResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end

#update_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil) ⇒ Temporalio::Api::OperatorService::V1::UpdateNexusEndpointResponse

Calls OperatorService.UpdateNexusEndpoint API call.

Parameters:

  • request (Temporalio::Api::OperatorService::V1::UpdateNexusEndpointRequest) —

    API request.

  • rpc_retry (Boolean) (defaults to: false) —

    Whether to implicitly retry known retryable errors.

  • rpc_metadata (Hash<String, String>, nil) (defaults to: nil) —

    Headers to include on the RPC call.

  • rpc_timeout (Float, nil) (defaults to: nil) —

    Number of seconds before timeout.

Returns:



197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/temporalio/client/connection/operator_service.rb', line 197

def update_nexus_endpoint(request, rpc_retry: false, rpc_metadata: nil, rpc_timeout: nil)
  invoke_rpc(
    rpc: 'update_nexus_endpoint',
    request_class: Temporalio::Api::OperatorService::V1::UpdateNexusEndpointRequest,
    response_class: Temporalio::Api::OperatorService::V1::UpdateNexusEndpointResponse,
    request:,
    rpc_retry:,
    rpc_metadata:,
    rpc_timeout:
  )
end