@temporalio/core-bridge 1.10.2 → 1.11.0

package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/cloudservice/v1/service.proto

@@ -0,0 +1,263 @@
+syntax = "proto3";
+
+package temporal.api.cloud.cloudservice.v1;
+
+option go_package = "go.temporal.io/api/cloud/cloudservice/v1;cloudservice";
+option java_package = "io.temporal.api.cloud.cloudservice.v1";
+option java_multiple_files = true;
+option java_outer_classname = "ServiceProto";
+option ruby_package = "Temporalio::Api::Cloud::CloudService::V1";
+option csharp_namespace = "Temporalio.Api.Cloud.CloudService.V1";
+
+import "temporal/api/cloud/cloudservice/v1/request_response.proto";
+import "google/api/annotations.proto";
+
+// WARNING: This service is currently experimental and may change in
+// incompatible ways.
+service CloudService {
+    // Gets all known users
+    rpc GetUsers(GetUsersRequest) returns (GetUsersResponse) {
+        option (google.api.http) = {
+            get: "/cloud/users",
+        };
+    }
+    
+    // Get a user
+    rpc GetUser(GetUserRequest) returns (GetUserResponse) {
+        option (google.api.http) = {
+            get: "/cloud/users/{user_id}",
+        };
+    }
+
+    // Create a user
+    rpc CreateUser(CreateUserRequest) returns (CreateUserResponse) {
+        option (google.api.http) = {
+            post: "/cloud/users",
+            body: "*"
+        };
+    }
+
+    // Update a user
+    rpc UpdateUser(UpdateUserRequest) returns (UpdateUserResponse) {
+        option (google.api.http) = {
+            post: "/cloud/users/{user_id}",
+            body: "*"
+        };
+    }
+
+    // Delete a user
+    rpc DeleteUser(DeleteUserRequest) returns (DeleteUserResponse) {
+        option (google.api.http) = {
+            delete: "/cloud/users/{user_id}",
+        };
+    }
+
+    // Set a user's access to a namespace
+    rpc SetUserNamespaceAccess(SetUserNamespaceAccessRequest) returns (SetUserNamespaceAccessResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}/users/{user_id}/access",
+            body: "*"
+        };
+    }
+
+    // Get the latest information on an async operation
+    rpc GetAsyncOperation(GetAsyncOperationRequest) returns (GetAsyncOperationResponse) {
+        option (google.api.http) = {
+            get: "/cloud/operations/{async_operation_id}",
+        };
+    }
+
+    // Create a new namespace
+    rpc CreateNamespace (CreateNamespaceRequest) returns (CreateNamespaceResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces",
+            body: "*"
+        };
+    }
+    
+    // Get all namespaces
+    rpc GetNamespaces (GetNamespacesRequest)  returns (GetNamespacesResponse) {
+        option (google.api.http) = {
+            get: "/cloud/namespaces",
+        };
+    }
+
+    // Get a namespace
+    rpc GetNamespace (GetNamespaceRequest) returns (GetNamespaceResponse) {
+        option (google.api.http) = {
+            get: "/cloud/namespaces/{namespace}",
+        };
+    }
+
+    // Update a namespace
+    rpc UpdateNamespace (UpdateNamespaceRequest) returns (UpdateNamespaceResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}",
+            body: "*"
+        };
+    }
+
+    // Rename an existing customer search attribute
+    rpc RenameCustomSearchAttribute (RenameCustomSearchAttributeRequest) returns (RenameCustomSearchAttributeResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}/rename-custom-search-attribute",
+            body: "*"
+        };
+    }
+
+    // Delete a namespace
+    rpc DeleteNamespace (DeleteNamespaceRequest) returns (DeleteNamespaceResponse) {
+        option (google.api.http) = {
+            delete: "/cloud/namespaces/{namespace}",
+        };
+    }
+
+    // Failover a multi-region namespace
+    rpc FailoverNamespaceRegion (FailoverNamespaceRegionRequest) returns (FailoverNamespaceRegionResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}/failover-region",
+            body: "*"
+        };
+    }
+
+    // Add a new region to a namespace
+    rpc AddNamespaceRegion (AddNamespaceRegionRequest) returns (AddNamespaceRegionResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}/add-region",
+            body: "*"
+        };
+    }
+
+    // Get all regions
+    rpc GetRegions (GetRegionsRequest) returns (GetRegionsResponse) {
+        option (google.api.http) = {
+            get: "/cloud/regions",
+        };
+    }
+
+    // Get a region
+    rpc GetRegion (GetRegionRequest) returns (GetRegionResponse) {
+        option (google.api.http) = {
+            get: "/cloud/regions/{region}",
+        };
+    }
+
+    // Get all known API keys
+    rpc GetApiKeys (GetApiKeysRequest) returns (GetApiKeysResponse) {
+        option (google.api.http) = {
+            get: "/cloud/api-keys",
+        };
+    }
+
+    // Get an API key
+    rpc GetApiKey (GetApiKeyRequest) returns (GetApiKeyResponse) {
+        option (google.api.http) = {
+            get: "/cloud/api-keys/{key_id}",
+        };
+    }
+
+    // Create an API key
+    rpc CreateApiKey (CreateApiKeyRequest) returns (CreateApiKeyResponse) {
+        option (google.api.http) = {
+            post: "/cloud/api-keys",
+            body: "*"
+        };
+    }
+
+    // Update an API key
+    rpc UpdateApiKey (UpdateApiKeyRequest) returns (UpdateApiKeyResponse) {
+        option (google.api.http) = {
+            post: "/cloud/api-keys/{key_id}",
+            body: "*"
+        };
+    }
+
+    // Delete an API key
+    rpc DeleteApiKey (DeleteApiKeyRequest) returns (DeleteApiKeyResponse) {
+        option (google.api.http) = {
+            delete: "/cloud/api-keys/{key_id}",
+        };
+    }
+
+    // Get all user groups
+    rpc GetUserGroups (GetUserGroupsRequest) returns (GetUserGroupsResponse) {
+        option (google.api.http) = {
+            get: "/cloud/user-groups",
+        };
+    }
+
+    // Get a user group
+    rpc GetUserGroup (GetUserGroupRequest) returns (GetUserGroupResponse) {
+        option (google.api.http) = {
+            get: "/cloud/user-groups/{group_id}",
+        };
+    }
+
+    // Create new a user group
+    rpc CreateUserGroup (CreateUserGroupRequest) returns (CreateUserGroupResponse) {
+        option (google.api.http) = {
+            post: "/cloud/user-groups",
+            body: "*"
+        };
+    }
+
+    // Update a user group
+    rpc UpdateUserGroup (UpdateUserGroupRequest) returns (UpdateUserGroupResponse) {
+        option (google.api.http) = {
+            post: "/cloud/user-groups/{group_id}",
+            body: "*"
+        };
+    }
+
+    // Delete a user group
+    rpc DeleteUserGroup (DeleteUserGroupRequest) returns (DeleteUserGroupResponse) {
+        option (google.api.http) = {
+            delete: "/cloud/user-groups/{group_id}",
+        };
+    }
+
+    // Set a user group's access to a namespace
+    rpc SetUserGroupNamespaceAccess (SetUserGroupNamespaceAccessRequest) returns (SetUserGroupNamespaceAccessResponse) {
+        option (google.api.http) = {
+            post: "/cloud/namespaces/{namespace}/user-groups/{group_id}/access",
+            body: "*"
+        };
+    }
+
+    // Create a service account.
+    rpc CreateServiceAccount(CreateServiceAccountRequest) returns (CreateServiceAccountResponse) {
+        option (google.api.http) = {
+            post: "/cloud/service-accounts",
+            body: "*"
+        };
+    }
+
+    // Get a service account.
+    rpc GetServiceAccount(GetServiceAccountRequest) returns (GetServiceAccountResponse) {
+        option (google.api.http) = {
+            get: "/cloud/service-accounts/{service_account_id}",
+        };
+    }
+
+    // Get service accounts.
+    rpc GetServiceAccounts(GetServiceAccountsRequest) returns (GetServiceAccountsResponse) {
+        option (google.api.http) = {
+            get: "/cloud/service-accounts",
+        };
+    }
+
+    // Update a service account.
+    rpc UpdateServiceAccount(UpdateServiceAccountRequest) returns (UpdateServiceAccountResponse) {
+        option (google.api.http) = {
+            post: "/cloud/service-accounts/{service_account_id}",
+            body: "*"
+        };
+    }
+
+    // Delete a service account.
+    rpc DeleteServiceAccount(DeleteServiceAccountRequest) returns (DeleteServiceAccountResponse) {
+        option (google.api.http) = {
+            delete: "/cloud/service-accounts/{service_account_id}",
+        };
+    }
+}

