temporal_sdk_operator (temporal_sdk v0.1.18)

View Source

Temporal operator services module.

WIP. Module will provide following Temporal services:

  • add_search_attributes

  • remove_search_attributes

  • list_search_attributes

  • register_namespace

  • list_namespaces

  • describe_namespace

  • update_namespace

  • delete_namespace

  • 'GetNexusEndpoint'

  • 'CreateNexusEndpoint'

  • 'UpdateNexusEndpoint'

  • 'DeleteNexusEndpoint'

  • 'ListNexusEndpoints'

  • 'ListWorkers'

  • 'FetchWorkerConfig'

  • 'UpdateWorkerConfig'

  • 'DescribeWorker'

  • 'UpdateTaskQueueConfig'

  • 'AddOrUpdateRemoteCluster'

  • 'RemoveRemoteCluster'

  • 'ListClusters'

Summary

Types

create_nexus_endpoint_opts()

Functions

add_or_update_remote_cluster(Cluster, Request)
create_nexus_endpoint(Cluster, Name, Opts)
list_clusters(Cluster, Request)
remove_remote_cluster(Cluster, Request)

Types

create_nexus_endpoint_opts()

-type create_nexus_endpoint_opts() ::
          [{name, unicode:chardata()} |
           {description, temporal_sdk:term_to_payload()} |
           {worker_target_namespace, unicode:chardata()} |
           {worker_target_task_queue, unicode:chardata()} |
           {external_target_url, unicode:chardata()}].

Functions

add_or_update_remote_cluster(Cluster, Request)

-spec add_or_update_remote_cluster(Cluster :: temporal_sdk_cluster:cluster_name(),
                                   Request ::
                                       temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.AddOrUpdateRemoteClusterRequest'()) ->
                                      {ok,
                                       temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.AddOrUpdateRemoteClusterResponse'()} |
                                      temporal_sdk_client:call_result_error().

create_nexus_endpoint(Cluster, Name, Opts)

-spec create_nexus_endpoint(Cluster :: temporal_sdk_cluster:cluster_name(),
                            Name :: unicode:chardata(),
                            Opts :: create_nexus_endpoint_opts()) ->
                               {ok,
                                temporal_sdk_proto_service_workflow_binaries:'temporal.api.nexus.v1.Endpoint'()} |
                               temporal_sdk:call_response_error().

list_clusters(Cluster, Request)

-spec list_clusters(Cluster :: temporal_sdk_cluster:cluster_name(),
                    Request ::
                        temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.ListClustersRequest'()) ->
                       {ok,
                        temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.ListClustersResponse'()} |
                       temporal_sdk_client:call_result_error().

remove_remote_cluster(Cluster, Request)

-spec remove_remote_cluster(Cluster :: temporal_sdk_cluster:cluster_name(),
                            Request ::
                                temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.RemoveRemoteClusterRequest'()) ->
                               {ok,
                                temporal_sdk_proto_service_operator_binaries:'temporal.api.operatorservice.v1.RemoveRemoteClusterResponse'()} |
                               temporal_sdk_client:call_result_error().