Skip to content

Commit

Permalink
feat(cloudtasks): update the api
Browse files Browse the repository at this point in the history
#### cloudtasks:v2beta2

The following keys were deleted:
- resources.projects.resources.locations.resources.queues.methods.buffer (Total Keys: 12)
- schemas.BufferQueueRequest (Total Keys: 3)
- schemas.BufferQueueResponse (Total Keys: 3)

The following keys were added:
- resources.projects.resources.locations.resources.queues.resources.tasks.methods.buffer (Total Keys: 15)
- schemas.BufferTaskRequest (Total Keys: 3)
- schemas.BufferTaskResponse (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Sep 13, 2022
1 parent 0794f62 commit df6dd76
Show file tree
Hide file tree
Showing 5 changed files with 156 additions and 77 deletions.
37 changes: 0 additions & 37 deletions docs/dyn/cloudtasks_v2beta2.projects.locations.queues.html
Expand Up @@ -79,9 +79,6 @@ <h2>Instance Methods</h2>
</p>
<p class="firstline">Returns the tasks Resource.</p>

<p class="toc_element">
<code><a href="#buffer">buffer(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferQueues Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8). Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified application of Cloud Tasks queues in buffer and rate limitting HTTP requests.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
Expand Down Expand Up @@ -122,40 +119,6 @@ <h2>Instance Methods</h2>
<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on a Queue. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="buffer">buffer(name, body=None, x__xgafv=None)</code>
<pre>Note: This feature is in its experimental stage. You must request access to the API through the [Cloud Tasks BufferQueues Experiment Signup form](https://forms.gle/X8Zr5hiXH5tTGFqh8). Creates and buffers a new task without the need to explicitly define a Task message. The queue must be an http queue (i.e., must have HTTP target). This method is used for a simplified application of Cloud Tasks queues in buffer and rate limitting HTTP requests.

Args:
name: string, Required. The queue name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue must already exist. (required)
body: object, The request body.
The object takes the form of:

{ # Request message for BufferQueue.
&quot;body&quot;: { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can&#x27;t be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # Body of the HTTP request. The body can take any generic value. The value will be written to the HttpRequest of the [Task].
&quot;contentType&quot;: &quot;A String&quot;, # The HTTP Content-Type header value specifying the content type of the body.
&quot;data&quot;: &quot;A String&quot;, # The HTTP request/response body as raw binary.
&quot;extensions&quot;: [ # Application specific response metadata. Must be set in the first response for streaming APIs.
{
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
],
},
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # Response message for BufferQueue.
&quot;task&quot;: &quot;A String&quot;, # The name of the created task. For example: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. TASK_ID is randomly generated and is unique within the queue.
}</pre>
</div>

<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
Expand Down

0 comments on commit df6dd76

Please sign in to comment.