Skip to content

Commit

Permalink
Update docstrings (via synth). (#7963)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation authored and busunkim96 committed May 14, 2019
1 parent 46257ab commit f93e8ff
Show file tree
Hide file tree
Showing 16 changed files with 125 additions and 115 deletions.
2 changes: 1 addition & 1 deletion tasks/google/cloud/tasks_v2/gapic/cloud_tasks_client.py
Expand Up @@ -1395,7 +1395,7 @@ def create_task(
Tasks cannot be updated after creation; there is no UpdateTask command.
- For ``App Engine queues``, the maximum task size is 100KB.
- The maximum task size is 100KB.
Example:
>>> from google.cloud import tasks_v2
Expand Down
Expand Up @@ -354,7 +354,7 @@ def create_task(self):
Tasks cannot be updated after creation; there is no UpdateTask command.
- For ``App Engine queues``, the maximum task size is 100KB.
- The maximum task size is 100KB.
Returns:
Callable: A callable which accepts the appropriate
Expand Down
44 changes: 24 additions & 20 deletions tasks/google/cloud/tasks_v2/proto/cloudtasks.proto
Expand Up @@ -19,12 +19,12 @@ package google.cloud.tasks.v2;

import "google/api/annotations.proto";
import "google/api/resource.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/cloud/tasks/v2/task.proto";
import "google/cloud/tasks/v2/queue.proto";
import "google/cloud/tasks/v2/task.proto";
import "google/iam/v1/iam_policy.proto";
import "google/iam/v1/policy.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/rpc/code.proto";

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


// Cloud Tasks allows developers to manage the execution of background
// work in their applications.
service CloudTasks {
Expand Down Expand Up @@ -62,8 +61,9 @@ service CloudTasks {
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
// before using this method.
// [Overview of Queue Management and
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
// this method.
rpc CreateQueue(CreateQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/locations/*}/queues"
Expand All @@ -83,8 +83,9 @@ service CloudTasks {
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
// before using this method.
// [Overview of Queue Management and
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
// this method.
rpc UpdateQueue(UpdateQueueRequest) returns (Queue) {
option (google.api.http) = {
patch: "/v2/{queue.name=projects/*/locations/*/queues/*}"
Expand All @@ -102,8 +103,9 @@ service CloudTasks {
// WARNING: Using this method may have unintended side effects if you are
// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
// Read
// [Overview of Queue Management and queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml)
// before using this method.
// [Overview of Queue Management and
// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
// this method.
rpc DeleteQueue(DeleteQueueRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v2/{name=projects/*/locations/*/queues/*}"
Expand Down Expand Up @@ -148,7 +150,8 @@ service CloudTasks {
// WARNING: Resuming many high-QPS queues at the same time can
// lead to target overloading. If you are resuming high-QPS
// queues, follow the 500/50/5 pattern described in
// [Managing Cloud Tasks Scaling Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
// [Managing Cloud Tasks Scaling
// Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
rpc ResumeQueue(ResumeQueueRequest) returns (Queue) {
option (google.api.http) = {
post: "/v2/{name=projects/*/locations/*/queues/*}:resume"
Expand Down Expand Up @@ -230,8 +233,7 @@ service CloudTasks {
//
// Tasks cannot be updated after creation; there is no UpdateTask command.
//
// * For [App Engine queues][google.cloud.tasks.v2.AppEngineHttpQueue], the maximum task size is
// 100KB.
// * The maximum task size is 100KB.
rpc CreateTask(CreateTaskRequest) returns (Task) {
option (google.api.http) = {
post: "/v2/{parent=projects/*/locations/*/queues/*}/tasks"
Expand Down Expand Up @@ -294,7 +296,8 @@ message ListQueuesRequest {
// field can be used as a filter and several operators as supported.
// For example: `<=, <, >=, >, !=, =, :`. The filter syntax is the same as
// described in
// [Stackdriver's Advanced Logs Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
// [Stackdriver's Advanced Logs
// Filters](https://cloud.google.com/logging/docs/view/advanced_filters).
//
// Sample filter "state: PAUSED".
//
Expand Down Expand Up @@ -445,13 +448,14 @@ message ListTasksRequest {
// permission on the [Task][google.cloud.tasks.v2.Task] resource.
Task.View response_view = 2;

// Requested page size. Fewer tasks than requested might be returned.
// Maximum page size.
//
// Fewer tasks than requested might be returned, even if more tasks exist; use
// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the response to
// determine if more tasks exist.
//
// The maximum page size is 1000. If unspecified, the page size will
// be the maximum. Fewer tasks than requested might be returned,
// even if more tasks exist; use
// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token] in the
// response to determine if more tasks exist.
// The maximum page size is 1000. If unspecified, the page size will be the
// maximum.
int32 page_size = 3;

// A token identifying the page of results to return.
Expand Down
28 changes: 14 additions & 14 deletions tasks/google/cloud/tasks_v2/proto/cloudtasks_pb2.py

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit f93e8ff

Please sign in to comment.