package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/identity/v1/message.proto

@@ -0,0 +1,173 @@
+syntax = "proto3";
+
+package temporal.api.cloud.identity.v1;
+
+option go_package = "go.temporal.io/api/cloud/identity/v1;identity";
+option java_package = "io.temporal.api.cloud.identity.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Cloud::Identity::V1";
+option csharp_namespace = "Temporalio.Api.Cloud.Identity.V1";
+
+import "google/protobuf/timestamp.proto";
+
+message AccountAccess {
+    // The role on the account, should be one of [admin, developer, read]
+    // admin - gives full access the account, including users and namespaces
+    // developer - gives access to create namespaces on the account
+    // read - gives read only access to the account
+    string role = 1;
+}
+
+message NamespaceAccess {
+    // The permission to the namespace, should be one of [admin, write, read]
+    // admin - gives full access to the namespace, including assigning namespace access to other users
+    // write - gives write access to the namespace configuration and workflows within the namespace
+    // read - gives read only access to the namespace configuration and workflows within the namespace
+    string permission = 1;
+}
+
+message Access {
+    // The account access
+    AccountAccess account_access = 1;
+    // The map of namespace accesses
+    // The key is the namespace name and the value is the access to the namespace
+    map<string, NamespaceAccess> namespace_accesses = 2;
+}
+
+message UserSpec {
+    // The email address associated to the user
+    string email = 1;
+    // The access to assigned to the user
+    Access access = 2;
+}
+
+message Invitation {
+    // The date and time when the user was created
+    google.protobuf.Timestamp created_time = 1;
+    // The date and time when the invitation expires or has expired
+    google.protobuf.Timestamp expired_time = 2;
+}
+
+message User {
+    // The id of the user
+    string id = 1;
+    // The current version of the user specification
+    // The next update operation will have to include this version
+    string resource_version = 2;
+    // The user specification
+    UserSpec spec = 3;
+    // The current state of the user
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the user, if any
+    string async_operation_id = 5;
+    // The details of the open invitation sent to the user, if any
+    Invitation invitation = 6;
+    // The date and time when the user was created
+    google.protobuf.Timestamp created_time = 7;
+    // The date and time when the user was last modified
+    // Will not be set if the user has never been modified
+    google.protobuf.Timestamp last_modified_time = 8;
+}
+
+message UserGroupSpec {
+    // The name of the group as defined in the customer's IdP (e.g. Google group name in Google Workspace)
+    // The name is immutable. Once set, it cannot be changed
+    string name = 1;
+    // The access assigned to the group
+    Access access = 2;
+}
+
+message UserGroup {
+    // The id of the group
+    string id = 1;
+    // The current version of the group specification
+    // The next update operation will have to include this version
+    string resource_version = 2;
+    // The group specification
+    UserGroupSpec spec = 3;
+    // The current state of the group
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the group, if any
+    string async_operation_id = 5;
+    // The date and time when the group was created
+    google.protobuf.Timestamp created_time = 6;
+    // The date and time when the group was last modified
+    // Will not be set if the group has never been modified
+    google.protobuf.Timestamp last_modified_time = 7;
+}
+
+message ServiceAccount {
+    // The id of the service account.
+    string id = 1;
+    // The current version of the service account specification.
+    // The next update operation will have to include this version.
+    string resource_version = 2;
+    // The service account specification.
+    ServiceAccountSpec spec = 3;
+    // The current state of the service account.
+    // Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended.
+    // For any failed state, reach out to Temporal Cloud support for remediation.
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the service account, if any.
+    string async_operation_id = 5;
+    // The date and time when the service account was created.
+    google.protobuf.Timestamp created_time = 6;
+    // The date and time when the service account was last modified
+    // Will not be set if the service account has never been modified.
+    google.protobuf.Timestamp last_modified_time = 7;
+}
+
+message ServiceAccountSpec {
+    // The name associated with the service account.
+    // The name is mutable, but must be unique across all your active service accounts.
+    string name = 1;
+    // The access assigned to the service account.
+    // The access is mutable.
+    Access access = 2;
+    // The description associated with the service account - optional.
+    // The description is mutable.
+    string description = 3;
+}
+
+
+message ApiKey {
+    // The id of the API Key.
+    string id = 1;
+    // The current version of the API key specification.
+    // The next update operation will have to include this version.
+    string resource_version = 2;
+    // The API key specification.
+    ApiKeySpec spec = 3;
+    // The current state of the API key.
+    // Possible values: activating, activationfailed, active, updating, updatefailed, deleting, deletefailed, deleted, suspending, suspendfailed, suspended.
+    // For any failed state, reach out to Temporal Cloud support for remediation.
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the API key, if any.
+    string async_operation_id = 5;
+    // The date and time when the API key was created.
+    google.protobuf.Timestamp created_time = 6;
+    // The date and time when the API key was last modified.
+    // Will not be set if the API key has never been modified.
+    google.protobuf.Timestamp last_modified_time = 7;
+}
+
+message ApiKeySpec {
+    // The id of the owner to create the API key for.
+    // The owner id is immutable. Once set during creation, it cannot be changed.
+    // The owner id is the id of the user when the owner type is 'user'.
+    // The owner id is the id of the service account when the owner type is 'service-account'.
+    string owner_id = 1;
+    // The type of the owner to create the API key for.
+    // The owner type is immutable. Once set during creation, it cannot be changed.
+    // Possible values: user, service-account.
+    string owner_type = 2;
+    // The display name of the API key.
+    string display_name = 3;
+    // The description of the API key.
+    string description = 4;
+    // The expiry time of the API key.
+    google.protobuf.Timestamp expiry_time = 5;
+    // True if the API key is disabled.
+    bool disabled = 6;
+}

