apify-docs/apify-api/openapi/components/objects/request-queues/request-queue-request-lock.yaml at 50d126b9daa570eed026e8d90e27160e96b0baf7 · apify/apify-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
commonErrors: &commonErrors
  "400":
    $ref: ../../responses/BadRequest.yaml
  "401":
    $ref: ../../responses/Unauthorized.yaml
  "403":
    $ref: ../../responses/Forbidden.yaml
  "404":
    $ref: ../../responses/NotFound.yaml
  "405":
    $ref: ../../responses/MethodNotAllowed.yaml
  "429":
    $ref: ../../responses/TooManyRequests.yaml

sharedTagById: &sharedTagById
  tags:
    - Storage/Request queues/Requests locks

sharedTagDefault: &sharedTagDefault
  tags:
    - Default request queue

sharedTagLastRun: &sharedTagLastRun
  tags:
    - Last Actor run's default request queue

sharedTagTaskLastRun: &sharedTagTaskLastRun
  tags:
    - Last Actor task run's default request queue

sharedPut: &sharedPut
  responses:
    "200":
      description: ""
      headers: {}
      content:
        application/json:
          schema:
            $ref: ../../schemas/request-queues/ProlongRequestLockResponse.yaml
    <<: *commonErrors
  deprecated: false

putById:
  <<: [*sharedPut, *sharedTagById]
  summary: Prolong request lock
  description: |
    Prolongs request lock. The request lock can be prolonged only by the client
    that has locked it using [Get and lock head
    operation](#/request-queue-head-lock-post).

    The clientKey identifier is used for locking and unlocking requests.
    You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.
  operationId: requestQueue_request_lock_put
  parameters:
    - $ref: "../../parameters/requestQueueParameters.yaml#/queueId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockSecs"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockForefront"
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/request-queues/request-lock/prolong-request-lock
    - https://docs.apify.com/api/v2#/reference/request-queues/prolong-request-lock
    - https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_put
  x-js-parent: RequestQueueClient
  x-js-name: prolongRequestLock
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#prolongRequestLock
  x-py-parent: RequestQueueClientAsync
  x-py-name: prolong_request_lock
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#prolong_request_lock

putDefault:
  <<: [*sharedPut, *sharedTagDefault]
  summary: Prolong lock on request in default request queue
  description: |
    Prolongs a request lock in the default request queue of the Actor run.

    This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
    [Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.
  operationId: actorRun_requestQueue_request_lock_put
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockSecs"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockForefront"

putLastRun:
  <<: [*sharedPut, *sharedTagLastRun]
  summary: Prolong lock on request in last run's default request queue
  description: |
    Prolongs a request lock in the default request queue of the last Actor run.

    This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
    [Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.
  operationId: act_runs_last_requestQueue_request_lock_put
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/originLastRun"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockSecs"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockForefront"

putTaskLastRun:
  <<: [*sharedPut, *sharedTagTaskLastRun]
  summary: Prolong lock on request in last task run's default request queue
  description: |
    Prolongs a request lock in the default request queue of the last Actor task run.

    This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
    [Prolong request lock](/api/v2/request-queue-request-lock-put) endpoint.
  operationId: actorTask_runs_last_requestQueue_request_lock_put
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/originLastRun"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockSecs"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/lockForefront"

sharedDelete: &sharedDelete
  responses:
    <<: *commonErrors
    "204":
      $ref: ../../responses/NoContent.yaml
  deprecated: false

deleteById:
  <<: [*sharedDelete, *sharedTagById]
  summary: Delete request lock
  description: |
    Deletes a request lock. The request lock can be deleted only by the client
    that has locked it using [Get and lock head
    operation](#/request-queue-head-lock-post).

    The clientKey identifier is used for locking and unlocking requests.
    You can delete or prolong the lock only for requests that were locked by the same client key or from the same Actor run.
  operationId: requestQueue_request_lock_delete
  parameters:
    - $ref: "../../parameters/requestQueueParameters.yaml#/queueId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/deleteForefront"
  x-legacy-doc-urls:
    - https://docs.apify.com/api/v2#/reference/request-queues/request-lock/delete-request-lock
    - https://docs.apify.com/api/v2#/reference/request-queues/delete-request-lock
    - https://docs.apify.com/api/v2#tag/Request-queuesRequest-lock/operation/requestQueue_request_lock_delete
  x-js-parent: RequestQueueClient
  x-js-name: deleteRequestLock
  x-js-doc-url: https://docs.apify.com/api/client/js/reference/class/RequestQueueClient#deleteRequestLock
  x-py-parent: RequestQueueClientAsync
  x-py-name: delete_request_lock
  x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/RequestQueueClientAsync#delete_request_lock

deleteDefault:
  <<: [*sharedDelete, *sharedTagDefault]
  summary: Delete lock on request in default request queue
  description: |
    Deletes a request lock in the default request queue of the Actor run.

    This endpoint is a shortcut for getting the run's `defaultRequestQueueId` and then using the
    [Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.
  operationId: actorRun_requestQueue_request_lock_delete
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/runId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/deleteForefront"

deleteLastRun:
  <<: [*sharedDelete, *sharedTagLastRun]
  summary: Delete lock on request in last run's default request queue
  description: |
    Deletes a request lock in the default request queue of the last Actor run.

    This endpoint is a shortcut for getting the last run's `defaultRequestQueueId` and then using the
    [Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.
  operationId: act_runs_last_requestQueue_request_lock_delete
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/originLastRun"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/deleteForefront"

deleteTaskLastRun:
  <<: [*sharedDelete, *sharedTagTaskLastRun]
  summary: Delete lock on request in last task run's default request queue
  description: |
    Deletes a request lock in the default request queue of the last Actor task run.

    This endpoint is a shortcut for getting the last task run's `defaultRequestQueueId` and then using the
    [Delete request lock](/api/v2/request-queue-request-lock-delete) endpoint.
  operationId: actorTask_runs_last_requestQueue_request_lock_delete
  parameters:
    - $ref: "../../parameters/runAndBuildParameters.yaml#/actorTaskId"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/statusLastRun"
    - $ref: "../../parameters/runAndBuildParameters.yaml#/originLastRun"
    - $ref: "../../parameters/requestQueueParameters.yaml#/requestId"
    - $ref: "../../parameters/requestQueueParameters.yaml#/clientKey"
    - $ref: "../../parameters/requestQueueParameters.yaml#/deleteForefront"