temporalio 0.0.0 → 0.0.2

data/bridge/sdk-core/protos/api_upstream/temporal/api/interaction/v1/message.proto

@@ -0,0 +1,87 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.interaction.v1;
+
+option go_package = "go.temporal.io/api/interaction/v1;interaction";
+option java_package = "io.temporal.api.interaction.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Interaction::V1";
+option csharp_namespace = "Temporalio.Api.Interaction.V1";
+
+import "temporal/api/common/v1/message.proto";
+import "temporal/api/failure/v1/message.proto";
+import "temporal/api/enums/v1/interaction_type.proto";
+
+// Meta carries metadata about an interaction for use by the system (i.e. not
+// generall user-visible)
+message Meta {
+    // An ID with workflow-scoped uniqueness for this interaction
+    string id = 1;
+
+    // The event ID after which this interaction can execute. The effects of
+    // history up to and including this event ID should be visible to the
+    // interaction when it executes.
+    int64 event_id = 2;
+
+    // The type of this interaction.
+    temporal.api.enums.v1.InteractionType interaction_type = 3;
+
+    // A string identifying the agent that requested this interaction.
+    string identity = 4;
+
+    string request_id = 5;
+}
+
+// Input carries interaction input that comes from the caller.
+message Input {
+    // Headers that are passed with the interaction to and from the processing workflow.
+    // These can include things like auth or tracing tokens.
+    temporal.api.common.v1.Header header = 1;
+
+    // The name of the input handler to invoke on the target workflow
+    string name = 2;
+
+    // The arguments to pass to the named handler.
+    temporal.api.common.v1.Payloads args = 3;
+}
+
+
+// Output carries the output data from an interaction.
+message Output {
+    // Headers that are passed with the interaction to and from the processing workflow.
+    // These can include things like auth or tracing tokens.
+    temporal.api.common.v1.Header header = 1;
+
+    oneof result {
+        temporal.api.common.v1.Payloads success = 2;
+        temporal.api.failure.v1.Failure failure = 3;
+    }
+}
+
+message Invocation {
+    Meta meta = 1;
+    Input input = 2;
+}

data/bridge/sdk-core/protos/api_upstream/temporal/api/namespace/v1/message.proto

@@ -0,0 +1,97 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.namespace.v1;
+
+option go_package = "go.temporal.io/api/namespace/v1;namespace";
+option java_package = "io.temporal.api.namespace.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Namespace::V1";
+option csharp_namespace = "Temporalio.Api.Namespace.V1";
+
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+
+import "dependencies/gogoproto/gogo.proto";
+
+import "temporal/api/enums/v1/namespace.proto";
+
+
+message NamespaceInfo {
+    string name = 1;
+    temporal.api.enums.v1.NamespaceState state = 2;
+    string description = 3;
+    string owner_email = 4;
+    // A key-value map for any customized purpose.
+    map<string, string> data = 5;
+    string id = 6;
+
+    // Whether scheduled workflows are supported on this namespace. This is only needed
+    // temporarily while the feature is experimental, so we can give it a high tag.
+    bool supports_schedules = 100;
+}
+
+message NamespaceConfig {
+    google.protobuf.Duration workflow_execution_retention_ttl = 1 [(gogoproto.stdduration) = true];
+    BadBinaries bad_binaries = 2;
+    // If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
+    temporal.api.enums.v1.ArchivalState history_archival_state = 3;
+    string history_archival_uri = 4;
+    // If unspecified (ARCHIVAL_STATE_UNSPECIFIED) then default server configuration is used.
+    temporal.api.enums.v1.ArchivalState visibility_archival_state = 5;
+    string visibility_archival_uri = 6;
+}
+
+message BadBinaries {
+    map<string, BadBinaryInfo> binaries = 1;
+}
+
+message BadBinaryInfo {
+    string reason = 1;
+    string operator = 2;
+    google.protobuf.Timestamp create_time = 3 [(gogoproto.stdtime) = true];
+}
+
+message UpdateNamespaceInfo {
+    string description = 1;
+    string owner_email = 2;
+    // A key-value map for any customized purpose.
+    // If data already exists on the namespace, 
+    // this will merge with the existing key values. 
+    map<string, string> data = 3;
+    // New namespace state, server will reject if transition is not allowed.
+    // Allowed transitions are:
+    //  Registered -> [ Deleted | Deprecated | Handover ]
+    //  Handover -> [ Registered ]
+    // Default is NAMESPACE_STATE_UNSPECIFIED which is do not change state.
+    temporal.api.enums.v1.NamespaceState state = 4;
+}
+
+message NamespaceFilter {
+    // By default namespaces in NAMESPACE_STATE_DELETED state are not included.
+    // Setting include_deleted to true will include deleted namespaces.
+    // Note: Namespace is in NAMESPACE_STATE_DELETED state when it was deleted from the system but associated data is not deleted yet.
+    bool include_deleted = 1;
+}