package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/namespace/v1/message.proto

@@ -0,0 +1,164 @@
+syntax = "proto3";
+
+package temporal.api.cloud.namespace.v1;
+
+option go_package = "go.temporal.io/api/cloud/namespace/v1;namespace";
+option java_package = "io.temporal.api.cloud.namespace.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Cloud::Namespace::V1";
+option csharp_namespace = "Temporalio.Api.Cloud.Namespace.V1";
+
+import "google/protobuf/timestamp.proto";
+
+message CertificateFilterSpec {
+    // The common_name in the certificate.
+    // Optional, default is empty.
+    string common_name = 1;
+    // The organization in the certificate.
+    // Optional, default is empty.
+    string organization = 2;
+    // The organizational_unit in the certificate.
+    // Optional, default is empty.
+    string organizational_unit = 3;
+    // The subject_alternative_name in the certificate.
+    // Optional, default is empty.
+    string subject_alternative_name = 4;
+}
+
+message MtlsAuthSpec {
+    // The base64 encoded ca cert(s) in PEM format that the clients can use for authentication and authorization.
+    // This must only be one value, but the CA can have a chain.
+    //
+    // (-- api-linter: core::0140::base64=disabled --)
+    string accepted_client_ca = 1;
+    // Certificate filters which, if specified, only allow connections from client certificates whose distinguished name properties match at least one of the filters.
+    // This allows limiting access to specific end-entity certificates.
+    // Optional, default is empty.
+    repeated CertificateFilterSpec certificate_filters = 2;
+    // Flag to enable mTLS auth (default: disabled).
+    // Note: disabling mTLS auth will cause existing mTLS connections to fail.
+    // temporal:versioning:min_version=2024-05-13-00
+    bool enabled = 3;
+}
+
+message ApiKeyAuthSpec {
+    // Flag to enable API key auth (default: disabled).
+    // Note: disabling API key auth will cause existing API key connections to fail.
+    bool enabled = 1;
+}
+
+message CodecServerSpec {
+    // The codec server endpoint.
+    string endpoint = 1;
+    // Whether to pass the user access token with your endpoint.
+    bool pass_access_token = 2;
+    // Whether to include cross-origin credentials.
+    bool include_cross_origin_credentials = 3;
+}
+
+message NamespaceSpec {
+    // The name to use for the namespace.
+    // This will create a namespace that's available at '<name>.<account>.tmprl.cloud:7233'.
+    // The name is immutable. Once set, it cannot be changed.
+    string name = 1;
+    // The ids of the regions where the namespace should be available.
+    // The GetRegions API can be used to get the list of valid region ids.
+    // Specifying more than one region makes the namespace "global", which is currently a preview only feature with restricted access.
+    // Please reach out to Temporal support for more information on global namespaces.
+    // When provisioned the global namespace will be active on the first region in the list and passive on the rest.
+    // Number of supported regions is 2.
+    // The regions is immutable. Once set, it cannot be changed.
+    // Example: ["aws-us-west-2"].
+    repeated string regions = 2;
+    // The number of days the workflows data will be retained for.
+    // Changes to the retention period may impact your storage costs.
+    // Any changes to the retention period will be applied to all new running workflows.
+    int32 retention_days = 3;
+    // The mTLS auth configuration for the namespace.
+    // If unspecified, mTLS will be disabled.
+    MtlsAuthSpec mtls_auth = 4;
+    // The API key auth configuration for the namespace.
+    // If unspecified, API keys will be disabled.
+    // temporal:versioning:min_version=2024-05-13-00
+    ApiKeyAuthSpec api_key_auth = 7;
+    // The custom search attributes to use for the namespace.
+    // The name of the attribute is the key and the type is the value.
+    // Supported attribute types: text, keyword, int, double, bool, datetime, keyword_list.
+    // NOTE: currently deleting a search attribute is not supported.
+    // Optional, default is empty.
+    map<string, string> custom_search_attributes = 5;
+    // Codec server spec used by UI to decode payloads for all users interacting with this namespace.
+    // Optional, default is unset.
+    CodecServerSpec codec_server = 6;
+}
+
+message Endpoints {
+    // The web UI address.
+    string web_address = 1;
+    // The gRPC address for mTLS client connections (may be empty if mTLS is disabled).
+    string mtls_grpc_address = 2;
+    // The gRPC address for API key client connections (may be empty if API keys are disabled).
+    string grpc_address = 3;
+}
+
+message Limits {
+    // The number of actions per second (APS) that is currently allowed for the namespace.
+    // The namespace may be throttled if its APS exceeds the limit.
+    int32 actions_per_second_limit = 1;
+}
+
+message AWSPrivateLinkInfo {
+    // The list of principal arns that are allowed to access the namespace on the private link.
+    repeated string allowed_principal_arns = 1;
+    // The list of vpc endpoint service names that are associated with the namespace.
+    repeated string vpc_endpoint_service_names = 2;
+}
+
+
+message PrivateConnectivity {
+    // The id of the region where the private connectivity applies.
+    string region = 1;
+    // The AWS PrivateLink info.
+    // This will only be set for an aws region.
+    AWSPrivateLinkInfo aws_private_link = 2;
+}
+
+message Namespace {
+    // The namespace identifier.
+    string namespace = 1;
+    // The current version of the namespace specification.
+    // The next update operation will have to include this version.
+    string resource_version = 2;
+    // The namespace specification.
+    NamespaceSpec spec = 3;
+    // The current state of the namespace.
+    string state = 4;
+    // The id of the async operation that is creating/updating/deleting the namespace, if any.
+    string async_operation_id = 5;
+    // The endpoints for the namespace.
+    Endpoints endpoints = 6;
+    // The currently active region for the namespace.
+    string active_region = 7;
+    // The limits set on the namespace currently.
+    Limits limits = 8;
+    // The private connectivities for the namespace, if any.
+    repeated PrivateConnectivity private_connectivities = 9;
+    // The date and time when the namespace was created.
+    google.protobuf.Timestamp created_time = 10;
+    // The date and time when the namespace was last modified.
+    // Will not be set if the namespace has never been modified.
+    google.protobuf.Timestamp last_modified_time = 11;
+    // The status of each region where the namespace is available.
+    // The id of the region is the key and the status is the value of the map.
+    map<string, NamespaceRegionStatus> region_status = 12;
+}
+
+message NamespaceRegionStatus {
+    // The current state of the namespace region.
+    // Possible values: adding, active, passive, removing, failed.
+    // For any failed state, reach out to Temporal Cloud support for remediation.
+    string state = 1;
+    // The id of the async operation that is making changes to where the namespace is available, if any.
+    string async_operation_id = 2;
+}

