smplkit 3.0.125 → 3.0.126
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/api/retry_policies_api.rb +10 -10
- data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/job.rb +2 -2
- data/lib/smplkit/_generated/jobs/lib/smplkit_jobs_client/models/retry_policy.rb +1 -1
- data/lib/smplkit/_generated/jobs/spec/api/retry_policies_api_spec.rb +5 -5
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: cdea2d8c6bc1209eb15b7cee203d4198828d11649e44736b3f03e56b6e8f6cdc
|
|
4
|
+
data.tar.gz: 0d16250d5093312a3ed248ec166d7c0d3dd2a48bc75c0fc5af485e4ab80fe717
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 574c2b071db99724ec992a120c18de9384cca97b6b9148f1403ac210b1b77d04b954b4d0b76c9f9dd19dc19c8be0e6bd3ccd623bbdf25a99e6b58543310fa140
|
|
7
|
+
data.tar.gz: 7ca2b72b43196e42dd3d7b5c1869e45d38be55abd9c988d8c90dc640ef9f5c32a73319126b7684a5154a63b33526d5470c1d46ec4aa9ffcbf7d981b26c4a96b3
|
|
@@ -20,7 +20,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
22
|
# Create Retry Policy
|
|
23
|
-
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
23
|
+
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
24
24
|
# @param retry_policy_create_request [RetryPolicyCreateRequest]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
26
26
|
# @return [RetryPolicyResponse]
|
|
@@ -30,7 +30,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
30
30
|
end
|
|
31
31
|
|
|
32
32
|
# Create Retry Policy
|
|
33
|
-
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
33
|
+
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
34
34
|
# @param retry_policy_create_request [RetryPolicyCreateRequest]
|
|
35
35
|
# @param [Hash] opts the optional parameters
|
|
36
36
|
# @return [Array<(RetryPolicyResponse, Integer, Hash)>] RetryPolicyResponse data, response status code and response headers
|
|
@@ -88,7 +88,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
88
88
|
end
|
|
89
89
|
|
|
90
90
|
# Delete Retry Policy
|
|
91
|
-
# Delete a retry policy.
|
|
91
|
+
# Delete a retry policy. A policy still referenced by any job — at the base level or in a per-environment override — cannot be deleted (`409`); the error lists the referencing job ids under `meta.referencing_jobs` so they can be reassigned (or cleared to no policy) first.
|
|
92
92
|
# @param policy_id [String]
|
|
93
93
|
# @param [Hash] opts the optional parameters
|
|
94
94
|
# @return [nil]
|
|
@@ -98,7 +98,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
98
98
|
end
|
|
99
99
|
|
|
100
100
|
# Delete Retry Policy
|
|
101
|
-
# Delete a retry policy.
|
|
101
|
+
# Delete a retry policy. A policy still referenced by any job — at the base level or in a per-environment override — cannot be deleted (`409`); the error lists the referencing job ids under `meta.referencing_jobs` so they can be reassigned (or cleared to no policy) first.
|
|
102
102
|
# @param policy_id [String]
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
104
104
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -149,7 +149,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
149
149
|
end
|
|
150
150
|
|
|
151
151
|
# Get Retry Policy
|
|
152
|
-
# Retrieve a single retry policy by its id.
|
|
152
|
+
# Retrieve a single retry policy by its id.
|
|
153
153
|
# @param policy_id [String]
|
|
154
154
|
# @param [Hash] opts the optional parameters
|
|
155
155
|
# @return [RetryPolicyResponse]
|
|
@@ -159,7 +159,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
159
159
|
end
|
|
160
160
|
|
|
161
161
|
# Get Retry Policy
|
|
162
|
-
# Retrieve a single retry policy by its id.
|
|
162
|
+
# Retrieve a single retry policy by its id.
|
|
163
163
|
# @param policy_id [String]
|
|
164
164
|
# @param [Hash] opts the optional parameters
|
|
165
165
|
# @return [Array<(RetryPolicyResponse, Integer, Hash)>] RetryPolicyResponse data, response status code and response headers
|
|
@@ -212,7 +212,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
212
212
|
end
|
|
213
213
|
|
|
214
214
|
# List Retry Policies
|
|
215
|
-
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
215
|
+
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
216
216
|
# @param [Hash] opts the optional parameters
|
|
217
217
|
# @option opts [String] :filter_name Case-insensitive substring match on the policy `name` (matches when the name contains the given text).
|
|
218
218
|
# @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `name`, `-name`, `updated_at`, `-updated_at`. (default to 'name')
|
|
@@ -226,7 +226,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
226
226
|
end
|
|
227
227
|
|
|
228
228
|
# List Retry Policies
|
|
229
|
-
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
229
|
+
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
230
230
|
# @param [Hash] opts the optional parameters
|
|
231
231
|
# @option opts [String] :filter_name Case-insensitive substring match on the policy `name` (matches when the name contains the given text).
|
|
232
232
|
# @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `name`, `-name`, `updated_at`, `-updated_at`. (default to 'name')
|
|
@@ -288,7 +288,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
288
288
|
end
|
|
289
289
|
|
|
290
290
|
# Update Retry Policy
|
|
291
|
-
# Replace an existing retry policy. Every writable field is overwritten.
|
|
291
|
+
# Replace an existing retry policy. Every writable field is overwritten.
|
|
292
292
|
# @param policy_id [String]
|
|
293
293
|
# @param retry_policy_request [RetryPolicyRequest]
|
|
294
294
|
# @param [Hash] opts the optional parameters
|
|
@@ -299,7 +299,7 @@ module SmplkitGeneratedClient::Jobs
|
|
|
299
299
|
end
|
|
300
300
|
|
|
301
301
|
# Update Retry Policy
|
|
302
|
-
# Replace an existing retry policy. Every writable field is overwritten.
|
|
302
|
+
# Replace an existing retry policy. Every writable field is overwritten.
|
|
303
303
|
# @param policy_id [String]
|
|
304
304
|
# @param retry_policy_request [RetryPolicyRequest]
|
|
305
305
|
# @param [Hash] opts the optional parameters
|
|
@@ -34,13 +34,13 @@ module SmplkitGeneratedClient::Jobs
|
|
|
34
34
|
# The HTTP request to perform, including method, url, headers, body, and timeout.
|
|
35
35
|
attr_accessor :configuration
|
|
36
36
|
|
|
37
|
-
# Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry is a flat, sparse overlay: only the leaves that differ from the base definition are present, and everything absent is inherited. Set `enabled` to `true` to run the job in that environment (the base is disabled everywhere; an environment with no entry, or an entry without `enabled: true`, does not run). Overridable leaves are `url`, `method`, `timeout`, `body`, `success_status`, `tls_verify`, `ca_cert`, `schedule` and `timezone` (recurring jobs only), `retry_policy` (the `id` of a retry policy
|
|
37
|
+
# Per-environment overrides keyed by environment key (e.g. `production`, `staging`). Each entry is a flat, sparse overlay: only the leaves that differ from the base definition are present, and everything absent is inherited. Set `enabled` to `true` to run the job in that environment (the base is disabled everywhere; an environment with no entry, or an entry without `enabled: true`, does not run). Overridable leaves are `url`, `method`, `timeout`, `body`, `success_status`, `tls_verify`, `ca_cert`, `schedule` and `timezone` (recurring jobs only), `retry_policy` (the `id` of a retry policy), and an individual header as `headers.<name>` (e.g. `headers.Authorization`). On read, each entry also reports the read-only `next_run_at` for that environment (the next fire time, or `null`). For a recurring or manual job, supply this map to choose where it runs. For a one-off job, the environment it is created in is recorded here automatically — name it with the `X-Smplkit-Environment` header. Every referenced environment must exist for the account.
|
|
38
38
|
attr_accessor :environments
|
|
39
39
|
|
|
40
40
|
# How overlapping runs are handled. `ALLOW` (the only value today) permits them.
|
|
41
41
|
attr_accessor :concurrency_policy
|
|
42
42
|
|
|
43
|
-
# The base retry policy for failed runs — the `id` of a retry policy
|
|
43
|
+
# The base retry policy for failed runs — the `id` of a retry policy, overridable per environment. Omit (or send `null`) to reference no policy, in which case failed runs are never retried.
|
|
44
44
|
attr_accessor :retry_policy
|
|
45
45
|
|
|
46
46
|
# How the job runs, derived from its base `schedule`: `recurring` for a cron schedule (fires on a repeating cadence), `manual` for no schedule (never auto-fires; runs only when triggered), or `one_off` for a `now` or datetime schedule (runs a single time, then is spent).
|
|
@@ -14,7 +14,7 @@ require 'date'
|
|
|
14
14
|
require 'time'
|
|
15
15
|
|
|
16
16
|
module SmplkitGeneratedClient::Jobs
|
|
17
|
-
# A named, reusable automatic-retry policy. A policy decides whether and how a failed run is retried. Reference it from a job's `retry_policy` (and optionally override it per environment). A job that references
|
|
17
|
+
# A named, reusable automatic-retry policy. A policy decides whether and how a failed run is retried. Reference it from a job's `retry_policy` (and optionally override it per environment). A job that references no policy is never retried.
|
|
18
18
|
class RetryPolicy < ApiModelBase
|
|
19
19
|
# Human-readable name for the policy.
|
|
20
20
|
attr_accessor :name
|
|
@@ -34,7 +34,7 @@ describe 'RetryPoliciesApi' do
|
|
|
34
34
|
|
|
35
35
|
# unit tests for create_retry_policy
|
|
36
36
|
# Create Retry Policy
|
|
37
|
-
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
37
|
+
# Create a retry policy for this account. The caller supplies the policy's id as `data.id`. Ids are unique within an account and immutable.
|
|
38
38
|
# @param retry_policy_create_request
|
|
39
39
|
# @param [Hash] opts the optional parameters
|
|
40
40
|
# @return [RetryPolicyResponse]
|
|
@@ -46,7 +46,7 @@ describe 'RetryPoliciesApi' do
|
|
|
46
46
|
|
|
47
47
|
# unit tests for delete_retry_policy
|
|
48
48
|
# Delete Retry Policy
|
|
49
|
-
# Delete a retry policy.
|
|
49
|
+
# Delete a retry policy. A policy still referenced by any job — at the base level or in a per-environment override — cannot be deleted (`409`); the error lists the referencing job ids under `meta.referencing_jobs` so they can be reassigned (or cleared to no policy) first.
|
|
50
50
|
# @param policy_id
|
|
51
51
|
# @param [Hash] opts the optional parameters
|
|
52
52
|
# @return [nil]
|
|
@@ -58,7 +58,7 @@ describe 'RetryPoliciesApi' do
|
|
|
58
58
|
|
|
59
59
|
# unit tests for get_retry_policy
|
|
60
60
|
# Get Retry Policy
|
|
61
|
-
# Retrieve a single retry policy by its id.
|
|
61
|
+
# Retrieve a single retry policy by its id.
|
|
62
62
|
# @param policy_id
|
|
63
63
|
# @param [Hash] opts the optional parameters
|
|
64
64
|
# @return [RetryPolicyResponse]
|
|
@@ -70,7 +70,7 @@ describe 'RetryPoliciesApi' do
|
|
|
70
70
|
|
|
71
71
|
# unit tests for list_retry_policies
|
|
72
72
|
# List Retry Policies
|
|
73
|
-
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
73
|
+
# List this account's retry policies. Default sort is `name` ascending. Sort by `name`, `created_at`, or `updated_at` (prefix `-` for descending).
|
|
74
74
|
# @param [Hash] opts the optional parameters
|
|
75
75
|
# @option opts [String] :filter_name Case-insensitive substring match on the policy `name` (matches when the name contains the given text).
|
|
76
76
|
# @option opts [String] :sort Field to sort by. Prefix with `-` for descending order. Default: `name`. Allowed values: `created_at`, `-created_at`, `name`, `-name`, `updated_at`, `-updated_at`.
|
|
@@ -86,7 +86,7 @@ describe 'RetryPoliciesApi' do
|
|
|
86
86
|
|
|
87
87
|
# unit tests for update_retry_policy
|
|
88
88
|
# Update Retry Policy
|
|
89
|
-
# Replace an existing retry policy. Every writable field is overwritten.
|
|
89
|
+
# Replace an existing retry policy. Every writable field is overwritten.
|
|
90
90
|
# @param policy_id
|
|
91
91
|
# @param retry_policy_request
|
|
92
92
|
# @param [Hash] opts the optional parameters
|