data/bridge/sdk-core/protos/api_upstream/temporal/api/operatorservice/v1/request_response.proto

@@ -0,0 +1,121 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.operatorservice.v1;
+
+option go_package = "go.temporal.io/api/operatorservice/v1;operatorservice";
+option java_package = "io.temporal.api.operatorservice.v1";
+option java_multiple_files = true;
+option java_outer_classname = "RequestResponseProto";
+option ruby_package = "Temporalio::Api::OperatorService::V1";
+option csharp_namespace = "Temporalio.Api.OperatorService.V1";
+
+import "temporal/api/enums/v1/common.proto";
+
+// (-- Search Attribute --)
+
+message AddSearchAttributesRequest {
+    // Mapping between search attribute name and its IndexedValueType.
+    map<string, temporal.api.enums.v1.IndexedValueType> search_attributes = 1;
+}
+
+message AddSearchAttributesResponse {
+}
+
+message RemoveSearchAttributesRequest {
+    // Search attribute names to delete.
+    repeated string search_attributes = 1;
+}
+
+message RemoveSearchAttributesResponse {
+}
+
+message ListSearchAttributesRequest {
+}
+
+message ListSearchAttributesResponse {
+    // Mapping between custom (user-registered) search attribute name to its IndexedValueType.
+    map<string, temporal.api.enums.v1.IndexedValueType> custom_attributes = 1;
+    // Mapping between system (predefined) search attribute name to its IndexedValueType.
+    map<string, temporal.api.enums.v1.IndexedValueType> system_attributes = 2;
+    // Mapping from the attribute name to the visibility storage native type.
+    map<string, string> storage_schema = 3;
+}
+
+// (-- api-linter: core::0135::request-unknown-fields=disabled
+//     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
+// (-- api-linter: core::0135::request-name-required=disabled
+//     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
+message DeleteNamespaceRequest {
+    string namespace = 1;
+}
+
+message DeleteNamespaceResponse {
+    // Temporary namespace name that is used during reclaim resources step.
+    string deleted_namespace = 1;
+}
+
+message AddOrUpdateRemoteClusterRequest {
+    // Frontend Address is a cross cluster accessible address.
+    string frontend_address = 1;
+    // Flag to enable / disable the cross cluster connection.
+    bool enable_remote_cluster_connection = 2;
+}
+
+message AddOrUpdateRemoteClusterResponse {
+}
+
+message RemoveRemoteClusterRequest {
+    // Remote cluster name to be removed.
+    string cluster_name = 1;
+}
+
+message RemoveRemoteClusterResponse {
+}
+
+message ListClustersRequest {
+    int32 page_size = 1;
+    bytes next_page_token = 2;
+}
+
+message ListClustersResponse {
+    // List of all cluster information
+    repeated ClusterMetadata clusters = 1;
+    bytes next_page_token = 4;
+}
+
+message ClusterMetadata {
+    // Name of the cluster name.
+    string cluster_name = 1;
+    // Id of the cluster.
+    string cluster_id = 2;
+    // Cluster accessible address.
+    string address = 3;
+    // A unique failover version across all connected clusters.
+    int64 initial_failover_version = 4;
+    // History service shard number.
+    int32 history_shard_count = 5;
+    // A flag to indicate if a connection is active.
+    bool is_connection_enabled = 6;
+}

data/bridge/sdk-core/protos/api_upstream/temporal/api/operatorservice/v1/service.proto