package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/operation/v1/message.proto

@@ -0,0 +1,36 @@
+syntax = "proto3";
+
+package temporal.api.cloud.operation.v1;
+
+option go_package = "go.temporal.io/api/cloud/operation/v1;operation";
+option java_package = "io.temporal.api.cloud.operation.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Cloud::Operation::V1";
+option csharp_namespace = "Temporalio.Api.Cloud.Operation.V1";
+
+import "google/protobuf/duration.proto";
+import "google/protobuf/timestamp.proto";
+import "google/protobuf/any.proto";
+
+message AsyncOperation {
+    // The operation id
+    string id = 1;
+    // The current state of this operation
+    // Possible values are: pending, in_progress, failed, cancelled, fulfilled
+    string state = 2;
+    // The recommended duration to check back for an update in the operation's state
+    google.protobuf.Duration check_duration = 3;
+    // The type of operation being performed
+    string operation_type = 4;
+    // The input to the operation being performed
+    //
+    // (-- api-linter: core::0146::any=disabled --)
+    google.protobuf.Any operation_input = 5;
+    // If the operation failed, the reason for the failure
+    string failure_reason = 6;
+    // The date and time when the operation initiated
+    google.protobuf.Timestamp started_time = 7;
+    // The date and time when the operation completed
+    google.protobuf.Timestamp finished_time = 8;
+}

package/sdk-core/sdk-core-protos/protos/api_cloud_upstream/temporal/api/cloud/region/v1/message.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+
+package temporal.api.cloud.region.v1;
+
+option go_package = "go.temporal.io/api/cloud/region/v1;region";
+option java_package = "io.temporal.api.cloud.region.v1";
+option java_multiple_files = true;
+option java_outer_classname = "MessageProto";
+option ruby_package = "Temporalio::Api::Cloud::Region::V1";
+option csharp_namespace = "Temporalio.Api.Cloud.Region.V1";
+
+message Region {
+    // The id of the temporal cloud region.
+    string id = 1;
+    // The name of the cloud provider that's hosting the region.
+    // Currently only "aws" is supported.
+    string cloud_provider = 2;
+    // The region identifier as defined by the cloud provider.
+    string cloud_provider_region = 3;
+    // The human readable location of the region.
+    string location = 4;
+}