peak-sdk 1.9.0__py3-none-any.whl → 1.11.0__py3-none-any.whl

peak/_version.py

@@ -18,4 +18,4 @@
 # # You should have received a copy of the APACHE LICENSE, VERSION 2.0
 # # along with this program. If not, see <https://apache.org/licenses/LICENSE-2.0>
 #
-__version__: str = "1.9.0"
+__version__: str = "1.11.0"

peak/cli/press/blocks/specs.py

@@ -127,7 +127,8 @@ def create(
         release (map):
             version (string): A valid semantic release version of the spec.
             notes (string | required: false): Notes for the release version.
-        config (map):   # For Workflow Block
+        # Workflow Block
+        config (map):
             images(map | required: false):
                 image-name (map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
@@ -138,6 +139,7 @@ def create(
                     secrets (list(str)) | required: false): List of secret names to be passed.
             steps (map | required: false):
                 <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
+                    # Standard Step
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
                         dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -149,7 +151,7 @@ def create(
                         id (int): ID of the existing image.
                         versionId: (int): ID of the existing image version.
                     imageRef (string | required: false): Name of the image defined above.
-                    type (string | required: false): Type of workflow step. Currently only standard type is supported.
+                    type (string | required: false): Type of workflow step. This should be 'standard' for a Standard Step which is the default value.
                     command (string): Command to run when step is executed.
                     clearImageCache (boolean | required: false): Whether to clear image cache on workflow execution.
                     stepTimeout (int | required: false): Time after which the step timeouts.
@@ -164,6 +166,125 @@ def create(
                     resources (map | required: false):
                         instanceTypeId (int): ID of the instance type to be used in the step.
                         storage (string): Storage in GB. For example, "10GB".
+                    outputParameters (map | required: false):
+                        <keyName> (string | required: false): Represents a key-value pair where the key is the parameter name, and the value is the file name where the output is stored.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # HTTP Step
+                    type (string | required: false): Type of workflow step. This should be 'http' for a HTTP Step.
+                    method (string | required: true): The HTTP method to be used for the API call. Should be one of - get, post, put, patch, and delete
+                    url (string | required: true): The URL to make the HTTP API call to.
+                    payload (string | required: false): Stringified JSON payload to be sent in case of non-get requests.
+                    headers (map | required: false):
+                        absolute (map | required: false): Key-Value pair where key is the name of the header and value is the value of the header.
+                        secrets (map | required: false): Key-Value pair where key is the name of the header and value is the name of the secret to get the value from.
+                    auth (map | required: false):
+                        type (string | required: true): The type of authentication to use. Should be one of - no-auth, oauth, basic, api-key, and bearer-token.
+                        clientId (string | required: false): The Client ID used to get the access token in case of OAuth. Value should be the name of a secret. Required when type is oauth.
+                        clientSecret (string | required: false): The Client Secret used to get the access token in case of OAuth. Value should be the name of a secret. Required when type is oauth.
+                        authUrl (string | required: false): The URL that is hit to get the access token in case of OAuth. Required when type is oauth.
+                        username (string | required: false): The username used for basic authentication. Required when type is basic.
+                        password (string | required: false): The password used for basic authentication. Value should be the name of a secret. Required when type is basic.
+                        apiKey (string | required: false): The API Key used for authentication. Value should be the name of a secret. Required when type is api-key.
+                        bearerToken (string | required: false): The bearer token used for authentication. Value should be the name of a secret. Required when type is bearer-token.
+                    parameters (map | required: false):
+                        env (map | required: false): Key-Value pair where key is the name of the env.
+                        inherit (map | required: false): Key-Value pair where key is the name of the env and value is the name of the output parameter.
+                        secrets (list(str) | required: false): List of secret names to be passed.
+                    outputParameters (map | required: false):
+                        <keyName> (string | required: false): Represents a key-value pair where the key is the parameter name. Note that in case of HTTP step, value should always be "response.txt", otherwise this parameter would be rejected.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # Export Step
+                    type (string | required: true): Type of workflow step. This should be 'export' for a export Step.
+                    schema (string | required: true): Schema from which the data is to be exported.
+                    table (string | required: true): Table from which the data is to be exported.
+                    sortBy (string | required: true): Column name by which the data is to be sorted.
+                    sortOrder (string | required: false): Order in which the data is to be sorted. Should be one of - asc, desc. Default is asc.
+                    compression (boolean | required: false): Whether to compress the files to '.gz' format while exporting. Default is false.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # SQL Step
+                    type (string | required: true): Type of workflow step. This should be 'sql' for a sql Step.
+                    sqlQueryPath (string | required: false): Path to the SQL query file. One of the 'sqlQueryPath' or 'repository' is required.
+                    repository (map | required: false):
+                        branch (string | required: true): Branch of the repository containing the required files.
+                        token (string | required: false): The token to be used to clone the repository.
+                        url (string | required: true): URL of the repository.
+                        filePath (string | required: true): Path to the file containing the SQL query.
+                    parameters (map | required: false):
+                        env (map | required: false): Key-Value pair where key is the name of the env.
+                        inherit (map | required: false): Key-Value pair where key is the name of the env and value is the name of the output parameter.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
             triggers (list(map)):
                 - cron (string | required: false): A valid cron expression.
                   webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
@@ -190,7 +311,8 @@ def create(
                     name (string): Name of the email watcher.
                     recipients (map):
                         to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
-        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+        # Service Block
+        config (map): # One of "image" or "imageDetails" is required.
             serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
             image (map | required: false):
                 version (string | required: false): A valid semantic image version.
@@ -422,7 +544,8 @@ def create_release(
         release (map):
             version (string): A valid semantic release version of the spec. Must be greater than previous release version.
             notes (string | required: false): Notes for the release version.
-        config (map):   # For Workflow Block
+        # Workflow Block
+        config (map):
             images(map | required: false):
                 image-name(map): Dictionary containing the image configuration. Here the key is name of the image.
                     version (string | required: false): A valid semantic image version.
@@ -432,7 +555,8 @@ def create_release(
                     buildArguments (map | required: false): Dictionary containing build args. Here the key is the name of the arg and value is the value of the arg.
                     secrets (list(str)) | required: false): List of secret names to be passed.
             steps(map | required: false):
-                <stepName> (map): Dictionary containing the step configuration. Here the key is name of the step.
+                <stepName> (map): # Dictionary containing the step configuration. Here the key is name of the step.
+                    # Standard Step
                     image: (map | required: false):
                         version (string | required: false): A valid semantic image version.
                         dockerfile (string | required: false): Path to the Dockerfile inside artifact.
@@ -444,13 +568,16 @@ def create_release(
                         id (int): ID of the existing image.
                         versionId: (int): ID of the existing image version.
                     imageRef (string | required: false): Name of the image defined above.
-                    type (string | required: false): Type of workflow step. Currently only standard type is supported.
+                    type (string | required: false): Type of workflow step. This should be 'standard' for a Standard Step which is the default value.
                     command (string): Command to run when step is executed.
                     clearImageCache (boolean | required: false): Whether to clear image cache on workflow execution.
                     stepTimeout (int | required: false): Time after which the step timeouts.
                     parameters (map | required: false):
                         env (map | required: false): Key-Value pair where key is the name of the env.
+                        inherit (map | required: false): Key-Value pair where key is the name of the env and value is the name of the output parameter.
                         secrets (list(str) | required: false): List of secret names to be passed.
+                    outputParameters (map | required: false):
+                        <keyName> (string | required: false): Represents a key-value pair where the key is the parameter name, and the value is the file name where the output is stored.
                     parents (list(str) | required: false): List containing names of steps on which this step is dependent on.
                     repository (map | required: false):
                         branch (string): Branch of the repository containing the required files.
@@ -459,6 +586,123 @@ def create_release(
                     resources (map | required: false):
                         instanceTypeId (int): ID of the instance type to be used in the step.
                         storage (string): Storage in GB. For example, "10GB".
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # HTTP Step
+                    type (string | required: false): Type of workflow step. This should be 'http' for a HTTP Step.
+                    method (string | required: true): The HTTP method to be used for the API call. Should be one of - get, post, put, patch, and delete
+                    url (string | required: true): The URL to make the HTTP API call to.
+                    payload (string | required: false): Stringified JSON payload to be sent in case of non-get requests.
+                    headers (map | required: false):
+                        absolute (map | required: false): Key-Value pair where key is the name of the header and value is the value of the header.
+                        secrets (map | required: false): Key-Value pair where key is the name of the header and value is the name of the secret to get the value from.
+                    auth (map | required: false):
+                        type (string | required: true): The type of authentication to use. Should be one of - no-auth, oauth, basic, api-key, and bearer-token.
+                        clientId (string | required: false): The Client ID used to get the access token in case of OAuth. Value should be the name of a secret. Required when type is oauth.
+                        clientSecret (string | required: false): The Client Secret used to get the access token in case of OAuth. Value should be the name of a secret. Required when type is oauth.
+                        authUrl (string | required: false): The URL that is hit to get the access token in case of OAuth. Required when type is oauth.
+                        username (string | required: false): The username used for basic authentication. Required when type is basic.
+                        password (string | required: false): The password used for basic authentication. Value should be the name of a secret. Required when type is basic.
+                        apiKey (string | required: false): The API Key used for authentication. Value should be the name of a secret. Required when type is api-key.
+                        bearerToken (string | required: false): The bearer token used for authentication. Value should be the name of a secret. Required when type is bearer-token.
+                    parameters (map | required: false):
+                        env (map | required: false): Key-Value pair where key is the name of the env.
+                        inherit (map | required: false): Key-Value pair where key is the name of the env and value is the name of the output parameter.
+                        secrets (list(str) | required: false): List of secret names to be passed.
+                    outputParameters (map | required: false):
+                        <keyName> (string | required: false): Represents a key-value pair where the key is the parameter name. Note that in case of HTTP step, value should always be "response.txt", otherwise this parameter would be rejected.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # Export Step
+                    type (string | required: true): Type of workflow step. This should be 'export' for a export Step.
+                    schema (string | required: true): Schema from which the data is to be exported.
+                    table (string | required: true): Table from which the data is to be exported.
+                    sortBy (string | required: true): Column name by which the data is to be sorted.
+                    sortOrder (string | required: false): Order in which the data is to be sorted. Should be one of - asc, desc. Default is asc.
+                    compression (boolean | required: false): Whether to compress the files to '.gz' format while exporting. Default is false.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
+                    # SQL Step
+                    type (string | required: true): Type of workflow step. This should be 'sql' for a sql Step.
+                    sqlQueryPath (string | required: false): Path to the SQL query file. One of the 'sqlQueryPath' or 'repository' is required.
+                    repository (map | required: false):
+                        branch (string | required: true): Branch of the repository containing the required files.
+                        token (string | required: false): The token to be used to clone the repository.
+                        url (string | required: true): URL of the repository.
+                        filePath (string | required: true): Path to the file containing the SQL query.
+                    parameters (map | required: false):
+                        env (map | required: false): Key-Value pair where key is the name of the env.
+                        inherit (map | required: false): Key-Value pair where key is the name of the env and value is the name of the output parameter.
+                    executionParameters (map | required: false):
+                        conditional (list(map) | required: false): # List of conditions to be evaluated based on the output params of the parent steps.
+                            - condition (string): The evaluation condition, either 'equals' or 'not-equals'.
+                            paramName (string): Name of the output parameter to be evaluated.
+                            stepName (string): Name of the step containing the output parameter.
+                            value (string): Value to be compared with the output parameter.
+                        parentStatus (list(map) | required: false): # List of conditions to be evaluated based on the status of the parent steps.
+                            - condition (string): The evaluation condition, either 'all-of' or 'one-of'.
+                            parents (list(str)): List of parent step names.
+                            status (list(str)): List of parent step statuses, with valid values being 'success' and 'failure'.
+                    runConfiguration (map | required: false):
+                        retryOptions (map | required: false): # Step level retry options which will override the workflow level retry options.
+                            duration (int | required: false): Duration in seconds after which the step is retried if it fails. Default is 5 seconds and maximum is 120 seconds.
+                            exitCodes (list(int) | required: false): List of exit codes for which the step is retried. If not provided, the step is retried for all exit codes.
+                            exponentialBackoff (boolean | required: false): Whether to use exponential backoff for retrying the step. If provided as true, the factor used will be 2.
+                            numberOfRetries (int | required: false): Number of times the step should be retried. Default is 3 and maximum is 5.
+                        skipConfiguration (map | required: false):
+                            skip (boolean | required: false): Indicates whether to skip the step. Default is false.
+                            skipDAG (boolean | required: false): Indicates whether to skip dependent steps, including the current step. Default is false.
             triggers (list(map)):
                 cron (string | required: false): A valid cron expression.
                 webhook (boolean | required: false): Should be true if webhook type trigger is to be used.
@@ -485,7 +729,8 @@ def create_release(
                     name (string): Name of the email watcher.
                     recipients (map):
                         to (list(str)): List of email addresses to send the email to. Email can be sent only to the users who are added in the tenant.
-        config (map):   # For Service Block. One of "image" or "imageDetails" is required.
+        # Service Block
+        config (map): # One of "image" or "imageDetails" is required.
             serviceType (string): Type of the service. Should be one of "web-app" or "api". It is "web-app" by default.
             image (map | required: false):
                 version (string | required: false): A valid semantic image version.