UNPKG

@google-cloud/tasks

Version:
1,133 lines (1,132 loc) 213 kB
{ "nested": { "google": { "nested": { "cloud": { "nested": { "tasks": { "nested": { "v2": { "options": { "go_package": "cloud.google.com/go/cloudtasks/apiv2/cloudtaskspb;cloudtaskspb", "java_multiple_files": true, "java_outer_classname": "TaskProto", "java_package": "com.google.cloud.tasks.v2", "objc_class_prefix": "TASKS" }, "nested": { "CloudTasks": { "options": { "(google.api.default_host)": "cloudtasks.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "ListQueues": { "requestType": "ListQueuesRequest", "responseType": "ListQueuesResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*/locations/*}/queues", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*/locations/*}/queues" } }, { "(google.api.method_signature)": "parent" } ] }, "GetQueue": { "requestType": "GetQueueRequest", "responseType": "Queue", "options": { "(google.api.http).get": "/v2/{name=projects/*/locations/*/queues/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{name=projects/*/locations/*/queues/*}" } }, { "(google.api.method_signature)": "name" } ] }, "CreateQueue": { "requestType": "CreateQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2/{parent=projects/*/locations/*}/queues", "(google.api.http).body": "queue", "(google.api.method_signature)": "parent,queue" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*/locations/*}/queues", "body": "queue" } }, { "(google.api.method_signature)": "parent,queue" } ] }, "UpdateQueue": { "requestType": "UpdateQueueRequest", "responseType": "Queue", "options": { "(google.api.http).patch": "/v2/{queue.name=projects/*/locations/*/queues/*}", "(google.api.http).body": "queue", "(google.api.method_signature)": "queue,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v2/{queue.name=projects/*/locations/*/queues/*}", "body": "queue" } }, { "(google.api.method_signature)": "queue,update_mask" } ] }, "DeleteQueue": { "requestType": "DeleteQueueRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v2/{name=projects/*/locations/*/queues/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v2/{name=projects/*/locations/*/queues/*}" } }, { "(google.api.method_signature)": "name" } ] }, "PurgeQueue": { "requestType": "PurgeQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2/{name=projects/*/locations/*/queues/*}:purge", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{name=projects/*/locations/*/queues/*}:purge", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "PauseQueue": { "requestType": "PauseQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2/{name=projects/*/locations/*/queues/*}:pause", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{name=projects/*/locations/*/queues/*}:pause", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "ResumeQueue": { "requestType": "ResumeQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2/{name=projects/*/locations/*/queues/*}:resume", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{name=projects/*/locations/*/queues/*}:resume", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "GetIamPolicy": { "requestType": "google.iam.v1.GetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).post": "/v2/{resource=projects/*/locations/*/queues/*}:getIamPolicy", "(google.api.http).body": "*", "(google.api.method_signature)": "resource" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{resource=projects/*/locations/*/queues/*}:getIamPolicy", "body": "*" } }, { "(google.api.method_signature)": "resource" } ] }, "SetIamPolicy": { "requestType": "google.iam.v1.SetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).post": "/v2/{resource=projects/*/locations/*/queues/*}:setIamPolicy", "(google.api.http).body": "*", "(google.api.method_signature)": "resource,policy" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{resource=projects/*/locations/*/queues/*}:setIamPolicy", "body": "*" } }, { "(google.api.method_signature)": "resource,policy" } ] }, "TestIamPermissions": { "requestType": "google.iam.v1.TestIamPermissionsRequest", "responseType": "google.iam.v1.TestIamPermissionsResponse", "options": { "(google.api.http).post": "/v2/{resource=projects/*/locations/*/queues/*}:testIamPermissions", "(google.api.http).body": "*", "(google.api.method_signature)": "resource,permissions" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{resource=projects/*/locations/*/queues/*}:testIamPermissions", "body": "*" } }, { "(google.api.method_signature)": "resource,permissions" } ] }, "ListTasks": { "requestType": "ListTasksRequest", "responseType": "ListTasksResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*/locations/*/queues/*}/tasks", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*/locations/*/queues/*}/tasks" } }, { "(google.api.method_signature)": "parent" } ] }, "GetTask": { "requestType": "GetTaskRequest", "responseType": "Task", "options": { "(google.api.http).get": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" } }, { "(google.api.method_signature)": "name" } ] }, "CreateTask": { "requestType": "CreateTaskRequest", "responseType": "Task", "options": { "(google.api.http).post": "/v2/{parent=projects/*/locations/*/queues/*}/tasks", "(google.api.http).body": "*", "(google.api.method_signature)": "parent,task" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*/locations/*/queues/*}/tasks", "body": "*" } }, { "(google.api.method_signature)": "parent,task" } ] }, "DeleteTask": { "requestType": "DeleteTaskRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}" } }, { "(google.api.method_signature)": "name" } ] }, "RunTask": { "requestType": "RunTaskRequest", "responseType": "Task", "options": { "(google.api.http).post": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}:run", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{name=projects/*/locations/*/queues/*/tasks/*}:run", "body": "*" } }, { "(google.api.method_signature)": "name" } ] } } }, "ListQueuesRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "cloudtasks.googleapis.com/Queue" } }, "filter": { "type": "string", "id": 2 }, "pageSize": { "type": "int32", "id": 3 }, "pageToken": { "type": "string", "id": 4 } } }, "ListQueuesResponse": { "fields": { "queues": { "rule": "repeated", "type": "Queue", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "GetQueueRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Queue" } } } }, "CreateQueueRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "cloudtasks.googleapis.com/Queue" } }, "queue": { "type": "Queue", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "UpdateQueueRequest": { "fields": { "queue": { "type": "Queue", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2 } } }, "DeleteQueueRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Queue" } } } }, "PurgeQueueRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Queue" } } } }, "PauseQueueRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Queue" } } } }, "ResumeQueueRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Queue" } } } }, "ListTasksRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "cloudtasks.googleapis.com/Task" } }, "responseView": { "type": "Task.View", "id": 2 }, "pageSize": { "type": "int32", "id": 3 }, "pageToken": { "type": "string", "id": 4 } } }, "ListTasksResponse": { "fields": { "tasks": { "rule": "repeated", "type": "Task", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 } } }, "GetTaskRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Task" } }, "responseView": { "type": "Task.View", "id": 2 } } }, "CreateTaskRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).child_type": "cloudtasks.googleapis.com/Task" } }, "task": { "type": "Task", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "responseView": { "type": "Task.View", "id": 3 } } }, "DeleteTaskRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Task" } } } }, "RunTaskRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudtasks.googleapis.com/Task" } }, "responseView": { "type": "Task.View", "id": 2 } } }, "Queue": { "options": { "(google.api.resource).type": "cloudtasks.googleapis.com/Queue", "(google.api.resource).pattern": "projects/{project}/locations/{location}/queues/{queue}" }, "fields": { "name": { "type": "string", "id": 1 }, "appEngineRoutingOverride": { "type": "AppEngineRouting", "id": 2 }, "rateLimits": { "type": "RateLimits", "id": 3 }, "retryConfig": { "type": "RetryConfig", "id": 4 }, "state": { "type": "State", "id": 5 }, "purgeTime": { "type": "google.protobuf.Timestamp", "id": 6 }, "stackdriverLoggingConfig": { "type": "StackdriverLoggingConfig", "id": 9 } }, "nested": { "State": { "values": { "STATE_UNSPECIFIED": 0, "RUNNING": 1, "PAUSED": 2, "DISABLED": 3 } } } }, "RateLimits": { "fields": { "maxDispatchesPerSecond": { "type": "double", "id": 1 }, "maxBurstSize": { "type": "int32", "id": 2 }, "maxConcurrentDispatches": { "type": "int32", "id": 3 } } }, "RetryConfig": { "fields": { "maxAttempts": { "type": "int32", "id": 1 }, "maxRetryDuration": { "type": "google.protobuf.Duration", "id": 2 }, "minBackoff": { "type": "google.protobuf.Duration", "id": 3 }, "maxBackoff": { "type": "google.protobuf.Duration", "id": 4 }, "maxDoublings": { "type": "int32", "id": 5 } } }, "StackdriverLoggingConfig": { "fields": { "samplingRatio": { "type": "double", "id": 1 } } }, "HttpRequest": { "oneofs": { "authorizationHeader": { "oneof": [ "oauthToken", "oidcToken" ] } }, "fields": { "url": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "httpMethod": { "type": "HttpMethod", "id": 2 }, "headers": { "keyType": "string", "type": "string", "id": 3 }, "body": { "type": "bytes", "id": 4 }, "oauthToken": { "type": "OAuthToken", "id": 5 }, "oidcToken": { "type": "OidcToken", "id": 6 } } }, "AppEngineHttpRequest": { "fields": { "httpMethod": { "type": "HttpMethod", "id": 1 }, "appEngineRouting": { "type": "AppEngineRouting", "id": 2 }, "relativeUri": { "type": "string", "id": 3 }, "headers": { "keyType": "string", "type": "string", "id": 4 }, "body": { "type": "bytes", "id": 5 } } }, "AppEngineRouting": { "fields": { "service": { "type": "string", "id": 1 }, "version": { "type": "string", "id": 2 }, "instance": { "type": "string", "id": 3 }, "host": { "type": "string", "id": 4 } } }, "HttpMethod": { "values": { "HTTP_METHOD_UNSPECIFIED": 0, "POST": 1, "GET": 2, "HEAD": 3, "PUT": 4, "DELETE": 5, "PATCH": 6, "OPTIONS": 7 } }, "OAuthToken": { "fields": { "serviceAccountEmail": { "type": "string", "id": 1 }, "scope": { "type": "string", "id": 2 } } }, "OidcToken": { "fields": { "serviceAccountEmail": { "type": "string", "id": 1 }, "audience": { "type": "string", "id": 2 } } }, "Task": { "options": { "(google.api.resource).type": "cloudtasks.googleapis.com/Task", "(google.api.resource).pattern": "projects/{project}/locations/{location}/queues/{queue}/tasks/{task}" }, "oneofs": { "messageType": { "oneof": [ "appEngineHttpRequest", "httpRequest" ] } }, "fields": { "name": { "type": "string", "id": 1 }, "appEngineHttpRequest": { "type": "AppEngineHttpRequest", "id": 2 }, "httpRequest": { "type": "HttpRequest", "id": 3 }, "scheduleTime": { "type": "google.protobuf.Timestamp", "id": 4 }, "createTime": { "type": "google.protobuf.Timestamp", "id": 5 }, "dispatchDeadline": { "type": "google.protobuf.Duration", "id": 6 }, "dispatchCount": { "type": "int32", "id": 7 }, "responseCount": { "type": "int32", "id": 8 }, "firstAttempt": { "type": "Attempt", "id": 9 }, "lastAttempt": { "type": "Attempt", "id": 10 }, "view": { "type": "View", "id": 11 } }, "nested": { "View": { "values": { "VIEW_UNSPECIFIED": 0, "BASIC": 1, "FULL": 2 } } } }, "Attempt": { "fields": { "scheduleTime": { "type": "google.protobuf.Timestamp", "id": 1 }, "dispatchTime": { "type": "google.protobuf.Timestamp", "id": 2 }, "responseTime": { "type": "google.protobuf.Timestamp", "id": 3 }, "responseStatus": { "type": "google.rpc.Status", "id": 4 } } } } }, "v2beta2": { "options": { "go_package": "cloud.google.com/go/cloudtasks/apiv2beta2/cloudtaskspb;cloudtaskspb", "java_multiple_files": true, "java_outer_classname": "OldTargetProto", "java_package": "com.google.cloud.tasks.v2beta2", "objc_class_prefix": "TASKS", "(google.api.resource_definition).type": "cloudtasks.googleapis.com/Location", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}" }, "nested": { "CloudTasks": { "options": { "(google.api.default_host)": "cloudtasks.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "ListQueues": { "requestType": "ListQueuesRequest", "responseType": "ListQueuesResponse", "options": { "(google.api.http).get": "/v2beta2/{parent=projects/*/locations/*}/queues", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2beta2/{parent=projects/*/locations/*}/queues" } }, { "(google.api.method_signature)": "parent" } ] }, "GetQueue": { "requestType": "GetQueueRequest", "responseType": "Queue", "options": { "(google.api.http).get": "/v2beta2/{name=projects/*/locations/*/queues/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2beta2/{name=projects/*/locations/*/queues/*}" } }, { "(google.api.method_signature)": "name" } ] }, "CreateQueue": { "requestType": "CreateQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2beta2/{parent=projects/*/locations/*}/queues", "(google.api.http).body": "queue", "(google.api.method_signature)": "parent,queue" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{parent=projects/*/locations/*}/queues", "body": "queue" } }, { "(google.api.method_signature)": "parent,queue" } ] }, "UpdateQueue": { "requestType": "UpdateQueueRequest", "responseType": "Queue", "options": { "(google.api.http).patch": "/v2beta2/{queue.name=projects/*/locations/*/queues/*}", "(google.api.http).body": "queue", "(google.api.method_signature)": "queue,update_mask" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v2beta2/{queue.name=projects/*/locations/*/queues/*}", "body": "queue" } }, { "(google.api.method_signature)": "queue,update_mask" } ] }, "DeleteQueue": { "requestType": "DeleteQueueRequest", "responseType": "google.protobuf.Empty", "options": { "(google.api.http).delete": "/v2beta2/{name=projects/*/locations/*/queues/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v2beta2/{name=projects/*/locations/*/queues/*}" } }, { "(google.api.method_signature)": "name" } ] }, "PurgeQueue": { "requestType": "PurgeQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2beta2/{name=projects/*/locations/*/queues/*}:purge", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{name=projects/*/locations/*/queues/*}:purge", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "PauseQueue": { "requestType": "PauseQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2beta2/{name=projects/*/locations/*/queues/*}:pause", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{name=projects/*/locations/*/queues/*}:pause", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "ResumeQueue": { "requestType": "ResumeQueueRequest", "responseType": "Queue", "options": { "(google.api.http).post": "/v2beta2/{name=projects/*/locations/*/queues/*}:resume", "(google.api.http).body": "*", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{name=projects/*/locations/*/queues/*}:resume", "body": "*" } }, { "(google.api.method_signature)": "name" } ] }, "UploadQueueYaml": { "requestType": "UploadQueueYamlRequest", "responseType": "google.protobuf.Empty" }, "GetIamPolicy": { "requestType": "google.iam.v1.GetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy", "(google.api.http).body": "*", "(google.api.method_signature)": "resource" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:getIamPolicy", "body": "*" } }, { "(google.api.method_signature)": "resource" } ] }, "SetIamPolicy": { "requestType": "google.iam.v1.SetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy", "(google.api.http).body": "*", "(google.api.method_signature)": "resource,policy" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:setIamPolicy", "body": "*" } }, { "(google.api.method_signature)": "resource,policy" } ] }, "TestIamPermissions": { "requestType": "google.iam.v1.TestIamPermissionsRequest", "responseType": "google.iam.v1.TestIamPermissionsResponse", "options": { "(google.api.http).post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions", "(google.api.http).body": "*", "(google.api.method_signature)": "resource,permissions" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2beta2/{resource=projects/*/locations/*/queues/*}:testIamPermissions", "body": "*" } }, { "(google.api.method_signature)": "resource,permissions" } ] }, "ListTasks": { "requestType": "ListTasksRequest", "responseType": "ListTasksResponse", "options": { "(google.api.http).get": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2beta2/{parent=projects/*/locations/*/queues/*}/tasks" } }, { "(google.api.method_signature)": "parent" } ] }, "GetTask": { "requestType": "GetTaskRequest", "responseType": "Task", "options": { "(google.api.http).get": "/v2beta2/{name=projects/*/locations/*/queues/*/tasks/*}",