@@ -0,0 +1,80 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.operatorservice.v1;
+
+option go_package = "go.temporal.io/api/operatorservice/v1;operatorservice";
+option java_package = "io.temporal.api.operatorservice.v1";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option ruby_package = "Temporalio::Api::OperatorService::V1";
+option csharp_namespace = "Temporalio.Api.OperatorService.V1";
+
+
+import "temporal/api/operatorservice/v1/request_response.proto";
+
+// OperatorService API defines how Temporal SDKs and other clients interact with the Temporal server
+// to perform administrative functions like registering a search attribute or a namespace.
+// APIs in this file could be not compatible with Temporal Cloud, hence it's usage in SDKs should be limited by
+// designated APIs that clearly state that they shouldn't be used by the main Application (Workflows & Activities) framework.
+service OperatorService {
+    // (-- Search Attribute --)
+
+    // AddSearchAttributes add custom search attributes.
+    //
+    // Returns ALREADY_EXISTS status code if a Search Attribute with any of the specified names already exists
+    // Returns INTERNAL status code with temporal.api.errordetails.v1.SystemWorkflowFailure in Error Details if registration process fails,
+    rpc AddSearchAttributes (AddSearchAttributesRequest) returns (AddSearchAttributesResponse) {
+    }
+
+    // RemoveSearchAttributes removes custom search attributes.
+    //
+    // Returns NOT_FOUND status code if a Search Attribute with any of the specified names is not registered
+    rpc RemoveSearchAttributes (RemoveSearchAttributesRequest) returns (RemoveSearchAttributesResponse) {
+    }
+
+    // ListSearchAttributes returns comprehensive information about search attributes.
+    rpc ListSearchAttributes (ListSearchAttributesRequest) returns (ListSearchAttributesResponse) {
+    }
+
+    // DeleteNamespace synchronously deletes a namespace and asynchronously reclaims all namespace resources.
+    // (-- api-linter: core::0135::method-signature=disabled
+    //     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
+    // (-- api-linter: core::0135::response-message-name=disabled
+    //     aip.dev/not-precedent: DeleteNamespace RPC doesn't follow Google API format. --)
+    rpc DeleteNamespace (DeleteNamespaceRequest) returns (DeleteNamespaceResponse) {
+    }
+
+    // AddOrUpdateRemoteCluster adds or updates remote cluster.
+    rpc AddOrUpdateRemoteCluster(AddOrUpdateRemoteClusterRequest) returns (AddOrUpdateRemoteClusterResponse) {
+    }
+
+    // RemoveRemoteCluster removes remote cluster.
+    rpc RemoveRemoteCluster(RemoveRemoteClusterRequest) returns (RemoveRemoteClusterResponse) {
+    }
+
+    // ListClusters returns information about Temporal clusters.
+    rpc ListClusters(ListClustersRequest) returns (ListClustersResponse) {
+    }
+}

data/bridge/sdk-core/protos/api_upstream/temporal/api/query/v1/message.proto

@@ -0,0 +1,61 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.query.v1;
+
+option go_package = "go.temporal.io/api/query/v1;query";
+option java_package = "io.temporal.api.query.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Query::V1";
+option csharp_namespace = "Temporalio.Api.Query.V1";
+
+import "temporal/api/enums/v1/query.proto";
+import "temporal/api/enums/v1/workflow.proto";
+import "temporal/api/common/v1/message.proto";
+
+// See https://docs.temporal.io/docs/concepts/queries/
+message WorkflowQuery {
+    // The workflow-author-defined identifier of the query. Typically a function name.
+    string query_type = 1;
+    // Serialized arguments that will be provided to the query handler.
+    temporal.api.common.v1.Payloads query_args = 2;
+    // Headers that were passed by the caller of the query and copied by temporal 
+    // server into the workflow task.
+    temporal.api.common.v1.Header header = 3;
+}
+
+// Answer to a `WorkflowQuery`
+message WorkflowQueryResult {
+    // Did the query succeed or fail?
+    temporal.api.enums.v1.QueryResultType result_type = 1;
+    // Set when the query succeeds with the results
+    temporal.api.common.v1.Payloads answer = 2;
+    // Mutually exclusive with `answer`. Set when the query fails.
+    string error_message = 3;
+}
+
+message QueryRejected {
+    temporal.api.enums.v1.WorkflowExecutionStatus status = 1;
+}

data/bridge/sdk-core/protos/api_upstream/temporal/api/replication/v1/message.proto

@@ -0,0 +1,55 @@
+// The MIT License
+//
+// Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+syntax = "proto3";
+
+package temporal.api.replication.v1;
+
+option go_package = "go.temporal.io/api/replication/v1;replication";
+option java_package = "io.temporal.api.replication.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Replication::V1";
+option csharp_namespace = "Temporalio.Api.Replication.V1";
+
+import "google/protobuf/timestamp.proto";
+
+import "dependencies/gogoproto/gogo.proto";
+
+import "temporal/api/enums/v1/namespace.proto";
+
+message ClusterReplicationConfig {
+    string cluster_name = 1;
+}
+
+message NamespaceReplicationConfig {
+    string active_cluster_name = 1;
+    repeated ClusterReplicationConfig clusters = 2;
+    temporal.api.enums.v1.ReplicationState state = 3;
+}
+
+// Represents a historical replication status of a Namespace
+message FailoverStatus {
+    // Timestamp when the Cluster switched to the following failover_version
+    google.protobuf.Timestamp failover_time = 1 [(gogoproto.stdtime) = true];
+    int64 failover_version = 2;
+}