From f48dcc4e0d593ac022db38a126939253b95e4288 Mon Sep 17 00:00:00 2001 From: Google APIs Date: Thu, 28 Feb 2019 12:15:23 -0800 Subject: [PATCH] Synchronize new proto/yaml changes. PiperOrigin-RevId: 236171472 --- google/cloud/dataproc/v1/clusters.proto | 91 ++-- google/cloud/dataproc/v1/jobs.proto | 45 +- google/cloud/dataproc/v1/operations.proto | 1 - .../dataproc/v1/workflow_templates.proto | 38 +- google/cloud/dataproc/v1beta2/clusters.proto | 112 +++-- google/cloud/dataproc/v1beta2/jobs.proto | 48 +- .../cloud/dataproc/v1beta2/operations.proto | 1 - google/cloud/dataproc/v1beta2/shared.proto | 1 - .../dataproc/v1beta2/workflow_templates.proto | 45 +- google/cloud/tasks/v2beta2/cloudtasks.proto | 444 ++++++++++-------- google/cloud/tasks/v2beta2/queue.proto | 182 ++++--- google/cloud/tasks/v2beta2/target.proto | 184 +++++--- google/cloud/tasks/v2beta2/task.proto | 69 ++- google/cloud/tasks/v2beta3/cloudtasks.proto | 290 +++++++----- google/cloud/tasks/v2beta3/queue.proto | 141 +++--- google/cloud/tasks/v2beta3/target.proto | 147 +++--- google/cloud/tasks/v2beta3/task.proto | 42 +- 17 files changed, 1098 insertions(+), 783 deletions(-) diff --git a/google/cloud/dataproc/v1/clusters.proto b/google/cloud/dataproc/v1/clusters.proto index cc7db464..31873aad 100644 --- a/google/cloud/dataproc/v1/clusters.proto +++ b/google/cloud/dataproc/v1/clusters.proto @@ -29,12 +29,12 @@ option java_multiple_files = true; option java_outer_classname = "ClustersProto"; option java_package = "com.google.cloud.dataproc.v1"; - // The ClusterControllerService provides methods to manage clusters // of Compute Engine instances. service ClusterController { // Creates a cluster in a project. - rpc CreateCluster(CreateClusterRequest) returns (google.longrunning.Operation) { + rpc CreateCluster(CreateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/projects/{project_id}/regions/{region}/clusters" body: "cluster" @@ -42,7 +42,8 @@ service ClusterController { } // Updates a cluster in a project. - rpc UpdateCluster(UpdateClusterRequest) returns (google.longrunning.Operation) { + rpc UpdateCluster(UpdateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}" body: "cluster" @@ -50,7 +51,8 @@ service ClusterController { } // Deletes a cluster in a project. - rpc DeleteCluster(DeleteClusterRequest) returns (google.longrunning.Operation) { + rpc DeleteCluster(DeleteClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}" }; @@ -73,7 +75,8 @@ service ClusterController { // Gets cluster diagnostic information. // After the operation completes, the Operation.response field // contains `DiagnoseClusterOutputLocation`. - rpc DiagnoseCluster(DiagnoseClusterRequest) returns (google.longrunning.Operation) { + rpc DiagnoseCluster(DiagnoseClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/projects/{project_id}/regions/{region}/clusters/{cluster_name}:diagnose" body: "*" @@ -99,8 +102,9 @@ message Cluster { // Label **keys** must contain 1 to 63 characters, and must conform to // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). // Label **values** may be empty, but, if present, must contain 1 to 63 - // characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). - // No more than 32 labels can be associated with a cluster. + // characters, and must conform to [RFC + // 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be + // associated with a cluster. map labels = 8; // Output only. Cluster status. @@ -115,8 +119,8 @@ message Cluster { // Contains cluster daemon metrics such as HDFS and YARN stats. // - // **Beta Feature**: This report is available for testing purposes only. It may - // be changed before final release. + // **Beta Feature**: This report is available for testing purposes only. It + // may be changed before final release. ClusterMetrics metrics = 9; } @@ -152,9 +156,11 @@ message ClusterConfig { // Optional. Commands to execute on each node after config is // completed. By default, executables are run on master and all worker nodes. // You can test a node's `role` metadata to run an executable on - // a master or worker node, as shown below using `curl` (you can also use `wget`): + // a master or worker node, as shown below using `curl` (you can also use + // `wget`): // - // ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) + // ROLE=$(curl -H Metadata-Flavor:Google + // http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) // if [[ "${ROLE}" == 'Master' ]]; then // ... master specific actions ... // else @@ -213,11 +219,11 @@ message GceClusterConfig { string subnetwork_uri = 6; // Optional. If true, all instances in the cluster will only have internal IP - // addresses. By default, clusters are not restricted to internal IP addresses, - // and will have ephemeral external IP addresses assigned to each instance. - // This `internal_ip_only` restriction can only be enabled for subnetwork - // enabled networks, and all off-cluster dependencies must be configured to be - // accessible without external IP addresses. + // addresses. By default, clusters are not restricted to internal IP + // addresses, and will have ephemeral external IP addresses assigned to each + // instance. This `internal_ip_only` restriction can only be enabled for + // subnetwork enabled networks, and all off-cluster dependencies must be + // configured to be accessible without external IP addresses. bool internal_ip_only = 7; // Optional. The service account of the instances. Defaults to the default @@ -227,7 +233,8 @@ message GceClusterConfig { // * roles/logging.logWriter // * roles/storage.objectAdmin // - // (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts + // (see + // https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts // for more information). // Example: `[account_id]@[project_id].iam.gserviceaccount.com` string service_account = 8; @@ -253,7 +260,8 @@ message GceClusterConfig { repeated string tags = 4; // The Compute Engine metadata entries to add to all instances (see - // [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). + // [Project and instance + // metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). map metadata = 5; } @@ -282,7 +290,8 @@ message InstanceGroupConfig { // * `n1-standard-2` // // **Auto Zone Exception**: If you are using the Cloud Dataproc - // [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) + // [Auto Zone + // Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) // feature, you must use the short name of the machine type // resource, for example, `n1-standard-2`. string machine_type_uri = 4; @@ -290,7 +299,8 @@ message InstanceGroupConfig { // Optional. Disk option config settings. DiskConfig disk_config = 5; - // Optional. Specifies that this instance group contains preemptible instances. + // Optional. Specifies that this instance group contains preemptible + // instances. bool is_preemptible = 6; // Output only. The config for Compute Engine Instance Group @@ -321,7 +331,8 @@ message ManagedGroupConfig { message AcceleratorConfig { // Full URL, partial URI, or short name of the accelerator type resource to // expose to this instance. See - // [Compute Engine AcceleratorTypes](/compute/docs/reference/beta/acceleratorTypes). + // [Compute Engine + // AcceleratorTypes](/compute/docs/reference/beta/acceleratorTypes). // // Examples: // @@ -330,7 +341,8 @@ message AcceleratorConfig { // * `nvidia-tesla-k80` // // **Auto Zone Exception**: If you are using the Cloud Dataproc - // [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) + // [Auto Zone + // Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) // feature, you must use the short name of the accelerator type // resource, for example, `nvidia-tesla-k80`. string accelerator_type_uri = 1; @@ -429,10 +441,12 @@ message ClusterStatus { // Specifies the selection and config of software inside the cluster. message SoftwareConfig { - // Optional. The version of software inside the cluster. It must be one of the supported - // [Cloud Dataproc Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), + // Optional. The version of software inside the cluster. It must be one of the + // supported [Cloud Dataproc + // Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), // such as "1.2" (including a subminor version, such as "1.2.29"), or the - // ["preview" version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). + // ["preview" + // version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). // If unspecified, it defaults to the latest version. string image_version = 1; @@ -482,10 +496,11 @@ message CreateClusterRequest { Cluster cluster = 2; // Optional. A unique id used to identify the request. If the server - // receives two [CreateClusterRequest][google.cloud.dataproc.v1.CreateClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend - // is returned. + // receives two + // [CreateClusterRequest][google.cloud.dataproc.v1.CreateClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -570,10 +585,11 @@ message UpdateClusterRequest { google.protobuf.FieldMask update_mask = 4; // Optional. A unique id used to identify the request. If the server - // receives two [UpdateClusterRequest][google.cloud.dataproc.v1.UpdateClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // receives two + // [UpdateClusterRequest][google.cloud.dataproc.v1.UpdateClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -600,10 +616,11 @@ message DeleteClusterRequest { string cluster_uuid = 4; // Optional. A unique id used to identify the request. If the server - // receives two [DeleteClusterRequest][google.cloud.dataproc.v1.DeleteClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // receives two + // [DeleteClusterRequest][google.cloud.dataproc.v1.DeleteClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). diff --git a/google/cloud/dataproc/v1/jobs.proto b/google/cloud/dataproc/v1/jobs.proto index 5bf067e0..c331ee23 100644 --- a/google/cloud/dataproc/v1/jobs.proto +++ b/google/cloud/dataproc/v1/jobs.proto @@ -27,7 +27,6 @@ option java_multiple_files = true; option java_outer_classname = "JobsProto"; option java_package = "com.google.cloud.dataproc.v1"; - // The JobController provides methods to manage jobs. service JobController { // Submits a job to a cluster. @@ -62,7 +61,8 @@ service JobController { // Starts a job cancellation request. To access the job resource // after cancellation, call - // [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or + // [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) + // or // [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1/projects.regions.jobs/get). rpc CancelJob(CancelJobRequest) returns (Job) { option (google.api.http) = { @@ -122,8 +122,10 @@ message LoggingConfig { } // A Cloud Dataproc job for running -// [Apache Hadoop MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) -// jobs on [Apache Hadoop YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). +// [Apache Hadoop +// MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) +// jobs on [Apache Hadoop +// YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). message HadoopJob { // Required. Indicates the location of the driver's main class. Specify // either the jar file that contains the main class or the main class name. @@ -143,8 +145,8 @@ message HadoopJob { } // Optional. The arguments to pass to the driver. Do not - // include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job - // properties, since a collision may occur that causes an incorrect job + // include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as + // job properties, since a collision may occur that causes an incorrect job // submission. repeated string args = 3; @@ -178,7 +180,8 @@ message SparkJob { // Required. The specification of the main method to call to drive the job. // Specify either the jar file that contains the main class or the main class // name. To pass both a main jar and a main class in that jar, add the jar to - // `CommonJob.jar_file_uris`, and then specify the main class name in `main_class`. + // `CommonJob.jar_file_uris`, and then specify the main class name in + // `main_class`. oneof driver { // The HCFS URI of the jar file that contains the main class. string main_jar_file_uri = 1; @@ -217,7 +220,8 @@ message SparkJob { } // A Cloud Dataproc job for running -// [Apache PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html) +// [Apache +// PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html) // applications on YARN. message PySparkJob { // Required. The HCFS URI of the main Python file to use as the driver. Must @@ -288,8 +292,8 @@ message HiveJob { } // Optional. Whether to continue executing queries if a query fails. - // The default value is `false`. Setting to `true` can be useful when executing - // independent parallel queries. + // The default value is `false`. Setting to `true` can be useful when + // executing independent parallel queries. bool continue_on_failure = 3; // Optional. Mapping of query variable names to values (equivalent to the @@ -308,8 +312,8 @@ message HiveJob { repeated string jar_file_uris = 6; } -// A Cloud Dataproc job for running [Apache Spark SQL](http://spark.apache.org/sql/) -// queries. +// A Cloud Dataproc job for running [Apache Spark +// SQL](http://spark.apache.org/sql/) queries. message SparkSqlJob { // Required. The sequence of Spark SQL queries to execute, specified as // either an HCFS file URI or as a list of queries. @@ -351,8 +355,8 @@ message PigJob { } // Optional. Whether to continue executing queries if a query fails. - // The default value is `false`. Setting to `true` can be useful when executing - // independent parallel queries. + // The default value is `false`. Setting to `true` can be useful when + // executing independent parallel queries. bool continue_on_failure = 3; // Optional. Mapping of query variable names to values (equivalent to the Pig @@ -573,8 +577,8 @@ message Job { // Output only. The collection of YARN applications spun up by this job. // - // **Beta** Feature: This report is available for testing purposes only. It may - // be changed before final release. + // **Beta** Feature: This report is available for testing purposes only. It + // may be changed before final release. repeated YarnApplication yarn_applications = 9; // Output only. A URI pointing to the location of the stdout of the job's @@ -590,8 +594,9 @@ message Job { // Label **keys** must contain 1 to 63 characters, and must conform to // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). // Label **values** may be empty, but, if present, must contain 1 to 63 - // characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). - // No more than 32 labels can be associated with a job. + // characters, and must conform to [RFC + // 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be + // associated with a job. map labels = 18; // Optional. Job scheduling configuration. @@ -629,8 +634,8 @@ message SubmitJobRequest { Job job = 2; // Optional. A unique id used to identify the request. If the server - // receives two [SubmitJobRequest][google.cloud.dataproc.v1.SubmitJobRequest] requests with the same - // id, then the second request will be ignored and the + // receives two [SubmitJobRequest][google.cloud.dataproc.v1.SubmitJobRequest] + // requests with the same id, then the second request will be ignored and the // first [Job][google.cloud.dataproc.v1.Job] created and stored in the backend // is returned. // diff --git a/google/cloud/dataproc/v1/operations.proto b/google/cloud/dataproc/v1/operations.proto index ba3ab3be..7c058766 100644 --- a/google/cloud/dataproc/v1/operations.proto +++ b/google/cloud/dataproc/v1/operations.proto @@ -25,7 +25,6 @@ option java_multiple_files = true; option java_outer_classname = "OperationsProto"; option java_package = "com.google.cloud.dataproc.v1"; - // The status of the operation. message ClusterOperationStatus { // The operation state. diff --git a/google/cloud/dataproc/v1/workflow_templates.proto b/google/cloud/dataproc/v1/workflow_templates.proto index 45ef8a22..a536698b 100644 --- a/google/cloud/dataproc/v1/workflow_templates.proto +++ b/google/cloud/dataproc/v1/workflow_templates.proto @@ -29,12 +29,12 @@ option java_multiple_files = true; option java_outer_classname = "WorkflowTemplatesProto"; option java_package = "com.google.cloud.dataproc.v1"; - // The API interface for managing Workflow Templates in the // Cloud Dataproc API. service WorkflowTemplateService { // Creates new workflow template. - rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/workflowTemplates" body: "template" @@ -49,7 +49,8 @@ service WorkflowTemplateService { // // Can retrieve previously instantiated template by specifying optional // version parameter. - rpc GetWorkflowTemplate(GetWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc GetWorkflowTemplate(GetWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { get: "/v1/{name=projects/*/locations/*/workflowTemplates/*}" additional_bindings { @@ -76,7 +77,8 @@ service WorkflowTemplateService { // On successful completion, // [Operation.response][google.longrunning.Operation.response] will be // [Empty][google.protobuf.Empty]. - rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest) returns (google.longrunning.Operation) { + rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{name=projects/*/locations/*/workflowTemplates/*}:instantiate" body: "*" @@ -90,7 +92,8 @@ service WorkflowTemplateService { // Instantiates a template and begins execution. // // This method is equivalent to executing the sequence - // [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], + // [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], + // [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], // [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate]. // // The returned Operation can be used to track execution of @@ -109,7 +112,9 @@ service WorkflowTemplateService { // On successful completion, // [Operation.response][google.longrunning.Operation.response] will be // [Empty][google.protobuf.Empty]. - rpc InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest) returns (google.longrunning.Operation) { + rpc InstantiateInlineWorkflowTemplate( + InstantiateInlineWorkflowTemplateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline" body: "template" @@ -122,7 +127,8 @@ service WorkflowTemplateService { // Updates (replaces) workflow template. The updated template // must contain version that matches the current server version. - rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { put: "/v1/{template.name=projects/*/locations/*/workflowTemplates/*}" body: "template" @@ -134,7 +140,8 @@ service WorkflowTemplateService { } // Lists workflows that match the specified filter in the request. - rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest) returns (ListWorkflowTemplatesResponse) { + rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest) + returns (ListWorkflowTemplatesResponse) { option (google.api.http) = { get: "/v1/{parent=projects/*/locations/*}/workflowTemplates" additional_bindings { @@ -144,7 +151,8 @@ service WorkflowTemplateService { } // Deletes a workflow template. It does not cancel in-progress workflows. - rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest) returns (google.protobuf.Empty) { + rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1/{name=projects/*/locations/*/workflowTemplates/*}" additional_bindings { @@ -276,8 +284,8 @@ message OrderedJob { // // The step id is used as prefix for job id, as job // `goog-dataproc-workflow-step-id` label, and in - // [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] field from other - // steps. + // [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] + // field from other steps. // // The id must contain only letters (a-z, A-Z), numbers (0-9), // underscores (_), and hyphens (-). Cannot begin or end with underscore @@ -348,10 +356,10 @@ message TemplateParameter { // A field is allowed to appear in at most one parameter's list of field // paths. // - // A field path is similar in syntax to a [google.protobuf.FieldMask][google.protobuf.FieldMask]. - // For example, a field path that references the zone field of a workflow - // template's cluster selector would be specified as - // `placement.clusterSelector.zone`. + // A field path is similar in syntax to a + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a + // field path that references the zone field of a workflow template's cluster + // selector would be specified as `placement.clusterSelector.zone`. // // Also, field paths can reference fields using the following syntax: // diff --git a/google/cloud/dataproc/v1beta2/clusters.proto b/google/cloud/dataproc/v1beta2/clusters.proto index fd3c86a0..fd89fbff 100644 --- a/google/cloud/dataproc/v1beta2/clusters.proto +++ b/google/cloud/dataproc/v1beta2/clusters.proto @@ -18,8 +18,8 @@ syntax = "proto3"; package google.cloud.dataproc.v1beta2; import "google/api/annotations.proto"; -import "google/cloud/dataproc/v1beta2/shared.proto"; import "google/cloud/dataproc/v1beta2/operations.proto"; +import "google/cloud/dataproc/v1beta2/shared.proto"; import "google/longrunning/operations.proto"; import "google/protobuf/duration.proto"; import "google/protobuf/field_mask.proto"; @@ -30,12 +30,12 @@ option java_multiple_files = true; option java_outer_classname = "ClustersProto"; option java_package = "com.google.cloud.dataproc.v1beta2"; - // The ClusterControllerService provides methods to manage clusters // of Compute Engine instances. service ClusterController { // Creates a cluster in a project. - rpc CreateCluster(CreateClusterRequest) returns (google.longrunning.Operation) { + rpc CreateCluster(CreateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/projects/{project_id}/regions/{region}/clusters" body: "cluster" @@ -43,7 +43,8 @@ service ClusterController { } // Updates a cluster in a project. - rpc UpdateCluster(UpdateClusterRequest) returns (google.longrunning.Operation) { + rpc UpdateCluster(UpdateClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { patch: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}" body: "cluster" @@ -51,7 +52,8 @@ service ClusterController { } // Deletes a cluster in a project. - rpc DeleteCluster(DeleteClusterRequest) returns (google.longrunning.Operation) { + rpc DeleteCluster(DeleteClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { delete: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}" }; @@ -74,7 +76,8 @@ service ClusterController { // Gets cluster diagnostic information. // After the operation completes, the Operation.response field // contains `DiagnoseClusterOutputLocation`. - rpc DiagnoseCluster(DiagnoseClusterRequest) returns (google.longrunning.Operation) { + rpc DiagnoseCluster(DiagnoseClusterRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/projects/{project_id}/regions/{region}/clusters/{cluster_name}:diagnose" body: "*" @@ -100,8 +103,9 @@ message Cluster { // Label **keys** must contain 1 to 63 characters, and must conform to // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). // Label **values** may be empty, but, if present, must contain 1 to 63 - // characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). - // No more than 32 labels can be associated with a cluster. + // characters, and must conform to [RFC + // 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be + // associated with a cluster. map labels = 8; // Output only. Cluster status. @@ -116,8 +120,8 @@ message Cluster { // Output only. Contains cluster daemon metrics such as HDFS and YARN stats. // - // **Beta Feature**: This report is available for testing purposes only. It may - // be changed before final release. + // **Beta Feature**: This report is available for testing purposes only. It + // may be changed before final release. ClusterMetrics metrics = 9; } @@ -156,9 +160,11 @@ message ClusterConfig { // Optional. Commands to execute on each node after config is // completed. By default, executables are run on master and all worker nodes. // You can test a node's role metadata to run an executable on - // a master or worker node, as shown below using `curl` (you can also use `wget`): + // a master or worker node, as shown below using `curl` (you can also use + // `wget`): // - // ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role) + // ROLE=$(curl -H Metadata-Flavor:Google + // http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role) // if [[ "${ROLE}" == 'Master' ]]; then // ... master specific actions ... // else @@ -217,11 +223,11 @@ message GceClusterConfig { string subnetwork_uri = 6; // Optional. If true, all instances in the cluster will only have internal IP - // addresses. By default, clusters are not restricted to internal IP addresses, - // and will have ephemeral external IP addresses assigned to each instance. - // This `internal_ip_only` restriction can only be enabled for subnetwork - // enabled networks, and all off-cluster dependencies must be configured to be - // accessible without external IP addresses. + // addresses. By default, clusters are not restricted to internal IP + // addresses, and will have ephemeral external IP addresses assigned to each + // instance. This `internal_ip_only` restriction can only be enabled for + // subnetwork enabled networks, and all off-cluster dependencies must be + // configured to be accessible without external IP addresses. bool internal_ip_only = 7; // Optional. The service account of the instances. Defaults to the default @@ -231,7 +237,8 @@ message GceClusterConfig { // * roles/logging.logWriter // * roles/storage.objectAdmin // - // (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts + // (see + // https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts // for more information). // Example: `[account_id]@[project_id].iam.gserviceaccount.com` string service_account = 8; @@ -257,7 +264,8 @@ message GceClusterConfig { repeated string tags = 4; // The Compute Engine metadata entries to add to all instances (see - // [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). + // [Project and instance + // metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). map metadata = 5; } @@ -286,7 +294,8 @@ message InstanceGroupConfig { // * `n1-standard-2` // // **Auto Zone Exception**: If you are using the Cloud Dataproc - // [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) + // [Auto Zone + // Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) // feature, you must use the short name of the machine type // resource, for example, `n1-standard-2`. string machine_type_uri = 4; @@ -294,7 +303,8 @@ message InstanceGroupConfig { // Optional. Disk option config settings. DiskConfig disk_config = 5; - // Optional. Specifies that this instance group contains preemptible instances. + // Optional. Specifies that this instance group contains preemptible + // instances. bool is_preemptible = 6; // Output only. The config for Compute Engine Instance Group @@ -338,7 +348,8 @@ message AcceleratorConfig { // * `nvidia-tesla-k80` // // **Auto Zone Exception**: If you are using the Cloud Dataproc - // [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) + // [Auto Zone + // Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) // feature, you must use the short name of the accelerator type // resource, for example, `nvidia-tesla-k80`. string accelerator_type_uri = 1; @@ -461,10 +472,12 @@ message ClusterStatus { // Specifies the selection and config of software inside the cluster. message SoftwareConfig { - // Optional. The version of software inside the cluster. It must be one of the supported - // [Cloud Dataproc Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), + // Optional. The version of software inside the cluster. It must be one of the + // supported [Cloud Dataproc + // Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), // such as "1.2" (including a subminor version, such as "1.2.29"), or the - // ["preview" version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). + // ["preview" + // version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). // If unspecified, it defaults to the latest version. string image_version = 1; @@ -514,10 +527,11 @@ message CreateClusterRequest { Cluster cluster = 2; // Optional. A unique id used to identify the request. If the server - // receives two [CreateClusterRequest][google.cloud.dataproc.v1beta2.CreateClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend - // is returned. + // receives two + // [CreateClusterRequest][google.cloud.dataproc.v1beta2.CreateClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -566,9 +580,10 @@ message UpdateClusterRequest { // } // } // - // Similarly, to change the number of preemptible workers in a cluster to 5, the - // `update_mask` parameter would be `config.secondary_worker_config.num_instances`, - // and the `PATCH` request body would be set as follows: + // Similarly, to change the number of preemptible workers in a cluster to 5, + // the `update_mask` parameter would be + // `config.secondary_worker_config.num_instances`, and the `PATCH` request + // body would be set as follows: // // { // "config":{ @@ -587,28 +602,34 @@ message UpdateClusterRequest { // labelsUpdates labels // // - // config.worker_config.num_instancesResize primary worker group + // config.worker_config.num_instancesResize primary worker + // group // // - // config.secondary_worker_config.num_instancesResize secondary worker group + // config.secondary_worker_config.num_instancesResize secondary + // worker group // // - // config.lifecycle_config.auto_delete_ttlReset MAX TTL duration + // config.lifecycle_config.auto_delete_ttlReset MAX TTL + // duration // // - // config.lifecycle_config.auto_delete_timeUpdate MAX TTL deletion timestamp + // config.lifecycle_config.auto_delete_timeUpdate MAX TTL + // deletion timestamp // // - // config.lifecycle_config.idle_delete_ttlUpdate Idle TTL duration + // config.lifecycle_config.idle_delete_ttlUpdate Idle TTL + // duration // // google.protobuf.FieldMask update_mask = 4; // Optional. A unique id used to identify the request. If the server - // receives two [UpdateClusterRequest][google.cloud.dataproc.v1beta2.UpdateClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // receives two + // [UpdateClusterRequest][google.cloud.dataproc.v1beta2.UpdateClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). @@ -635,10 +656,11 @@ message DeleteClusterRequest { string cluster_uuid = 4; // Optional. A unique id used to identify the request. If the server - // receives two [DeleteClusterRequest][google.cloud.dataproc.v1beta2.DeleteClusterRequest] requests with the same - // id, then the second request will be ignored and the - // first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the - // backend is returned. + // receives two + // [DeleteClusterRequest][google.cloud.dataproc.v1beta2.DeleteClusterRequest] + // requests with the same id, then the second request will be ignored and the + // first [google.longrunning.Operation][google.longrunning.Operation] created + // and stored in the backend is returned. // // It is recommended to always set this value to a // [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). diff --git a/google/cloud/dataproc/v1beta2/jobs.proto b/google/cloud/dataproc/v1beta2/jobs.proto index 7aff5f46..4f949ba9 100644 --- a/google/cloud/dataproc/v1beta2/jobs.proto +++ b/google/cloud/dataproc/v1beta2/jobs.proto @@ -27,7 +27,6 @@ option java_multiple_files = true; option java_outer_classname = "JobsProto"; option java_package = "com.google.cloud.dataproc.v1beta2"; - // The JobController provides methods to manage jobs. service JobController { // Submits a job to a cluster. @@ -62,7 +61,8 @@ service JobController { // Starts a job cancellation request. To access the job resource // after cancellation, call - // [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) or + // [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/list) + // or // [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1beta2/projects.regions.jobs/get). rpc CancelJob(CancelJobRequest) returns (Job) { option (google.api.http) = { @@ -122,8 +122,10 @@ message LoggingConfig { } // A Cloud Dataproc job for running -// [Apache Hadoop MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) -// jobs on [Apache Hadoop YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). +// [Apache Hadoop +// MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) +// jobs on [Apache Hadoop +// YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). message HadoopJob { // Required. Indicates the location of the driver's main class. Specify // either the jar file that contains the main class or the main class name. @@ -143,8 +145,8 @@ message HadoopJob { } // Optional. The arguments to pass to the driver. Do not - // include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job - // properties, since a collision may occur that causes an incorrect job + // include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as + // job properties, since a collision may occur that causes an incorrect job // submission. repeated string args = 3; @@ -178,7 +180,8 @@ message SparkJob { // Required. The specification of the main method to call to drive the job. // Specify either the jar file that contains the main class or the main class // name. To pass both a main jar and a main class in that jar, add the jar to - // `CommonJob.jar_file_uris`, and then specify the main class name in `main_class`. + // `CommonJob.jar_file_uris`, and then specify the main class name in + // `main_class`. oneof driver { // The HCFS URI of the jar file that contains the main class. string main_jar_file_uri = 1; @@ -217,7 +220,8 @@ message SparkJob { } // A Cloud Dataproc job for running -// [Apache PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html) +// [Apache +// PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html) // applications on YARN. message PySparkJob { // Required. The HCFS URI of the main Python file to use as the driver. Must @@ -288,8 +292,8 @@ message HiveJob { } // Optional. Whether to continue executing queries if a query fails. - // The default value is `false`. Setting to `true` can be useful when executing - // independent parallel queries. + // The default value is `false`. Setting to `true` can be useful when + // executing independent parallel queries. bool continue_on_failure = 3; // Optional. Mapping of query variable names to values (equivalent to the @@ -308,8 +312,8 @@ message HiveJob { repeated string jar_file_uris = 6; } -// A Cloud Dataproc job for running [Apache Spark SQL](http://spark.apache.org/sql/) -// queries. +// A Cloud Dataproc job for running [Apache Spark +// SQL](http://spark.apache.org/sql/) queries. message SparkSqlJob { // Required. The sequence of Spark SQL queries to execute, specified as // either an HCFS file URI or as a list of queries. @@ -351,8 +355,8 @@ message PigJob { } // Optional. Whether to continue executing queries if a query fails. - // The default value is `false`. Setting to `true` can be useful when executing - // independent parallel queries. + // The default value is `false`. Setting to `true` can be useful when + // executing independent parallel queries. bool continue_on_failure = 3; // Optional. Mapping of query variable names to values (equivalent to the Pig @@ -573,8 +577,8 @@ message Job { // Output only. The collection of YARN applications spun up by this job. // - // **Beta** Feature: This report is available for testing purposes only. It may - // be changed before final release. + // **Beta** Feature: This report is available for testing purposes only. It + // may be changed before final release. repeated YarnApplication yarn_applications = 9; // Output only. The email address of the user submitting the job. For jobs @@ -594,8 +598,9 @@ message Job { // Label **keys** must contain 1 to 63 characters, and must conform to // [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). // Label **values** may be empty, but, if present, must contain 1 to 63 - // characters, and must conform to [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt). - // No more than 32 labels can be associated with a job. + // characters, and must conform to [RFC + // 1035](https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be + // associated with a job. map labels = 18; // Optional. Job scheduling configuration. @@ -633,9 +638,10 @@ message SubmitJobRequest { Job job = 2; // Optional. A unique id used to identify the request. If the server - // receives two [SubmitJobRequest][google.cloud.dataproc.v1beta2.SubmitJobRequest] requests with the same - // id, then the second request will be ignored and the - // first [Job][google.cloud.dataproc.v1beta2.Job] created and stored in the backend + // receives two + // [SubmitJobRequest][google.cloud.dataproc.v1beta2.SubmitJobRequest] requests + // with the same id, then the second request will be ignored and the first + // [Job][google.cloud.dataproc.v1beta2.Job] created and stored in the backend // is returned. // // It is recommended to always set this value to a diff --git a/google/cloud/dataproc/v1beta2/operations.proto b/google/cloud/dataproc/v1beta2/operations.proto index 71741083..b77eedde 100644 --- a/google/cloud/dataproc/v1beta2/operations.proto +++ b/google/cloud/dataproc/v1beta2/operations.proto @@ -25,7 +25,6 @@ option java_multiple_files = true; option java_outer_classname = "OperationsProto"; option java_package = "com.google.cloud.dataproc.v1beta2"; - // The status of the operation. message ClusterOperationStatus { // The operation state. diff --git a/google/cloud/dataproc/v1beta2/shared.proto b/google/cloud/dataproc/v1beta2/shared.proto index 8d2f5e62..c9bea686 100644 --- a/google/cloud/dataproc/v1beta2/shared.proto +++ b/google/cloud/dataproc/v1beta2/shared.proto @@ -23,4 +23,3 @@ option go_package = "google.golang.org/genproto/googleapis/cloud/dataproc/v1beta option java_multiple_files = true; option java_outer_classname = "SharedProto"; option java_package = "com.google.cloud.dataproc.v1beta2"; - diff --git a/google/cloud/dataproc/v1beta2/workflow_templates.proto b/google/cloud/dataproc/v1beta2/workflow_templates.proto index 982f874d..cb258449 100644 --- a/google/cloud/dataproc/v1beta2/workflow_templates.proto +++ b/google/cloud/dataproc/v1beta2/workflow_templates.proto @@ -29,12 +29,12 @@ option java_multiple_files = true; option java_outer_classname = "WorkflowTemplatesProto"; option java_package = "com.google.cloud.dataproc.v1beta2"; - // The API interface for managing Workflow Templates in the // Cloud Dataproc API. service WorkflowTemplateService { // Creates new workflow template. - rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc CreateWorkflowTemplate(CreateWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { post: "/v1beta2/{parent=projects/*/regions/*}/workflowTemplates" body: "template" @@ -49,7 +49,8 @@ service WorkflowTemplateService { // // Can retrieve previously instantiated template by specifying optional // version parameter. - rpc GetWorkflowTemplate(GetWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc GetWorkflowTemplate(GetWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { get: "/v1beta2/{name=projects/*/regions/*/workflowTemplates/*}" additional_bindings { @@ -76,7 +77,8 @@ service WorkflowTemplateService { // On successful completion, // [Operation.response][google.longrunning.Operation.response] will be // [Empty][google.protobuf.Empty]. - rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest) returns (google.longrunning.Operation) { + rpc InstantiateWorkflowTemplate(InstantiateWorkflowTemplateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/{name=projects/*/regions/*/workflowTemplates/*}:instantiate" body: "*" @@ -90,7 +92,8 @@ service WorkflowTemplateService { // Instantiates a template and begins execution. // // This method is equivalent to executing the sequence - // [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], + // [CreateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.CreateWorkflowTemplate], + // [InstantiateWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.InstantiateWorkflowTemplate], // [DeleteWorkflowTemplate][google.cloud.dataproc.v1beta2.WorkflowTemplateService.DeleteWorkflowTemplate]. // // The returned Operation can be used to track execution of @@ -109,7 +112,9 @@ service WorkflowTemplateService { // On successful completion, // [Operation.response][google.longrunning.Operation.response] will be // [Empty][google.protobuf.Empty]. - rpc InstantiateInlineWorkflowTemplate(InstantiateInlineWorkflowTemplateRequest) returns (google.longrunning.Operation) { + rpc InstantiateInlineWorkflowTemplate( + InstantiateInlineWorkflowTemplateRequest) + returns (google.longrunning.Operation) { option (google.api.http) = { post: "/v1beta2/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline" body: "template" @@ -122,7 +127,8 @@ service WorkflowTemplateService { // Updates (replaces) workflow template. The updated template // must contain version that matches the current server version. - rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest) returns (WorkflowTemplate) { + rpc UpdateWorkflowTemplate(UpdateWorkflowTemplateRequest) + returns (WorkflowTemplate) { option (google.api.http) = { put: "/v1beta2/{template.name=projects/*/regions/*/workflowTemplates/*}" body: "template" @@ -134,7 +140,8 @@ service WorkflowTemplateService { } // Lists workflows that match the specified filter in the request. - rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest) returns (ListWorkflowTemplatesResponse) { + rpc ListWorkflowTemplates(ListWorkflowTemplatesRequest) + returns (ListWorkflowTemplatesResponse) { option (google.api.http) = { get: "/v1beta2/{parent=projects/*/regions/*}/workflowTemplates" additional_bindings { @@ -144,7 +151,8 @@ service WorkflowTemplateService { } // Deletes a workflow template. It does not cancel in-progress workflows. - rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest) returns (google.protobuf.Empty) { + rpc DeleteWorkflowTemplate(DeleteWorkflowTemplateRequest) + returns (google.protobuf.Empty) { option (google.api.http) = { delete: "/v1beta2/{name=projects/*/regions/*/workflowTemplates/*}" additional_bindings { @@ -276,8 +284,8 @@ message OrderedJob { // // The step id is used as prefix for job id, as job // `goog-dataproc-workflow-step-id` label, and in - // [prerequisiteStepIds][google.cloud.dataproc.v1beta2.OrderedJob.prerequisite_step_ids] field from other - // steps. + // [prerequisiteStepIds][google.cloud.dataproc.v1beta2.OrderedJob.prerequisite_step_ids] + // field from other steps. // // The id must contain only letters (a-z, A-Z), numbers (0-9), // underscores (_), and hyphens (-). Cannot begin or end with underscore @@ -345,12 +353,13 @@ message TemplateParameter { string name = 1; // Required. Paths to all fields that the parameter replaces. - // A field is allowed to appear in at most one parameter's list of field paths. + // A field is allowed to appear in at most one parameter's list of field + // paths. // - // A field path is similar in syntax to a [google.protobuf.FieldMask][google.protobuf.FieldMask]. - // For example, a field path that references the zone field of a workflow - // template's cluster selector would be specified as - // `placement.clusterSelector.zone`. + // A field path is similar in syntax to a + // [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a + // field path that references the zone field of a workflow template's cluster + // selector would be specified as `placement.clusterSelector.zone`. // // Also, field paths can reference fields using the following syntax: // @@ -645,8 +654,8 @@ message ListWorkflowTemplatesResponse { // Output only. WorkflowTemplates list. repeated WorkflowTemplate templates = 1; - // Output only. This token is included in the response if there are more results - // to fetch. To fetch additional results, provide this value as the + // Output only. This token is included in the response if there are more + // results to fetch. To fetch additional results, provide this value as the // page_token in a subsequent ListWorkflowTemplatesRequest. string next_page_token = 2; } diff --git a/google/cloud/tasks/v2beta2/cloudtasks.proto b/google/cloud/tasks/v2beta2/cloudtasks.proto index 01f6356e..61a6ecdc 100644 --- a/google/cloud/tasks/v2beta2/cloudtasks.proto +++ b/google/cloud/tasks/v2beta2/cloudtasks.proto @@ -33,7 +33,6 @@ option java_outer_classname = "CloudTasksProto"; option java_package = "com.google.cloud.tasks.v2beta2"; option objc_class_prefix = "TASKS"; - // Cloud Tasks allows developers to manage the execution of background // work in their applications. service CloudTasks { @@ -56,14 +55,15 @@ service CloudTasks { // Creates a queue. // // Queues created with this method allow tasks to live for a maximum of 31 - // days. After a task is 31 days old, the task will be deleted regardless of whether - // it was dispatched or not. + // days. After a task is 31 days old, the task will be deleted regardless of + // whether it was dispatched or not. // // 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: "/v2beta2/{parent=projects/*/locations/*}/queues" @@ -77,14 +77,15 @@ service CloudTasks { // the queue if it does exist. // // Queues created with this method allow tasks to live for a maximum of 31 - // days. After a task is 31 days old, the task will be deleted regardless of whether - // it was dispatched or not. + // days. After a task is 31 days old, the task will be deleted regardless of + // whether it was dispatched or not. // // 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: "/v2beta2/{queue.name=projects/*/locations/*/queues/*}" @@ -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: "/v2beta2/{name=projects/*/locations/*/queues/*}" @@ -127,9 +129,10 @@ service CloudTasks { // // If a queue is paused then the system will stop dispatching tasks // until the queue is resumed via - // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can still be added - // when the queue is paused. A queue is paused if its - // [state][google.cloud.tasks.v2beta2.Queue.state] is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. Tasks can + // still be added when the queue is paused. A queue is paused if its + // [state][google.cloud.tasks.v2beta2.Queue.state] is + // [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. rpc PauseQueue(PauseQueueRequest) returns (Queue) { option (google.api.http) = { post: "/v2beta2/{name=projects/*/locations/*/queues/*}:pause" @@ -141,14 +144,17 @@ service CloudTasks { // // This method resumes a queue after it has been // [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED] or - // [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a queue is stored - // in the queue's [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method it - // will be set to [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. + // [DISABLED][google.cloud.tasks.v2beta2.Queue.State.DISABLED]. The state of a + // queue is stored in the queue's + // [state][google.cloud.tasks.v2beta2.Queue.state]; after calling this method + // it will be set to + // [RUNNING][google.cloud.tasks.v2beta2.Queue.State.RUNNING]. // // 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: "/v2beta2/{name=projects/*/locations/*/queues/*}:resume" @@ -156,24 +162,25 @@ service CloudTasks { }; } - // Gets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. - // Returns an empty policy if the resource exists and does not have a policy - // set. + // Gets the access control policy for a + // [Queue][google.cloud.tasks.v2beta2.Queue]. Returns an empty policy if the + // resource exists and does not have a policy set. // // Authorization requires the following // [Google IAM](https://cloud.google.com/iam) permission on the specified // resource parent: // // * `cloudtasks.queues.getIamPolicy` - rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy" body: "*" }; } - // Sets the access control policy for a [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing - // policy. + // Sets the access control policy for a + // [Queue][google.cloud.tasks.v2beta2.Queue]. Replaces any existing policy. // // Note: The Cloud Console does not check queue-level IAM permissions yet. // Project-level permissions are required to use the Cloud Console. @@ -183,21 +190,24 @@ service CloudTasks { // resource parent: // // * `cloudtasks.queues.setIamPolicy` - rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy" body: "*" }; } - // Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta2.Queue]. - // If the resource does not exist, this will return an empty set of - // permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + // Returns permissions that a caller has on a + // [Queue][google.cloud.tasks.v2beta2.Queue]. If the resource does not exist, + // this will return an empty set of permissions, not a + // [NOT_FOUND][google.rpc.Code.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. - rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) + returns (google.iam.v1.TestIamPermissionsResponse) { option (google.api.http) = { post: "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions" body: "*" @@ -206,10 +216,10 @@ service CloudTasks { // Lists the tasks in a queue. // - // By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] view is retrieved - // due to performance considerations; - // [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] controls the - // subset of information which is returned. + // By default, only the [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC] + // view is retrieved due to performance considerations; + // [response_view][google.cloud.tasks.v2beta2.ListTasksRequest.response_view] + // controls the subset of information which is returned. // // The tasks may be returned in any order. The ordering may change at any // time. @@ -230,9 +240,11 @@ service CloudTasks { // // Tasks cannot be updated after creation; there is no UpdateTask command. // - // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum task size is + // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], + // the maximum task size is // 100KB. - // * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum task size is 1MB. + // * For [pull queues][google.cloud.tasks.v2beta2.PullTarget], the maximum + // task size is 1MB. rpc CreateTask(CreateTaskRequest) returns (Task) { option (google.api.http) = { post: "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" @@ -256,18 +268,19 @@ service CloudTasks { // // This method is invoked by the worker to obtain a lease. The // worker must acknowledge the task via - // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] after they have - // performed the work associated with the task. + // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] + // after they have performed the work associated with the task. // - // The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended to store data that - // the worker needs to perform the work associated with the task. To - // return the payloads in the [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set - // [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] to - // [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. + // The [payload][google.cloud.tasks.v2beta2.PullMessage.payload] is intended + // to store data that the worker needs to perform the work associated with the + // task. To return the payloads in the + // [response][google.cloud.tasks.v2beta2.LeaseTasksResponse], set + // [response_view][google.cloud.tasks.v2beta2.LeaseTasksRequest.response_view] + // to [FULL][google.cloud.tasks.v2beta2.Task.View.FULL]. // - // A maximum of 10 qps of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] - // requests are allowed per - // queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] + // A maximum of 10 qps of + // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are + // allowed per queue. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] // is returned when this limit is // exceeded. [RESOURCE_EXHAUSTED][google.rpc.Code.RESOURCE_EXHAUSTED] // is also returned when @@ -283,12 +296,13 @@ service CloudTasks { // Acknowledges a pull task. // // The worker, that is, the entity that - // [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must call this method - // to indicate that the work associated with the task has finished. + // [leased][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] this task must + // call this method to indicate that the work associated with the task has + // finished. // // The worker must acknowledge a task within the - // [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] or the lease - // will expire and the task will become available to be leased + // [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration] + // or the lease will expire and the task will become available to be leased // again. After the task is acknowledged, it will not be returned // by a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks], // [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask], or @@ -304,7 +318,8 @@ service CloudTasks { // // The worker can use this method to extend the lease by a new // duration, starting from now. The new task lease will be - // returned in the task's [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + // returned in the task's + // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. rpc RenewLease(RenewLeaseRequest) returns (Task) { option (google.api.http) = { post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:renewLease" @@ -315,9 +330,9 @@ service CloudTasks { // Cancel a pull task's lease. // // The worker can use this method to cancel a task's lease by - // setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] to now. This will - // make the task available to be leased to the next caller of - // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. + // setting its [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] + // to now. This will make the task available to be leased to the next caller + // of [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. rpc CancelLease(CancelLeaseRequest) returns (Task) { option (google.api.http) = { post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:cancelLease" @@ -328,30 +343,33 @@ service CloudTasks { // Forces a task to run now. // // When this method is called, Cloud Tasks will dispatch the task, even if - // the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or - // is [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. + // the task is already running, the queue has reached its + // [RateLimits][google.cloud.tasks.v2beta2.RateLimits] or is + // [PAUSED][google.cloud.tasks.v2beta2.Queue.State.PAUSED]. // // This command is meant to be used for manual debugging. For - // example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be used to retry a failed - // task after a fix has been made or to manually force a task to be - // dispatched now. + // example, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] can be + // used to retry a failed task after a fix has been made or to manually force + // a task to be dispatched now. // // The dispatched task is returned. That is, the task that is returned - // contains the [status][google.cloud.tasks.v2beta2.Task.status] after the task is dispatched but - // before the task is received by its target. + // contains the [status][google.cloud.tasks.v2beta2.Task.status] after the + // task is dispatched but before the task is received by its target. // // If Cloud Tasks receives a successful response from the task's // target, then the task will be deleted; otherwise the task's - // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be reset to the time that - // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus the retry delay specified - // in the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. + // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be + // reset to the time that + // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] was called plus + // the retry delay specified in the queue's + // [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig]. // // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] returns // [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a // task that has already succeeded or permanently failed. // - // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called on a - // [pull task][google.cloud.tasks.v2beta2.PullMessage]. + // [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask] cannot be called + // on a [pull task][google.cloud.tasks.v2beta2.PullMessage]. rpc RunTask(RunTaskRequest) returns (Task) { option (google.api.http) = { post: "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}:run" @@ -360,7 +378,8 @@ service CloudTasks { } } -// Request message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]. +// Request message for +// [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]. message ListQueuesRequest { // Required. // @@ -368,11 +387,11 @@ message ListQueuesRequest { // For example: `projects/PROJECT_ID/locations/LOCATION_ID` string parent = 1; - // `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta2.Queue] - // 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). + // `filter` can be used to specify a subset of queues. Any + // [Queue][google.cloud.tasks.v2beta2.Queue] 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). // // Sample filter "app_engine_http_target: *". // @@ -385,22 +404,25 @@ message ListQueuesRequest { // The maximum page size is 9800. If unspecified, the page size will // be the maximum. Fewer queues than requested might be returned, // even if more queues exist; use the - // [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] in the - // response to determine if more queues exist. + // [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] + // in the response to determine if more queues exist. int32 page_size = 3; // A token identifying the page of results to return. // // To request the first page results, page_token must be empty. To // request the next page of results, page_token must be the value of - // [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] returned - // from the previous call to [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] - // method. It is an error to switch the value of the - // [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while iterating through pages. + // [next_page_token][google.cloud.tasks.v2beta2.ListQueuesResponse.next_page_token] + // returned from the previous call to + // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] method. It + // is an error to switch the value of the + // [filter][google.cloud.tasks.v2beta2.ListQueuesRequest.filter] while + // iterating through pages. string page_token = 4; } -// Response message for [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]. +// Response message for +// [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues]. message ListQueuesResponse { // The list of queues. repeated Queue queues = 1; @@ -408,7 +430,8 @@ message ListQueuesResponse { // A token to retrieve next page of results. // // To return the next page of results, call - // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] with this value as the + // [ListQueues][google.cloud.tasks.v2beta2.CloudTasks.ListQueues] with this + // value as the // [page_token][google.cloud.tasks.v2beta2.ListQueuesRequest.page_token]. // // If the next_page_token is empty, there are no more results. @@ -417,7 +440,8 @@ message ListQueuesResponse { string next_page_token = 2; } -// Request message for [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue]. +// Request message for +// [GetQueue][google.cloud.tasks.v2beta2.CloudTasks.GetQueue]. message GetQueueRequest { // Required. // @@ -426,7 +450,8 @@ message GetQueueRequest { string name = 1; } -// Request message for [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue]. +// Request message for +// [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue]. message CreateQueueRequest { // Required. // @@ -442,21 +467,25 @@ message CreateQueueRequest { // // The queue to create. // - // [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as an existing queue. + // [Queue's name][google.cloud.tasks.v2beta2.Queue.name] cannot be the same as + // an existing queue. Queue queue = 2; } -// Request message for [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue]. +// Request message for +// [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue]. message UpdateQueueRequest { // Required. // // The queue to create or update. // - // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] must be specified. + // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] must be + // specified. // // Output only fields cannot be modified using UpdateQueue. // Any value specified for an output only field will be ignored. - // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] cannot be changed. + // The queue's [name][google.cloud.tasks.v2beta2.Queue.name] cannot be + // changed. Queue queue = 1; // A mask used to specify which fields of the queue are being updated. @@ -465,7 +494,8 @@ message UpdateQueueRequest { google.protobuf.FieldMask update_mask = 2; } -// Request message for [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue]. +// Request message for +// [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue]. message DeleteQueueRequest { // Required. // @@ -474,7 +504,8 @@ message DeleteQueueRequest { string name = 1; } -// Request message for [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue]. +// Request message for +// [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue]. message PurgeQueueRequest { // Required. // @@ -483,7 +514,8 @@ message PurgeQueueRequest { string name = 1; } -// Request message for [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue]. +// Request message for +// [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue]. message PauseQueueRequest { // Required. // @@ -492,7 +524,8 @@ message PauseQueueRequest { string name = 1; } -// Request message for [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. +// Request message for +// [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue]. message ResumeQueueRequest { // Required. // @@ -501,7 +534,8 @@ message ResumeQueueRequest { string name = 1; } -// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. +// Request message for listing tasks using +// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. message ListTasksRequest { // Required. // @@ -509,18 +543,19 @@ message ListTasksRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` string parent = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 2; // Requested page size. Fewer tasks than requested might be returned. @@ -528,23 +563,24 @@ message ListTasksRequest { // 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.v2beta2.ListTasksResponse.next_page_token] in the - // response to determine if more tasks exist. + // [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] + // in the response to determine if more tasks exist. int32 page_size = 4; // A token identifying the page of results to return. // // To request the first page results, page_token must be empty. To // request the next page of results, page_token must be the value of - // [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] returned - // from the previous call to [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] - // method. + // [next_page_token][google.cloud.tasks.v2beta2.ListTasksResponse.next_page_token] + // returned from the previous call to + // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] method. // // The page token is valid for only 2 hours. string page_token = 5; } -// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. +// Response message for listing tasks using +// [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks]. message ListTasksResponse { // The list of tasks. repeated Task tasks = 1; @@ -552,14 +588,16 @@ message ListTasksResponse { // A token to retrieve next page of results. // // To return the next page of results, call - // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] with this value as the + // [ListTasks][google.cloud.tasks.v2beta2.CloudTasks.ListTasks] with this + // value as the // [page_token][google.cloud.tasks.v2beta2.ListTasksRequest.page_token]. // // If the next_page_token is empty, there are no more results. string next_page_token = 2; } -// Request message for getting a task using [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask]. +// Request message for getting a task using +// [GetTask][google.cloud.tasks.v2beta2.CloudTasks.GetTask]. message GetTaskRequest { // Required. // @@ -567,22 +605,24 @@ message GetTaskRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` string name = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 2; } -// Request message for [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. +// Request message for +// [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. message CreateTaskRequest { // Required. // @@ -598,13 +638,13 @@ message CreateTaskRequest { // // Task names have the following format: // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - // The user can optionally specify a task [name][google.cloud.tasks.v2beta2.Task.name]. If a - // name is not specified then the system will generate a random - // unique task id, which will be set in the task returned in the - // [response][google.cloud.tasks.v2beta2.Task.name]. + // The user can optionally specify a task + // [name][google.cloud.tasks.v2beta2.Task.name]. If a name is not specified + // then the system will generate a random unique task id, which will be set in + // the task returned in the [response][google.cloud.tasks.v2beta2.Task.name]. // - // If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not set or is in the - // past then Cloud Tasks will set it to the current time. + // If [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] is not + // set or is in the past then Cloud Tasks will set it to the current time. // // Task De-duplication: // @@ -619,28 +659,29 @@ message CreateTaskRequest { // for ~9days after the original task was deleted or completed. // // Because there is an extra lookup cost to identify duplicate task - // names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] calls have significantly - // increased latency. Using hashed strings for the task id or for - // the prefix of the task id is recommended. Choosing task ids that - // are sequential or have sequential prefixes, for example using a + // names, these [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] + // calls have significantly increased latency. Using hashed strings for the + // task id or for the prefix of the task id is recommended. Choosing task ids + // that are sequential or have sequential prefixes, for example using a // timestamp, causes an increase in latency and error rates in all // task commands. The infrastructure relies on an approximately // uniform distribution of task ids to store and serve tasks // efficiently. Task task = 2; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 3; } @@ -654,7 +695,8 @@ message DeleteTaskRequest { string name = 1; } -// Request message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. +// Request message for leasing tasks using +// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. message LeaseTasksRequest { // Required. // @@ -673,39 +715,42 @@ message LeaseTasksRequest { // // After the worker has successfully finished the work associated // with the task, the worker must call via - // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] before the - // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. Otherwise the task will be - // returned to a later [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so - // that another worker can retry it. + // [AcknowledgeTask][google.cloud.tasks.v2beta2.CloudTasks.AcknowledgeTask] + // before the [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time]. + // Otherwise the task will be returned to a later + // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] call so that + // another worker can retry it. // // The maximum lease duration is 1 week. // `lease_duration` will be truncated to the nearest second. google.protobuf.Duration lease_duration = 3; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 4; // `filter` can be used to specify a subset of tasks to lease. // // When `filter` is set to `tag=` then the - // [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only tasks whose - // [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to ``. `` must be - // less than 500 characters. + // [response][google.cloud.tasks.v2beta2.LeaseTasksResponse] will contain only + // tasks whose [tag][google.cloud.tasks.v2beta2.PullMessage.tag] is equal to + // ``. `` must be less than 500 characters. // // When `filter` is set to `tag_function=oldest_tag()`, only tasks which have // the same tag as the task with the oldest - // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be returned. + // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] will be + // returned. // // Grammar Syntax: // @@ -723,12 +768,14 @@ message LeaseTasksRequest { // [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), // only UTF-8 encoded tags can be used in Cloud Tasks. Tag which // aren't UTF-8 encoded can't be used in the - // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the task's - // [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed as empty in Cloud Tasks. + // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter] and the + // task's [tag][google.cloud.tasks.v2beta2.PullMessage.tag] will be displayed + // as empty in Cloud Tasks. string filter = 5; } -// Response message for leasing tasks using [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. +// Response message for leasing tasks using +// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks]. message LeaseTasksResponse { // The leased tasks. repeated Task tasks = 1; @@ -748,8 +795,8 @@ message AcknowledgeTaskRequest { // The task's current schedule time, available in the // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or - // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is - // to ensure that your worker currently holds the lease. + // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. + // This restriction is to ensure that your worker currently holds the lease. google.protobuf.Timestamp schedule_time = 2; } @@ -767,8 +814,8 @@ message RenewLeaseRequest { // The task's current schedule time, available in the // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or - // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is - // to ensure that your worker currently holds the lease. + // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. + // This restriction is to ensure that your worker currently holds the lease. google.protobuf.Timestamp schedule_time = 2; // Required. @@ -780,18 +827,19 @@ message RenewLeaseRequest { // `lease_duration` will be truncated to the nearest second. google.protobuf.Duration lease_duration = 3; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 4; } @@ -809,22 +857,23 @@ message CancelLeaseRequest { // The task's current schedule time, available in the // [schedule_time][google.cloud.tasks.v2beta2.Task.schedule_time] returned by // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] response or - // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. This restriction is - // to ensure that your worker currently holds the lease. + // [RenewLease][google.cloud.tasks.v2beta2.CloudTasks.RenewLease] response. + // This restriction is to ensure that your worker currently holds the lease. google.protobuf.Timestamp schedule_time = 2; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 3; } @@ -837,17 +886,18 @@ message RunTaskRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` string name = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta2.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta2.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta2.Task] resource. Task.View response_view = 2; } diff --git a/google/cloud/tasks/v2beta2/queue.proto b/google/cloud/tasks/v2beta2/queue.proto index f04c2e2c..3aa4b80b 100644 --- a/google/cloud/tasks/v2beta2/queue.proto +++ b/google/cloud/tasks/v2beta2/queue.proto @@ -26,7 +26,6 @@ option java_multiple_files = true; option java_outer_classname = "QueueProto"; option java_package = "com.google.cloud.tasks.v2beta2"; - // A queue is a container of related tasks. Queues are configured to manage // how those tasks are dispatched. Configurable properties include rate limits, // retry options, target types, and others. @@ -49,29 +48,32 @@ message Queue { // Tasks are paused by the user. If the queue is paused then Cloud // Tasks will stop delivering tasks from it, but more tasks can // still be added to it by the user. When a pull queue is paused, - // all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls will return a - // [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. + // all [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls + // will return a [FAILED_PRECONDITION][google.rpc.Code.FAILED_PRECONDITION]. PAUSED = 2; // The queue is disabled. // // A queue becomes `DISABLED` when - // [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) or - // [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) is uploaded - // which does not contain the queue. You cannot directly disable a queue. + // [queue.yaml](https://cloud.google.com/appengine/docs/python/config/queueref) + // or + // [queue.xml](https://cloud.google.com/appengine/docs/standard/java/config/queueref) + // is uploaded which does not contain the queue. You cannot directly disable + // a queue. // // When a queue is disabled, tasks can still be added to a queue // but the tasks are not dispatched and - // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls return a - // `FAILED_PRECONDITION` error. + // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] calls + // return a `FAILED_PRECONDITION` error. // // To permanently delete this queue and all of its tasks, call // [DeleteQueue][google.cloud.tasks.v2beta2.CloudTasks.DeleteQueue]. DISABLED = 3; } - // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], - // after which it becomes output only. + // Caller-specified and required in + // [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue], after + // which it becomes output only. // // The queue name. // @@ -81,7 +83,8 @@ message Queue { // * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), // hyphens (-), colons (:), or periods (.). // For more information, see - // [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + // [Identifying + // projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) // * `LOCATION_ID` is the canonical ID for the queue's location. // The list of available locations can be obtained by calling // [ListLocations][google.cloud.location.Locations.ListLocations]. @@ -90,9 +93,10 @@ message Queue { // hyphens (-). The maximum length is 100 characters. string name = 1; - // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue][], - // after which the queue config type becomes output only, though fields within - // the config are mutable. + // Caller-specified and required in + // [CreateQueue][google.cloud.tasks.v2beta2.CloudTasks.CreateQueue][], after + // which the queue config type becomes output only, though fields within the + // config are mutable. // // The queue's target. // @@ -100,30 +104,34 @@ message Queue { oneof target_type { // App Engine HTTP target. // - // An App Engine queue is a queue that has an [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]. + // An App Engine queue is a queue that has an + // [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget]. AppEngineHttpTarget app_engine_http_target = 3; // Pull target. // - // A pull queue is a queue that has a [PullTarget][google.cloud.tasks.v2beta2.PullTarget]. + // A pull queue is a queue that has a + // [PullTarget][google.cloud.tasks.v2beta2.PullTarget]. PullTarget pull_target = 4; } // Rate limits for task dispatches. // // [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] and - // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related because they both - // control task attempts however they control how tasks are + // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] are related + // because they both control task attempts however they control how tasks are // attempted in different ways: // - // * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the total rate of + // * [rate_limits][google.cloud.tasks.v2beta2.Queue.rate_limits] controls the + // total rate of // dispatches from a queue (i.e. all traffic dispatched from the // queue, regardless of whether the dispatch is from a first // attempt or a retry). - // * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls what happens to + // * [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls + // what happens to // particular a task after its first attempt fails. That is, - // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls task retries (the - // second attempt, third attempt, etc). + // [retry_config][google.cloud.tasks.v2beta2.Queue.retry_config] controls + // task retries (the second attempt, third attempt, etc). RateLimits rate_limits = 5; // Settings that determine the retry behavior. @@ -134,25 +142,30 @@ message Queue { // * For tasks created using the App Engine SDK: the queue-level retry // settings apply to all tasks in the queue which do not have retry settings // explicitly set on the task and were created by the App Engine SDK. See - // [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + // [App Engine + // documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). RetryConfig retry_config = 6; // Output only. The state of the queue. // // `state` can only be changed by called // [PauseQueue][google.cloud.tasks.v2beta2.CloudTasks.PauseQueue], - // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or uploading + // [ResumeQueue][google.cloud.tasks.v2beta2.CloudTasks.ResumeQueue], or + // uploading // [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). - // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be used to change `state`. + // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] cannot be + // used to change `state`. State state = 7; // Output only. The last time this queue was purged. // - // All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] before this time - // were purged. + // All tasks that were [created][google.cloud.tasks.v2beta2.Task.create_time] + // before this time were purged. // - // A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the - // [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). + // A queue can be purged using + // [PurgeQueue][google.cloud.tasks.v2beta2.CloudTasks.PurgeQueue], the [App + // Engine Task Queue SDK, or the Cloud + // Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). // // Purge time will be truncated to the nearest microsecond. Purge // time will be unset if the queue has never been purged. @@ -164,23 +177,29 @@ message Queue { // This message determines the maximum rate that tasks can be dispatched by a // queue, regardless of whether the dispatch is a first task attempt or a retry. // -// Note: The debugging command, [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task -// even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta2.RateLimits]. +// Note: The debugging command, +// [RunTask][google.cloud.tasks.v2beta2.CloudTasks.RunTask], will run a task +// even if the queue has reached its +// [RateLimits][google.cloud.tasks.v2beta2.RateLimits]. message RateLimits { // The maximum rate at which tasks are dispatched from this queue. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], the maximum allowed value + // * For [App Engine queues][google.cloud.tasks.v2beta2.AppEngineHttpTarget], + // the maximum allowed value // is 500. - // * This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the + // * This field is output only for [pull + // queues][google.cloud.tasks.v2beta2.PullTarget]. In addition to the // `max_tasks_dispatched_per_second` limit, a maximum of 10 QPS of - // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests are allowed per pull queue. + // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] requests + // are allowed per pull queue. // // // This field has the same meaning as - // [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + // [rate in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). double max_tasks_dispatched_per_second = 1; // Output only. The max burst size. @@ -208,9 +227,9 @@ message RateLimits { // `queue.yaml/xml`, `max_burst_size` is equal to // [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). // Since `max_burst_size` is output only, if - // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called on a queue - // created by `queue.yaml/xml`, `max_burst_size` will be reset based - // on the value of + // [UpdateQueue][google.cloud.tasks.v2beta2.CloudTasks.UpdateQueue] is called + // on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset + // based on the value of // [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second], // regardless of whether // [max_tasks_dispatched_per_second][google.cloud.tasks.v2beta2.RateLimits.max_tasks_dispatched_per_second] @@ -230,12 +249,14 @@ message RateLimits { // The maximum allowed value is 5,000. // // This field is output only for - // [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which indicates no limit. No other - // queue types can have `max_concurrent_tasks` set to -1. + // [pull queues][google.cloud.tasks.v2beta2.PullTarget] and always -1, which + // indicates no limit. No other queue types can have `max_concurrent_tasks` + // set to -1. // // // This field has the same meaning as - // [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). + // [max_concurrent_requests in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). int32 max_concurrent_tasks = 3; } @@ -251,7 +272,8 @@ message RetryConfig { // // // This field has the same meaning as - // [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [task_retry_limit in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). oneof num_attempts { // The maximum number of attempts for a task. // @@ -267,86 +289,100 @@ message RetryConfig { // If positive, `max_retry_duration` specifies the time limit for // retrying a failed task, measured from when the task was first // attempted. Once `max_retry_duration` time has passed *and* the - // task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] - // times, no further attempts will be made and the task will be - // deleted. + // task has been attempted + // [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times, + // no further attempts will be made and the task will be deleted. // // If zero, then the task age is unlimited. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. + // This field is output only for [pull + // queues][google.cloud.tasks.v2beta2.PullTarget]. // // // `max_retry_duration` will be truncated to the nearest second. // // This field has the same meaning as - // [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [task_age_limit in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration max_retry_duration = 3; - // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between + // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] + // for retry between // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and - // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, - // if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be - // retried. + // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration + // after it fails, if the queue's + // [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the + // task should be retried. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. + // This field is output only for [pull + // queues][google.cloud.tasks.v2beta2.PullTarget]. // // // `min_backoff` will be truncated to the nearest second. // // This field has the same meaning as - // [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [min_backoff_seconds in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration min_backoff = 4; - // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] for retry between + // A task will be [scheduled][google.cloud.tasks.v2beta2.Task.schedule_time] + // for retry between // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] and - // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration after it fails, - // if the queue's [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the task should be - // retried. + // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] duration + // after it fails, if the queue's + // [RetryConfig][google.cloud.tasks.v2beta2.RetryConfig] specifies that the + // task should be retried. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. + // This field is output only for [pull + // queues][google.cloud.tasks.v2beta2.PullTarget]. // // // `max_backoff` will be truncated to the nearest second. // // This field has the same meaning as - // [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [max_backoff_seconds in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration max_backoff = 5; // The time between retries will double `max_doublings` times. // // A task's retry interval starts at - // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then doubles - // `max_doublings` times, then increases linearly, and finally - // retries retries at intervals of + // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff], then + // doubles `max_doublings` times, then increases linearly, and finally retries + // retries at intervals of // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] up to // [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times. // - // For example, if [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s, - // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] is 300s, and - // `max_doublings` is 3, then the a task will first be retried in - // 10s. The retry interval will double three times, and then - // increase linearly by 2^3 * 10s. Finally, the task will retry at - // intervals of [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the - // task has been attempted [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] - // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, - // 240s, 300s, 300s, .... + // For example, if + // [min_backoff][google.cloud.tasks.v2beta2.RetryConfig.min_backoff] is 10s, + // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] is 300s, + // and `max_doublings` is 3, then the a task will first be retried in 10s. The + // retry interval will double three times, and then increase linearly by 2^3 * + // 10s. Finally, the task will retry at intervals of + // [max_backoff][google.cloud.tasks.v2beta2.RetryConfig.max_backoff] until the + // task has been attempted + // [max_attempts][google.cloud.tasks.v2beta2.RetryConfig.max_attempts] times. + // Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, + // 300s, .... // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // This field is output only for [pull queues][google.cloud.tasks.v2beta2.PullTarget]. + // This field is output only for [pull + // queues][google.cloud.tasks.v2beta2.PullTarget]. // // // This field has the same meaning as - // [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [max_doublings in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). int32 max_doublings = 6; } diff --git a/google/cloud/tasks/v2beta2/target.proto b/google/cloud/tasks/v2beta2/target.proto index 68a88e97..ae1b5555 100644 --- a/google/cloud/tasks/v2beta2/target.proto +++ b/google/cloud/tasks/v2beta2/target.proto @@ -24,14 +24,12 @@ option java_multiple_files = true; option java_outer_classname = "TargetProto"; option java_package = "com.google.cloud.tasks.v2beta2"; - // Pull target. -message PullTarget { - -} +message PullTarget {} // The pull message contains data that can be used by the caller of -// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. +// [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the +// task. // // This proto can only be used for tasks in a queue which has // [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] set. @@ -43,10 +41,11 @@ message PullMessage { // // Tags allow similar tasks to be processed in a batch. If you label // tasks with a tag, your worker can - // [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the same tag using - // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example, if you want to - // aggregate the events associated with a specific user once a day, - // you could tag tasks with the user ID. + // [lease tasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] with the + // same tag using + // [filter][google.cloud.tasks.v2beta2.LeaseTasksRequest.filter]. For example, + // if you want to aggregate the events associated with a specific user once a + // day, you could tag tasks with the user ID. // // The task's tag can only be set when the // [task is created][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. @@ -54,7 +53,8 @@ message PullMessage { // The tag must be less than 500 characters. // // SDK compatibility: Although the SDK allows tags to be either - // string or [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), + // string or + // [bytes](https://cloud.google.com/appengine/docs/standard/java/javadoc/com/google/appengine/api/taskqueue/TaskOptions.html#tag-byte:A-), // only UTF-8 encoded tags can be used in Cloud Tasks. If a tag isn't UTF-8 // encoded, the tag will be empty when the task is returned by Cloud Tasks. string tag = 2; @@ -63,11 +63,15 @@ message PullMessage { // App Engine HTTP target. // // The task will be delivered to the App Engine application hostname -// specified by its [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]. -// The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] explains how the -// task's host URL is constructed. +// specified by its +// [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] and +// [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]. The +// documentation for +// [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] +// explains how the task's host URL is constructed. // -// Using [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] requires +// Using [AppEngineHttpTarget][google.cloud.tasks.v2beta2.AppEngineHttpTarget] +// requires // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) // Google IAM permission for the project // and the following scope: @@ -75,11 +79,13 @@ message PullMessage { // `https://www.googleapis.com/auth/cloud-platform` message AppEngineHttpTarget { // Overrides for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. // // If set, `app_engine_routing_override` is used for all tasks in // the queue, no matter what the setting is for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. AppEngineRouting app_engine_routing_override = 1; } @@ -89,9 +95,11 @@ message AppEngineHttpTarget { // the task is dispatched. // // This proto can only be used for tasks in a queue which has -// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] set. +// [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] +// set. // -// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] requires +// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] +// requires // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) // Google IAM permission for the project // and the following scope: @@ -100,18 +108,22 @@ message AppEngineHttpTarget { // // The task will be delivered to the App Engine app which belongs to the same // project as the queue. For more information, see -// [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) +// [How Requests are +// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) // and how routing is affected by -// [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). +// [dispatch +// files](https://cloud.google.com/appengine/docs/python/config/dispatchref). // -// The [AppEngineRouting][google.cloud.tasks.v2beta2.AppEngineRouting] used to construct the URL that the task is -// delivered to can be set at the queue-level or task-level: +// The [AppEngineRouting][google.cloud.tasks.v2beta2.AppEngineRouting] used to +// construct the URL that the task is delivered to can be set at the queue-level +// or task-level: // // * If set, // [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override] // is used for all tasks in the queue, no matter what the setting // is for the -// [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. +// [task-level +// app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. // // // The `url` that the task will be sent to is: @@ -132,10 +144,12 @@ message AppEngineHttpRequest { // The app's request handler for the task's target URL must be able to handle // HTTP requests with this http_method, otherwise the task attempt will fail // with error code 405 (Method Not Allowed). See - // [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) + // [Writing a push task request + // handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) // and the documentation for the request handlers in the language your app is // written in e.g. - // [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + // [Python Request + // Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). HttpMethod http_method = 1; // Task-level setting for App Engine routing. @@ -143,7 +157,8 @@ message AppEngineHttpRequest { // If set, // [app_engine_routing_override][google.cloud.tasks.v2beta2.AppEngineHttpTarget.app_engine_routing_override] // is used for all tasks in the queue, no matter what the setting is for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta2.AppEngineHttpRequest.app_engine_routing]. AppEngineRouting app_engine_routing = 2; // The relative URL. @@ -169,7 +184,8 @@ message AppEngineHttpRequest { // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the // modified `User-Agent`. // - // If the task has a [payload][google.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], Cloud + // If the task has a + // [payload][google.cloud.tasks.v2beta2.AppEngineHttpRequest.payload], Cloud // Tasks sets the following headers: // // * `Content-Type`: By default, the `Content-Type` header is set to @@ -188,13 +204,16 @@ message AppEngineHttpRequest { // // In addition, Cloud Tasks sets some headers when the task is dispatched, // such as headers containing information about the task; see - // [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). + // [request + // headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). // These headers are set only when the task is dispatched, so they are not // visible when the task is returned in a Cloud Tasks response. // // Although there is no specific limit for the maximum number of headers or - // the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2beta2.Task]. For more - // information, see the [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] documentation. + // the size, there is a limit on the maximum size of the + // [Task][google.cloud.tasks.v2beta2.Task]. For more information, see the + // [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask] + // documentation. map headers = 4; // Payload. @@ -209,10 +228,14 @@ message AppEngineHttpRequest { // App Engine Routing. // // For more information about services, versions, and instances see -// [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), -// [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), -// [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), -// and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). +// [An Overview of App +// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), +// [Microservices Architecture on Google App +// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), +// [App Engine Standard request +// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), +// and [App Engine Flex request +// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). message AppEngineRouting { // App service. // @@ -220,16 +243,18 @@ message AppEngineRouting { // service when the task is attempted. // // For some queues or tasks which were created using the App Engine - // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable - // into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], - // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For example, some tasks - // which were created using the App Engine SDK use a custom domain - // name; custom domains are not parsed by Cloud Tasks. If - // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then + // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is + // not parsable into // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string. + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For + // example, some tasks which were created using the App Engine SDK use a + // custom domain name; custom domains are not parsed by Cloud Tasks. If + // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, + // then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], + // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the + // empty string. string service = 1; // App version. @@ -238,16 +263,18 @@ message AppEngineRouting { // version when the task is attempted. // // For some queues or tasks which were created using the App Engine - // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable - // into [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], - // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For example, some tasks - // which were created using the App Engine SDK use a custom domain - // name; custom domains are not parsed by Cloud Tasks. If - // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, then + // Task Queue API, [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is + // not parsable into // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the empty string. + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance]. For + // example, some tasks which were created using the App Engine SDK use a + // custom domain name; custom domains are not parsed by Cloud Tasks. If + // [host][google.cloud.tasks.v2beta2.AppEngineRouting.host] is not parsable, + // then [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], + // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], and + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] are the + // empty string. string version = 2; // App instance. @@ -256,16 +283,20 @@ message AppEngineRouting { // the task is attempted. // // Requests can only be sent to a specific instance if - // [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + // [manual scaling is used in App Engine + // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). // App Engine Flex does not support instances. For more information, see - // [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - // and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + // [App Engine Standard request + // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) + // and [App Engine Flex request + // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). string instance = 3; // Output only. The host that the task is sent to. // // For more information, see - // [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + // [How Requests are + // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). // // The host is constructed as: // @@ -284,44 +315,49 @@ message AppEngineRouting { // queue's project ID. Some tasks which were created using the App Engine // SDK use a custom domain name. // - // * `service =` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] + // * `service =` + // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] // - // * `version =` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + // * `version =` + // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] // // * `version_dot_service =` // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +` // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] // - // * `instance =` [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] + // * `instance =` + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] // // * `instance_dot_service =` - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +` - // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' + // +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] // // * `instance_dot_version =` - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +` - // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' + // +` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] // // * `instance_dot_version_dot_service =` - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' +` - // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' +` - // [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] `+ '.' + // +` [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] `+ '.' + // +` [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] // - // If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty, then the task will be sent - // to the service which is the default service when the task is attempted. + // If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service] is empty, + // then the task will be sent to the service which is the default service when + // the task is attempted. // - // If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty, then the task will be sent - // to the version which is the default version when the task is attempted. + // If [version][google.cloud.tasks.v2beta2.AppEngineRouting.version] is empty, + // then the task will be sent to the version which is the default version when + // the task is attempted. // - // If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is empty, then the task - // will be sent to an instance which is available when the task is - // attempted. + // If [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is + // empty, then the task will be sent to an instance which is available when + // the task is attempted. // // If [service][google.cloud.tasks.v2beta2.AppEngineRouting.service], // [version][google.cloud.tasks.v2beta2.AppEngineRouting.version], or - // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is invalid, then the task - // will be sent to the default version of the default service when - // the task is attempted. + // [instance][google.cloud.tasks.v2beta2.AppEngineRouting.instance] is + // invalid, then the task will be sent to the default version of the default + // service when the task is attempted. string host = 4; } diff --git a/google/cloud/tasks/v2beta2/task.proto b/google/cloud/tasks/v2beta2/task.proto index defaae7e..f9e18be4 100644 --- a/google/cloud/tasks/v2beta2/task.proto +++ b/google/cloud/tasks/v2beta2/task.proto @@ -26,10 +26,10 @@ option java_multiple_files = true; option java_outer_classname = "TaskProto"; option java_package = "com.google.cloud.tasks.v2beta2"; - // A unit of scheduled work. message Task { - // The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] data. + // The view specifies a subset of [Task][google.cloud.tasks.v2beta2.Task] + // data. // // When a task is returned in a response, not all // information is retrieved by default because some data, such as @@ -44,22 +44,26 @@ message Task { // sensitive data. // // This view does not include the - // ([payload in AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] and - // [payload in PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). These payloads are - // desirable to return only when needed, because they can be large - // and because of the sensitivity of the data that you choose to - // store in it. + // ([payload in + // AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] + // and [payload in + // PullMessage][google.cloud.tasks.v2beta2.PullMessage.payload]). These + // payloads are desirable to return only when needed, because they can be + // large and because of the sensitivity of the data that you choose to store + // in it. BASIC = 1; // All information is returned. // - // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Queue][google.cloud.tasks.v2beta2.Queue] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta2.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Queue][google.cloud.tasks.v2beta2.Queue] resource. FULL = 2; } - // Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. + // Optionally caller-specified in + // [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. // // The task name. // @@ -69,7 +73,8 @@ message Task { // * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), // hyphens (-), colons (:), or periods (.). // For more information, see - // [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + // [Identifying + // projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) // * `LOCATION_ID` is the canonical ID for the task's location. // The list of available locations can be obtained by calling // [ListLocations][google.cloud.location.Locations.ListLocations]. @@ -87,16 +92,21 @@ message Task { oneof payload_type { // App Engine HTTP request that is sent to the task's target. Can // be set only if - // [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] is set - // on the queue. + // [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] + // is set on the queue. // - // An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] set. + // An App Engine task is a task that has + // [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] + // set. AppEngineHttpRequest app_engine_http_request = 3; - // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process the task. Can be - // set only if [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the queue. + // [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process + // the task. Can be set only if + // [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the + // queue. // - // A pull task is a task that has [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set. + // A pull task is a task that has + // [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set. PullMessage pull_message = 4; } @@ -107,7 +117,8 @@ message Task { // For pull queues, this is the time when the task is available to // be leased; if a task is currently leased, this is the time when // the current lease expires, that is, the time that the task was - // leased plus the [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. + // leased plus the + // [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. // // `schedule_time` will be truncated to the nearest microsecond. google.protobuf.Timestamp schedule_time = 5; @@ -120,8 +131,8 @@ message Task { // Output only. The task status. TaskStatus status = 7; - // Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta2.Task] has - // been returned. + // Output only. The view specifies which subset of the + // [Task][google.cloud.tasks.v2beta2.Task] has been returned. View view = 8; } @@ -135,20 +146,26 @@ message TaskStatus { // Output only. The number of attempts which have received a response. // - // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage]. + // This field is not calculated for [pull + // tasks][google.cloud.tasks.v2beta2.PullMessage]. int32 attempt_response_count = 2; // Output only. The status of the task's first attempt. // - // Only [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time] will be set. - // The other [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is not retained by Cloud Tasks. + // Only + // [dispatch_time][google.cloud.tasks.v2beta2.AttemptStatus.dispatch_time] + // will be set. The other + // [AttemptStatus][google.cloud.tasks.v2beta2.AttemptStatus] information is + // not retained by Cloud Tasks. // - // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage]. + // This field is not calculated for [pull + // tasks][google.cloud.tasks.v2beta2.PullMessage]. AttemptStatus first_attempt_status = 3; // Output only. The status of the task's last attempt. // - // This field is not calculated for [pull tasks][google.cloud.tasks.v2beta2.PullMessage]. + // This field is not calculated for [pull + // tasks][google.cloud.tasks.v2beta2.PullMessage]. AttemptStatus last_attempt_status = 4; } diff --git a/google/cloud/tasks/v2beta3/cloudtasks.proto b/google/cloud/tasks/v2beta3/cloudtasks.proto index 5eef8b3c..fdf2d65a 100644 --- a/google/cloud/tasks/v2beta3/cloudtasks.proto +++ b/google/cloud/tasks/v2beta3/cloudtasks.proto @@ -32,7 +32,6 @@ option java_outer_classname = "CloudTasksProto"; option java_package = "com.google.cloud.tasks.v2beta3"; option objc_class_prefix = "TASKS"; - // Cloud Tasks allows developers to manage the execution of background // work in their applications. service CloudTasks { @@ -55,14 +54,15 @@ service CloudTasks { // Creates a queue. // // Queues created with this method allow tasks to live for a maximum of 31 - // days. After a task is 31 days old, the task will be deleted regardless of whether - // it was dispatched or not. + // days. After a task is 31 days old, the task will be deleted regardless of + // whether it was dispatched or not. // // 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: "/v2beta3/{parent=projects/*/locations/*}/queues" @@ -76,14 +76,15 @@ service CloudTasks { // the queue if it does exist. // // Queues created with this method allow tasks to live for a maximum of 31 - // days. After a task is 31 days old, the task will be deleted regardless of whether - // it was dispatched or not. + // days. After a task is 31 days old, the task will be deleted regardless of + // whether it was dispatched or not. // // 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: "/v2beta3/{queue.name=projects/*/locations/*/queues/*}" @@ -101,8 +102,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: "/v2beta3/{name=projects/*/locations/*/queues/*}" @@ -126,9 +128,10 @@ service CloudTasks { // // If a queue is paused then the system will stop dispatching tasks // until the queue is resumed via - // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can still be added - // when the queue is paused. A queue is paused if its - // [state][google.cloud.tasks.v2beta3.Queue.state] is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED]. + // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. Tasks can + // still be added when the queue is paused. A queue is paused if its + // [state][google.cloud.tasks.v2beta3.Queue.state] is + // [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED]. rpc PauseQueue(PauseQueueRequest) returns (Queue) { option (google.api.http) = { post: "/v2beta3/{name=projects/*/locations/*/queues/*}:pause" @@ -140,14 +143,17 @@ service CloudTasks { // // This method resumes a queue after it has been // [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED] or - // [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a queue is stored - // in the queue's [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method it - // will be set to [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING]. + // [DISABLED][google.cloud.tasks.v2beta3.Queue.State.DISABLED]. The state of a + // queue is stored in the queue's + // [state][google.cloud.tasks.v2beta3.Queue.state]; after calling this method + // it will be set to + // [RUNNING][google.cloud.tasks.v2beta3.Queue.State.RUNNING]. // // 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: "/v2beta3/{name=projects/*/locations/*/queues/*}:resume" @@ -155,24 +161,25 @@ service CloudTasks { }; } - // Gets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. - // Returns an empty policy if the resource exists and does not have a policy - // set. + // Gets the access control policy for a + // [Queue][google.cloud.tasks.v2beta3.Queue]. Returns an empty policy if the + // resource exists and does not have a policy set. // // Authorization requires the following // [Google IAM](https://cloud.google.com/iam) permission on the specified // resource parent: // // * `cloudtasks.queues.getIamPolicy` - rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc GetIamPolicy(google.iam.v1.GetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:getIamPolicy" body: "*" }; } - // Sets the access control policy for a [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing - // policy. + // Sets the access control policy for a + // [Queue][google.cloud.tasks.v2beta3.Queue]. Replaces any existing policy. // // Note: The Cloud Console does not check queue-level IAM permissions yet. // Project-level permissions are required to use the Cloud Console. @@ -182,21 +189,24 @@ service CloudTasks { // resource parent: // // * `cloudtasks.queues.setIamPolicy` - rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) returns (google.iam.v1.Policy) { + rpc SetIamPolicy(google.iam.v1.SetIamPolicyRequest) + returns (google.iam.v1.Policy) { option (google.api.http) = { post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:setIamPolicy" body: "*" }; } - // Returns permissions that a caller has on a [Queue][google.cloud.tasks.v2beta3.Queue]. - // If the resource does not exist, this will return an empty set of - // permissions, not a [NOT_FOUND][google.rpc.Code.NOT_FOUND] error. + // Returns permissions that a caller has on a + // [Queue][google.cloud.tasks.v2beta3.Queue]. If the resource does not exist, + // this will return an empty set of permissions, not a + // [NOT_FOUND][google.rpc.Code.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. - rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) returns (google.iam.v1.TestIamPermissionsResponse) { + rpc TestIamPermissions(google.iam.v1.TestIamPermissionsRequest) + returns (google.iam.v1.TestIamPermissionsResponse) { option (google.api.http) = { post: "/v2beta3/{resource=projects/*/locations/*/queues/*}:testIamPermissions" body: "*" @@ -205,10 +215,10 @@ service CloudTasks { // Lists the tasks in a queue. // - // By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] view is retrieved - // due to performance considerations; - // [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view] controls the - // subset of information which is returned. + // By default, only the [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC] + // view is retrieved due to performance considerations; + // [response_view][google.cloud.tasks.v2beta3.ListTasksRequest.response_view] + // controls the subset of information which is returned. // // The tasks may be returned in any order. The ordering may change at any // time. @@ -229,7 +239,8 @@ service CloudTasks { // // Tasks cannot be updated after creation; there is no UpdateTask command. // - // * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum task size is + // * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], + // the maximum task size is // 100KB. rpc CreateTask(CreateTaskRequest) returns (Task) { option (google.api.http) = { @@ -252,13 +263,14 @@ service CloudTasks { // Forces a task to run now. // // When this method is called, Cloud Tasks will dispatch the task, even if - // the task is already running, the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or - // is [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED]. + // the task is already running, the queue has reached its + // [RateLimits][google.cloud.tasks.v2beta3.RateLimits] or is + // [PAUSED][google.cloud.tasks.v2beta3.Queue.State.PAUSED]. // // This command is meant to be used for manual debugging. For - // example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be used to retry a failed - // task after a fix has been made or to manually force a task to be - // dispatched now. + // example, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] can be + // used to retry a failed task after a fix has been made or to manually force + // a task to be dispatched now. // // The dispatched task is returned. That is, the task that is returned // contains the [status][Task.status] after the task is dispatched but @@ -266,9 +278,11 @@ service CloudTasks { // // If Cloud Tasks receives a successful response from the task's // target, then the task will be deleted; otherwise the task's - // [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be reset to the time that - // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus the retry delay specified - // in the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. + // [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] will be + // reset to the time that + // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] was called plus + // the retry delay specified in the queue's + // [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. // // [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask] returns // [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a @@ -281,7 +295,8 @@ service CloudTasks { } } -// Request message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. +// Request message for +// [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. message ListQueuesRequest { // Required. // @@ -289,11 +304,11 @@ message ListQueuesRequest { // For example: `projects/PROJECT_ID/locations/LOCATION_ID` string parent = 1; - // `filter` can be used to specify a subset of queues. Any [Queue][google.cloud.tasks.v2beta3.Queue] - // 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). + // `filter` can be used to specify a subset of queues. Any + // [Queue][google.cloud.tasks.v2beta3.Queue] 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). // // Sample filter "state: PAUSED". // @@ -306,22 +321,25 @@ message ListQueuesRequest { // The maximum page size is 9800. If unspecified, the page size will // be the maximum. Fewer queues than requested might be returned, // even if more queues exist; use the - // [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] in the - // response to determine if more queues exist. + // [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] + // in the response to determine if more queues exist. int32 page_size = 3; // A token identifying the page of results to return. // // To request the first page results, page_token must be empty. To // request the next page of results, page_token must be the value of - // [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] returned - // from the previous call to [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] - // method. It is an error to switch the value of the - // [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while iterating through pages. + // [next_page_token][google.cloud.tasks.v2beta3.ListQueuesResponse.next_page_token] + // returned from the previous call to + // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] method. It + // is an error to switch the value of the + // [filter][google.cloud.tasks.v2beta3.ListQueuesRequest.filter] while + // iterating through pages. string page_token = 4; } -// Response message for [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. +// Response message for +// [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues]. message ListQueuesResponse { // The list of queues. repeated Queue queues = 1; @@ -329,7 +347,8 @@ message ListQueuesResponse { // A token to retrieve next page of results. // // To return the next page of results, call - // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] with this value as the + // [ListQueues][google.cloud.tasks.v2beta3.CloudTasks.ListQueues] with this + // value as the // [page_token][google.cloud.tasks.v2beta3.ListQueuesRequest.page_token]. // // If the next_page_token is empty, there are no more results. @@ -338,7 +357,8 @@ message ListQueuesResponse { string next_page_token = 2; } -// Request message for [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue]. +// Request message for +// [GetQueue][google.cloud.tasks.v2beta3.CloudTasks.GetQueue]. message GetQueueRequest { // Required. // @@ -347,7 +367,8 @@ message GetQueueRequest { string name = 1; } -// Request message for [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue]. +// Request message for +// [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue]. message CreateQueueRequest { // Required. // @@ -363,21 +384,25 @@ message CreateQueueRequest { // // The queue to create. // - // [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as an existing queue. + // [Queue's name][google.cloud.tasks.v2beta3.Queue.name] cannot be the same as + // an existing queue. Queue queue = 2; } -// Request message for [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue]. +// Request message for +// [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue]. message UpdateQueueRequest { // Required. // // The queue to create or update. // - // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] must be specified. + // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] must be + // specified. // // Output only fields cannot be modified using UpdateQueue. // Any value specified for an output only field will be ignored. - // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] cannot be changed. + // The queue's [name][google.cloud.tasks.v2beta3.Queue.name] cannot be + // changed. Queue queue = 1; // A mask used to specify which fields of the queue are being updated. @@ -386,7 +411,8 @@ message UpdateQueueRequest { google.protobuf.FieldMask update_mask = 2; } -// Request message for [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue]. +// Request message for +// [DeleteQueue][google.cloud.tasks.v2beta3.CloudTasks.DeleteQueue]. message DeleteQueueRequest { // Required. // @@ -395,7 +421,8 @@ message DeleteQueueRequest { string name = 1; } -// Request message for [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue]. +// Request message for +// [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue]. message PurgeQueueRequest { // Required. // @@ -404,7 +431,8 @@ message PurgeQueueRequest { string name = 1; } -// Request message for [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue]. +// Request message for +// [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue]. message PauseQueueRequest { // Required. // @@ -413,7 +441,8 @@ message PauseQueueRequest { string name = 1; } -// Request message for [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. +// Request message for +// [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue]. message ResumeQueueRequest { // Required. // @@ -422,7 +451,8 @@ message ResumeQueueRequest { string name = 1; } -// Request message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. +// Request message for listing tasks using +// [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. message ListTasksRequest { // Required. // @@ -430,18 +460,19 @@ message ListTasksRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` string parent = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta3.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta3.Task] resource. Task.View response_view = 2; // Requested page size. Fewer tasks than requested might be returned. @@ -449,23 +480,24 @@ message ListTasksRequest { // 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.v2beta3.ListTasksResponse.next_page_token] in the - // response to determine if more tasks exist. + // [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] + // in the response to determine if more tasks exist. int32 page_size = 3; // A token identifying the page of results to return. // // To request the first page results, page_token must be empty. To // request the next page of results, page_token must be the value of - // [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] returned - // from the previous call to [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] - // method. + // [next_page_token][google.cloud.tasks.v2beta3.ListTasksResponse.next_page_token] + // returned from the previous call to + // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] method. // // The page token is valid for only 2 hours. string page_token = 4; } -// Response message for listing tasks using [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. +// Response message for listing tasks using +// [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks]. message ListTasksResponse { // The list of tasks. repeated Task tasks = 1; @@ -473,14 +505,16 @@ message ListTasksResponse { // A token to retrieve next page of results. // // To return the next page of results, call - // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] with this value as the + // [ListTasks][google.cloud.tasks.v2beta3.CloudTasks.ListTasks] with this + // value as the // [page_token][google.cloud.tasks.v2beta3.ListTasksRequest.page_token]. // // If the next_page_token is empty, there are no more results. string next_page_token = 2; } -// Request message for getting a task using [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask]. +// Request message for getting a task using +// [GetTask][google.cloud.tasks.v2beta3.CloudTasks.GetTask]. message GetTaskRequest { // Required. // @@ -488,22 +522,24 @@ message GetTaskRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` string name = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta3.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta3.Task] resource. Task.View response_view = 2; } -// Request message for [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. +// Request message for +// [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. message CreateTaskRequest { // Required. // @@ -519,13 +555,13 @@ message CreateTaskRequest { // // Task names have the following format: // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`. - // The user can optionally specify a task [name][google.cloud.tasks.v2beta3.Task.name]. If a - // name is not specified then the system will generate a random - // unique task id, which will be set in the task returned in the - // [response][google.cloud.tasks.v2beta3.Task.name]. + // The user can optionally specify a task + // [name][google.cloud.tasks.v2beta3.Task.name]. If a name is not specified + // then the system will generate a random unique task id, which will be set in + // the task returned in the [response][google.cloud.tasks.v2beta3.Task.name]. // - // If [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] is not set or is in the - // past then Cloud Tasks will set it to the current time. + // If [schedule_time][google.cloud.tasks.v2beta3.Task.schedule_time] is not + // set or is in the past then Cloud Tasks will set it to the current time. // // Task De-duplication: // @@ -540,28 +576,29 @@ message CreateTaskRequest { // for ~9days after the original task was deleted or executed. // // Because there is an extra lookup cost to identify duplicate task - // names, these [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] calls have significantly - // increased latency. Using hashed strings for the task id or for - // the prefix of the task id is recommended. Choosing task ids that - // are sequential or have sequential prefixes, for example using a + // names, these [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] + // calls have significantly increased latency. Using hashed strings for the + // task id or for the prefix of the task id is recommended. Choosing task ids + // that are sequential or have sequential prefixes, for example using a // timestamp, causes an increase in latency and error rates in all // task commands. The infrastructure relies on an approximately // uniform distribution of task ids to store and serve tasks // efficiently. Task task = 2; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta3.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta3.Task] resource. Task.View response_view = 3; } @@ -584,17 +621,18 @@ message RunTaskRequest { // `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` string name = 1; - // The response_view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] will be - // returned. + // The response_view specifies which subset of the + // [Task][google.cloud.tasks.v2beta3.Task] will be returned. // - // By default response_view is [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all - // information is retrieved by default because some data, such as - // payloads, might be desirable to return only when needed because - // of its large size or because of the sensitivity of data that it - // contains. + // By default response_view is + // [BASIC][google.cloud.tasks.v2beta3.Task.View.BASIC]; not all information is + // retrieved by default because some data, such as payloads, might be + // desirable to return only when needed because of its large size or because + // of the sensitivity of data that it contains. // - // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Task][google.cloud.tasks.v2beta3.Task] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Task][google.cloud.tasks.v2beta3.Task] resource. Task.View response_view = 2; } diff --git a/google/cloud/tasks/v2beta3/queue.proto b/google/cloud/tasks/v2beta3/queue.proto index a4399014..4ee65cdb 100644 --- a/google/cloud/tasks/v2beta3/queue.proto +++ b/google/cloud/tasks/v2beta3/queue.proto @@ -27,7 +27,6 @@ option java_multiple_files = true; option java_outer_classname = "QueueProto"; option java_package = "com.google.cloud.tasks.v2beta3"; - // A queue is a container of related tasks. Queues are configured to manage // how those tasks are dispatched. Configurable properties include rate limits, // retry options, queue types, and others. @@ -69,8 +68,9 @@ message Queue { DISABLED = 3; } - // Caller-specified and required in [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], - // after which it becomes output only. + // Caller-specified and required in + // [CreateQueue][google.cloud.tasks.v2beta3.CloudTasks.CreateQueue], after + // which it becomes output only. // // The queue name. // @@ -80,7 +80,8 @@ message Queue { // * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), // hyphens (-), colons (:), or periods (.). // For more information, see - // [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) + // [Identifying + // projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) // * `LOCATION_ID` is the canonical ID for the queue's location. // The list of available locations can be obtained by calling // [ListLocations][google.cloud.location.Locations.ListLocations]. @@ -90,26 +91,31 @@ message Queue { string name = 1; oneof queue_type { - // [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] settings apply only to - // [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. - // [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by this proto. + // [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] + // settings apply only to [App Engine + // tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest] in this queue. + // [Http tasks][google.cloud.tasks.v2beta3.HttpRequest] are not affected by + // this proto. AppEngineHttpQueue app_engine_http_queue = 3; } // Rate limits for task dispatches. // - // [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are - // related because they both control task attempts. However they control task - // attempts in different ways: + // [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] and + // [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] are related + // because they both control task attempts. However they control task attempts + // in different ways: // - // * [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] controls the total rate of + // * [rate_limits][google.cloud.tasks.v2beta3.Queue.rate_limits] controls the + // total rate of // dispatches from a queue (i.e. all traffic dispatched from the // queue, regardless of whether the dispatch is from a first // attempt or a retry). - // * [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls what happens to + // * [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls + // what happens to // particular a task after its first attempt fails. That is, - // [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls task retries (the - // second attempt, third attempt, etc). + // [retry_config][google.cloud.tasks.v2beta3.Queue.retry_config] controls + // task retries (the second attempt, third attempt, etc). // // The queue's actual dispatch rate is the result of: // @@ -130,25 +136,30 @@ message Queue { // * For tasks created using the App Engine SDK: the queue-level retry // settings apply to all tasks in the queue which do not have retry settings // explicitly set on the task and were created by the App Engine SDK. See - // [App Engine documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). + // [App Engine + // documentation](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks). RetryConfig retry_config = 5; // Output only. The state of the queue. // // `state` can only be changed by called // [PauseQueue][google.cloud.tasks.v2beta3.CloudTasks.PauseQueue], - // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or uploading + // [ResumeQueue][google.cloud.tasks.v2beta3.CloudTasks.ResumeQueue], or + // uploading // [queue.yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref). - // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be used to change `state`. + // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] cannot be + // used to change `state`. State state = 6; // Output only. The last time this queue was purged. // - // All tasks that were [created][google.cloud.tasks.v2beta3.Task.create_time] before this time - // were purged. + // All tasks that were [created][google.cloud.tasks.v2beta3.Task.create_time] + // before this time were purged. // - // A queue can be purged using [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue], the - // [App Engine Task Queue SDK, or the Cloud Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). + // A queue can be purged using + // [PurgeQueue][google.cloud.tasks.v2beta3.CloudTasks.PurgeQueue], the [App + // Engine Task Queue SDK, or the Cloud + // Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). // // Purge time will be truncated to the nearest microsecond. Purge // time will be unset if the queue has never been purged. @@ -160,20 +171,24 @@ message Queue { // This message determines the maximum rate that tasks can be dispatched by a // queue, regardless of whether the dispatch is a first task attempt or a retry. // -// Note: The debugging command, [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task -// even if the queue has reached its [RateLimits][google.cloud.tasks.v2beta3.RateLimits]. +// Note: The debugging command, +// [RunTask][google.cloud.tasks.v2beta3.CloudTasks.RunTask], will run a task +// even if the queue has reached its +// [RateLimits][google.cloud.tasks.v2beta3.RateLimits]. message RateLimits { // The maximum rate at which tasks are dispatched from this queue. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // - // * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], the maximum allowed value + // * For [App Engine queues][google.cloud.tasks.v2beta3.AppEngineHttpQueue], + // the maximum allowed value // is 500. // // // This field has the same meaning as - // [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). + // [rate in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate). double max_dispatches_per_second = 1; // Output only. The max burst size. @@ -201,9 +216,9 @@ message RateLimits { // `queue.yaml/xml`, `max_burst_size` is equal to // [bucket_size](https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size). // Since `max_burst_size` is output only, if - // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] is called on a queue - // created by `queue.yaml/xml`, `max_burst_size` will be reset based - // on the value of + // [UpdateQueue][google.cloud.tasks.v2beta3.CloudTasks.UpdateQueue] is called + // on a queue created by `queue.yaml/xml`, `max_burst_size` will be reset + // based on the value of // [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second], // regardless of whether // [max_dispatches_per_second][google.cloud.tasks.v2beta3.RateLimits.max_dispatches_per_second] @@ -224,7 +239,8 @@ message RateLimits { // // // This field has the same meaning as - // [max_concurrent_requests in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). + // [max_concurrent_requests in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests). int32 max_concurrent_dispatches = 3; } @@ -244,15 +260,16 @@ message RetryConfig { // -1 indicates unlimited attempts. // // This field has the same meaning as - // [task_retry_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [task_retry_limit in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). int32 max_attempts = 1; // If positive, `max_retry_duration` specifies the time limit for // retrying a failed task, measured from when the task was first // attempted. Once `max_retry_duration` time has passed *and* the - // task has been attempted [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] - // times, no further attempts will be made and the task will be - // deleted. + // task has been attempted + // [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times, + // no further attempts will be made and the task will be deleted. // // If zero, then the task age is unlimited. // @@ -263,14 +280,17 @@ message RetryConfig { // `max_retry_duration` will be truncated to the nearest second. // // This field has the same meaning as - // [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [task_age_limit in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration max_retry_duration = 2; - // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between + // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] + // for retry between // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and - // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails, - // if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be - // retried. + // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration + // after it fails, if the queue's + // [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the + // task should be retried. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. @@ -279,14 +299,17 @@ message RetryConfig { // `min_backoff` will be truncated to the nearest second. // // This field has the same meaning as - // [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [min_backoff_seconds in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration min_backoff = 3; - // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] for retry between + // A task will be [scheduled][google.cloud.tasks.v2beta3.Task.schedule_time] + // for retry between // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] and - // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration after it fails, - // if the queue's [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the task should be - // retried. + // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] duration + // after it fails, if the queue's + // [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig] specifies that the + // task should be retried. // // If unspecified when the queue is created, Cloud Tasks will pick the // default. @@ -295,33 +318,37 @@ message RetryConfig { // `max_backoff` will be truncated to the nearest second. // // This field has the same meaning as - // [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [max_backoff_seconds in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). google.protobuf.Duration max_backoff = 4; // The time between retries will double `max_doublings` times. // // A task's retry interval starts at - // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff], then doubles - // `max_doublings` times, then increases linearly, and finally - // retries retries at intervals of + // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff], then + // doubles `max_doublings` times, then increases linearly, and finally retries + // retries at intervals of // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] up to // [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times. // - // For example, if [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] is 10s, - // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] is 300s, and - // `max_doublings` is 3, then the a task will first be retried in - // 10s. The retry interval will double three times, and then - // increase linearly by 2^3 * 10s. Finally, the task will retry at - // intervals of [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] until the - // task has been attempted [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] - // times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, - // 240s, 300s, 300s, .... + // For example, if + // [min_backoff][google.cloud.tasks.v2beta3.RetryConfig.min_backoff] is 10s, + // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] is 300s, + // and `max_doublings` is 3, then the a task will first be retried in 10s. The + // retry interval will double three times, and then increase linearly by 2^3 * + // 10s. Finally, the task will retry at intervals of + // [max_backoff][google.cloud.tasks.v2beta3.RetryConfig.max_backoff] until the + // task has been attempted + // [max_attempts][google.cloud.tasks.v2beta3.RetryConfig.max_attempts] times. + // Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, + // 300s, .... // // If unspecified when the queue is created, Cloud Tasks will pick the // default. // // // This field has the same meaning as - // [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). + // [max_doublings in + // queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters). int32 max_doublings = 5; } diff --git a/google/cloud/tasks/v2beta3/target.proto b/google/cloud/tasks/v2beta3/target.proto index 407c2b66..7a6f2890 100644 --- a/google/cloud/tasks/v2beta3/target.proto +++ b/google/cloud/tasks/v2beta3/target.proto @@ -24,7 +24,6 @@ option java_multiple_files = true; option java_outer_classname = "TargetProto"; option java_package = "com.google.cloud.tasks.v2beta3"; - // HTTP request. // // Warning: This is an [alpha](https://cloud.google.com/terms/launch-stages) @@ -38,7 +37,8 @@ option java_package = "com.google.cloud.tasks.v2beta3"; // task will be retried according to the following: // // * User-specified throttling: [retry configuration][Queue.RetryConfig], -// [rate limits][Queue.RateLimits], and the [queue's state][google.cloud.tasks.v2beta3.Queue.state]. +// [rate limits][Queue.RateLimits], and the [queue's +// state][google.cloud.tasks.v2beta3.Queue.state]. // // * System throttling: To prevent the worker from overloading, Cloud Tasks may // temporarily reduce the queue's effective rate. User-specified settings @@ -105,19 +105,24 @@ message HttpRequest { // HTTP request body. // // A request body is allowed only if the - // [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, PUT, or PATCH. It is an - // error to set body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod]. + // [HTTP method][google.cloud.tasks.v2beta3.HttpRequest.http_method] is POST, + // PUT, or PATCH. It is an error to set body on a task with an incompatible + // [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod]. bytes body = 4; } // App Engine HTTP queue. // // The task will be delivered to the App Engine application hostname -// specified by its [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. -// The documentation for [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] explains how the -// task's host URL is constructed. +// specified by its +// [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] and +// [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest]. The +// documentation for +// [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] +// explains how the task's host URL is constructed. // -// Using [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] requires +// Using [AppEngineHttpQueue][google.cloud.tasks.v2beta3.AppEngineHttpQueue] +// requires // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) // Google IAM permission for the project // and the following scope: @@ -125,11 +130,13 @@ message HttpRequest { // `https://www.googleapis.com/auth/cloud-platform` message AppEngineHttpQueue { // Overrides for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. // // If set, `app_engine_routing_override` is used for all tasks in // the queue, no matter what the setting is for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. AppEngineRouting app_engine_routing_override = 1; } @@ -139,9 +146,11 @@ message AppEngineHttpQueue { // the task is dispatched. // // This proto can only be used for tasks in a queue which has -// [app_engine_http_queue][google.cloud.tasks.v2beta3.Queue.app_engine_http_queue] set. +// [app_engine_http_queue][google.cloud.tasks.v2beta3.Queue.app_engine_http_queue] +// set. // -// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] requires +// Using [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] +// requires // [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control) // Google IAM permission for the project // and the following scope: @@ -150,23 +159,27 @@ message AppEngineHttpQueue { // // The task will be delivered to the App Engine app which belongs to the same // project as the queue. For more information, see -// [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) +// [How Requests are +// Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) // and how routing is affected by -// [dispatch files](https://cloud.google.com/appengine/docs/python/config/dispatchref). +// [dispatch +// files](https://cloud.google.com/appengine/docs/python/config/dispatchref). // Traffic is encrypted during transport and never leaves Google datacenters. // Because this traffic is carried over a communication mechanism internal to // Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). // The request to the handler, however, will appear to have used the HTTP // protocol. // -// The [AppEngineRouting][google.cloud.tasks.v2beta3.AppEngineRouting] used to construct the URL that the task is -// delivered to can be set at the queue-level or task-level: +// The [AppEngineRouting][google.cloud.tasks.v2beta3.AppEngineRouting] used to +// construct the URL that the task is delivered to can be set at the queue-level +// or task-level: // // * If set, // [app_engine_routing_override][google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override] // is used for all tasks in the queue, no matter what the setting // is for the -// [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. +// [task-level +// app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. // // // The `url` that the task will be sent to is: @@ -176,10 +189,12 @@ message AppEngineHttpQueue { // // Tasks can be dispatched to secure app handlers, unsecure app handlers, and // URIs restricted with -// [`login: admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). +// [`login: +// admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). // Because tasks are not run as any user, they cannot be dispatched to URIs // restricted with -// [`login: required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) +// [`login: +// required`](https://cloud.google.com/appengine/docs/standard/python/config/appref) // Task dispatches also do not follow redirects. // // The task attempt has succeeded if the app's request handler returns @@ -195,10 +210,12 @@ message AppEngineHttpRequest { // The app's request handler for the task's target URL must be able to handle // HTTP requests with this http_method, otherwise the task attempt will fail // with error code 405 (Method Not Allowed). See - // [Writing a push task request handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) + // [Writing a push task request + // handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) // and the documentation for the request handlers in the language your app is // written in e.g. - // [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). + // [Python Request + // Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/requesthandlerclass). HttpMethod http_method = 1; // Task-level setting for App Engine routing. @@ -206,7 +223,8 @@ message AppEngineHttpRequest { // If set, // [app_engine_routing_override][google.cloud.tasks.v2beta3.AppEngineHttpQueue.app_engine_routing_override] // is used for all tasks in the queue, no matter what the setting is for the - // [task-level app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. + // [task-level + // app_engine_routing][google.cloud.tasks.v2beta3.AppEngineHttpRequest.app_engine_routing]. AppEngineRouting app_engine_routing = 2; // The relative URI. @@ -232,8 +250,9 @@ message AppEngineHttpRequest { // `"AppEngine-Google; (+http://code.google.com/appengine)"` to the // modified `User-Agent`. // - // If the task has a [body][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body], Cloud - // Tasks sets the following headers: + // If the task has a + // [body][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body], Cloud Tasks + // sets the following headers: // // * `Content-Type`: By default, the `Content-Type` header is set to // `"application/octet-stream"`. The default can be overridden by explicitly @@ -251,19 +270,23 @@ message AppEngineHttpRequest { // // In addition, Cloud Tasks sets some headers when the task is dispatched, // such as headers containing information about the task; see - // [request headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). + // [request + // headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers). // These headers are set only when the task is dispatched, so they are not // visible when the task is returned in a Cloud Tasks response. // // Although there is no specific limit for the maximum number of headers or - // the size, there is a limit on the maximum size of the [Task][google.cloud.tasks.v2beta3.Task]. For more - // information, see the [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] documentation. + // the size, there is a limit on the maximum size of the + // [Task][google.cloud.tasks.v2beta3.Task]. For more information, see the + // [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask] + // documentation. map headers = 4; // HTTP request body. // // A request body is allowed only if the HTTP method is POST or PUT. It is - // an error to set a body on a task with an incompatible [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod]. + // an error to set a body on a task with an incompatible + // [HttpMethod][google.cloud.tasks.v2beta3.HttpMethod]. bytes body = 5; } @@ -273,10 +296,14 @@ message AppEngineHttpRequest { // and instance. // // For more information about services, versions, and instances see -// [An Overview of App Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), -// [Microservices Architecture on Google App Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), -// [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), -// and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). +// [An Overview of App +// Engine](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine), +// [Microservices Architecture on Google App +// Engine](https://cloud.google.com/appengine/docs/python/microservices-on-app-engine), +// [App Engine Standard request +// routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed), +// and [App Engine Flex request +// routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). message AppEngineRouting { // App service. // @@ -284,16 +311,18 @@ message AppEngineRouting { // service when the task is attempted. // // For some queues or tasks which were created using the App Engine - // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable - // into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], - // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For example, some tasks - // which were created using the App Engine SDK use a custom domain - // name; custom domains are not parsed by Cloud Tasks. If - // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then + // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is + // not parsable into // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string. + // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For + // example, some tasks which were created using the App Engine SDK use a + // custom domain name; custom domains are not parsed by Cloud Tasks. If + // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, + // then [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], + // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and + // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the + // empty string. string service = 1; // App version. @@ -302,16 +331,18 @@ message AppEngineRouting { // version when the task is attempted. // // For some queues or tasks which were created using the App Engine - // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable - // into [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], - // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For example, some tasks - // which were created using the App Engine SDK use a custom domain - // name; custom domains are not parsed by Cloud Tasks. If - // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, then + // Task Queue API, [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is + // not parsable into // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and - // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the empty string. + // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. For + // example, some tasks which were created using the App Engine SDK use a + // custom domain name; custom domains are not parsed by Cloud Tasks. If + // [host][google.cloud.tasks.v2beta3.AppEngineRouting.host] is not parsable, + // then [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], + // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and + // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance] are the + // empty string. string version = 2; // App instance. @@ -320,22 +351,28 @@ message AppEngineRouting { // the task is attempted. // // Requests can only be sent to a specific instance if - // [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + // [manual scaling is used in App Engine + // Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). // App Engine Flex does not support instances. For more information, see - // [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) - // and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). + // [App Engine Standard request + // routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) + // and [App Engine Flex request + // routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed). string instance = 3; // Output only. The host that the task is sent to. // // The host is constructed from the domain name of the app associated with // the queue's project ID (for example .appspot.com), and the - // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], - // and [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. Tasks which were created using - // the App Engine SDK might have a custom domain name. + // [service][google.cloud.tasks.v2beta3.AppEngineRouting.service], + // [version][google.cloud.tasks.v2beta3.AppEngineRouting.version], and + // [instance][google.cloud.tasks.v2beta3.AppEngineRouting.instance]. Tasks + // which were created using the App Engine SDK might have a custom domain + // name. // // For more information, see - // [How Requests are Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). + // [How Requests are + // Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed). string host = 4; } diff --git a/google/cloud/tasks/v2beta3/task.proto b/google/cloud/tasks/v2beta3/task.proto index e4c474fd..4d32acd1 100644 --- a/google/cloud/tasks/v2beta3/task.proto +++ b/google/cloud/tasks/v2beta3/task.proto @@ -28,10 +28,10 @@ option java_multiple_files = true; option java_outer_classname = "TaskProto"; option java_package = "com.google.cloud.tasks.v2beta3"; - // A unit of scheduled work. message Task { - // The view specifies a subset of [Task][google.cloud.tasks.v2beta3.Task] data. + // The view specifies a subset of [Task][google.cloud.tasks.v2beta3.Task] + // data. // // When a task is returned in a response, not all // information is retrieved by default because some data, such as @@ -46,7 +46,8 @@ message Task { // sensitive data. // // This view does not include the - // [body in AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body]. + // [body in + // AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest.body]. // Bodies are desirable to return only when needed, because they // can be large and because of the sensitivity of the data that you // choose to store in it. @@ -54,13 +55,15 @@ message Task { // All information is returned. // - // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] requires - // `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/) - // permission on the [Queue][google.cloud.tasks.v2beta3.Queue] resource. + // Authorization for [FULL][google.cloud.tasks.v2beta3.Task.View.FULL] + // requires `cloudtasks.tasks.fullView` [Google + // IAM](https://cloud.google.com/iam/) permission on the + // [Queue][google.cloud.tasks.v2beta3.Queue] resource. FULL = 2; } - // Optionally caller-specified in [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. + // Optionally caller-specified in + // [CreateTask][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. // // The task name. // @@ -86,7 +89,9 @@ message Task { oneof payload_type { // HTTP request that is sent to the App Engine app handler. // - // An App Engine task is a task that has [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] set. + // An App Engine task is a task that has + // [AppEngineHttpRequest][google.cloud.tasks.v2beta3.AppEngineHttpRequest] + // set. AppEngineHttpRequest app_engine_http_request = 3; // HTTP request that is sent to the task's target. @@ -95,7 +100,8 @@ message Task { // feature. If you haven't already joined, you can [use this form to sign // up](https://docs.google.com/forms/d/e/1FAIpQLSfc4uEy9CBHKYUSdnY1hdhKDCX7julVZHy3imOiR-XrU7bUNQ/viewform?usp=sf_link). // - // An HTTP task is a task that has [HttpRequest][google.cloud.tasks.v2beta3.HttpRequest] set. + // An HTTP task is a task that has + // [HttpRequest][google.cloud.tasks.v2beta3.HttpRequest] set. HttpRequest http_request = 11; } @@ -114,7 +120,8 @@ message Task { // The deadline for requests sent to the worker. If the worker does not // respond by this deadline then the request is cancelled and the attempt // is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the - // task according to the [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. + // task according to the + // [RetryConfig][google.cloud.tasks.v2beta3.RetryConfig]. // // Note that when the request is cancelled, Cloud Tasks will stop listing for // the response, but whether the worker stops processing depends on the @@ -127,9 +134,11 @@ message Task { // 10 minutes. // The deadline must be in the interval [15 seconds, 30 minutes]. // - // * For [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest], 0 indicates that the + // * For [App Engine tasks][google.cloud.tasks.v2beta3.AppEngineHttpRequest], + // 0 indicates that the // request has the default deadline. The default deadline depends on the - // [scaling type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) + // [scaling + // type](https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling) // of the service: 10 minutes for standard apps with automatic scaling, 24 // hours for standard apps with manual and basic scaling, and 60 minutes for // flex apps. If the request deadline is set, it must be in the interval [15 @@ -155,15 +164,16 @@ message Task { // Output only. The status of the task's first attempt. // - // Only [dispatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_time] will be set. - // The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information is not retained by Cloud Tasks. + // Only [dispatch_time][google.cloud.tasks.v2beta3.Attempt.dispatch_time] will + // be set. The other [Attempt][google.cloud.tasks.v2beta3.Attempt] information + // is not retained by Cloud Tasks. Attempt first_attempt = 8; // Output only. The status of the task's last attempt. Attempt last_attempt = 9; - // Output only. The view specifies which subset of the [Task][google.cloud.tasks.v2beta3.Task] has - // been returned. + // Output only. The view specifies which subset of the + // [Task][google.cloud.tasks.v2beta3.Task] has been returned. View view = 10; }