Skip to content
This repository was archived by the owner on Feb 1, 2024. It is now read-only.

Commit 30e7b82

Browse files
yoshi-automationbusunkim96
authored andcommitted
Update docstrings (via synth). (#7963)
1 parent 98df03a commit 30e7b82

File tree

16 files changed

+125
-115
lines changed

16 files changed

+125
-115
lines changed

google/cloud/tasks_v2/gapic/cloud_tasks_client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1395,7 +1395,7 @@ def create_task(
13951395
13961396
Tasks cannot be updated after creation; there is no UpdateTask command.
13971397
1398-
- For ``App Engine queues``, the maximum task size is 100KB.
1398+
- The maximum task size is 100KB.
13991399
14001400
Example:
14011401
>>> from google.cloud import tasks_v2

google/cloud/tasks_v2/gapic/transports/cloud_tasks_grpc_transport.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -354,7 +354,7 @@ def create_task(self):
354354
355355
Tasks cannot be updated after creation; there is no UpdateTask command.
356356
357-
- For ``App Engine queues``, the maximum task size is 100KB.
357+
- The maximum task size is 100KB.
358358
359359
Returns:
360360
Callable: A callable which accepts the appropriate

google/cloud/tasks_v2/proto/cloudtasks.proto

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ package google.cloud.tasks.v2;
1919

2020
import "google/api/annotations.proto";
2121
import "google/api/resource.proto";
22-
import "google/protobuf/empty.proto";
23-
import "google/protobuf/field_mask.proto";
24-
import "google/cloud/tasks/v2/task.proto";
2522
import "google/cloud/tasks/v2/queue.proto";
23+
import "google/cloud/tasks/v2/task.proto";
2624
import "google/iam/v1/iam_policy.proto";
2725
import "google/iam/v1/policy.proto";
26+
import "google/protobuf/empty.proto";
27+
import "google/protobuf/field_mask.proto";
2828
import "google/rpc/code.proto";
2929

3030
option go_package = "google.golang.org/genproto/googleapis/cloud/tasks/v2;tasks";
@@ -33,7 +33,6 @@ option java_outer_classname = "CloudTasksProto";
3333
option java_package = "com.google.cloud.tasks.v2";
3434
option objc_class_prefix = "TASKS";
3535

36-
3736
// Cloud Tasks allows developers to manage the execution of background
3837
// work in their applications.
3938
service CloudTasks {
@@ -62,8 +61,9 @@ service CloudTasks {
6261
// WARNING: Using this method may have unintended side effects if you are
6362
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
6463
// Read
65-
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
66-
// before using this method.
64+
// [Overview of Queue Management and
65+
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
66+
// this method.
6767
rpc CreateQueue(CreateQueueRequest) returns (Queue) {
6868
option (google.api.http) = {
6969
post: "/v2/{parent=projects/*/locations/*}/queues"
@@ -83,8 +83,9 @@ service CloudTasks {
8383
// WARNING: Using this method may have unintended side effects if you are
8484
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
8585
// Read
86-
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
87-
// before using this method.
86+
// [Overview of Queue Management and
87+
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
88+
// this method.
8889
rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
8990
option (google.api.http) = {
9091
patch: "/v2/{queue.name=projects/*/locations/*/queues/*}"
@@ -102,8 +103,9 @@ service CloudTasks {
102103
// WARNING: Using this method may have unintended side effects if you are
103104
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
104105
// Read
105-
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
106-
// before using this method.
106+
// [Overview of Queue Management and
107+
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
108+
// this method.
107109
rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
108110
option (google.api.http) = {
109111
delete: "/v2/{name=projects/*/locations/*/queues/*}"
@@ -148,7 +150,8 @@ service CloudTasks {
148150
// WARNING: Resuming many high-QPS queues at the same time can
149151
// lead to target overloading. If you are resuming high-QPS
150152
// queues, follow the 500/50/5 pattern described in
151-
// [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
153+
// [Managing Cloud Tasks Scaling
154+
// Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
152155
rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
153156
option (google.api.http) = {
154157
post: "/v2/{name=projects/*/locations/*/queues/*}:resume"
@@ -230,8 +233,7 @@ service CloudTasks {
230233
//
231234
// Tasks cannot be updated after creation; there is no UpdateTask command.
232235
//
233-
// * For [App Engine queues][google.cloud.tasks.v2.AppEngineHttpQueue], the maximum task size is
234-
// 100KB.
236+
// * The maximum task size is 100KB.
235237
rpc CreateTask(CreateTaskRequest) returns (Task) {
236238
option (google.api.http) = {
237239
post: "/v2/{parent=projects/*/locations/*/queues/*}/tasks"
@@ -294,7 +296,8 @@ message ListQueuesRequest {
294296
// field can be used as a filter and several operators as supported.
295297
// For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
296298
// described in
297-
// [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
299+
// [Stackdriver's Advanced Logs
300+
// Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
298301
//
299302
// Sample filter "state: PAUSED".
300303
//
@@ -445,13 +448,14 @@ message ListTasksRequest {
445448
// permission on the [Task][google.cloud.tasks.v2.Task] resource.
446449
Task.View response_view = 2;
447450

448-
// Requested page size. Fewer tasks than requested might be returned.
451+
// Maximum page size.
452+
//
453+
// Fewer tasks than requested might be returned, even if more tasks exist; use
454+
// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the response to
455+
// determine if more tasks exist.
449456
//
450-
// The maximum page size is 1000. If unspecified, the page size will
451-
// be the maximum. Fewer tasks than requested might be returned,
452-
// even if more tasks exist; use
453-
// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the
454-
// response to determine if more tasks exist.
457+
// The maximum page size is 1000. If unspecified, the page size will be the
458+
// maximum.
455459
int32 page_size = 3;
456460

457461
// A token identifying the page of results to return.

google/cloud/tasks_v2/proto/cloudtasks_pb2.py

Lines changed: 14 additions & 14 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)