"""Generated message classes for cloudtasks version v2.

Manages the execution of large numbers of distributed requests.
"""
# NOTE: This file is autogenerated and should not be edited by hand.

from __future__ import absolute_import

from apitools.base.protorpclite import messages as _messages
from apitools.base.py import encoding
from apitools.base.py import extra_types


package = 'cloudtasks'


class AppEngineHttpRequest(_messages.Message):
  r"""App Engine HTTP request. The message defines the HTTP request that is
  sent to an App Engine app when the task is dispatched. Using
  AppEngineHttpRequest requires [`appengine.applications.get`](https://cloud.g
  oogle.com/appengine/docs/admin-api/access-control) Google IAM permission for
  the project and the following scope: `https://www.googleapis.com/auth/cloud-
  platform` 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) and how routing is affected by [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 used to construct the URL that the task is
  delivered to can be set at the queue-level or task-level: * If
  app_engine_routing_override is set on the queue, this value is used for all
  tasks in the queue, no matter what the setting is for the task-level
  app_engine_routing. The `url` that the task will be sent to is: * `url =`
  host `+` relative_uri Tasks can be dispatched to secure app handlers,
  unsecure app handlers, and URIs restricted with [`login: admin`](https://clo
  ud.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) Task dispatches also do not follow redirects. The task
  attempt has succeeded if the app's request handler returns an HTTP response
  code in the range [`200` - `299`]. The task attempt has failed if the app's
  handler returns a non-2xx response code or Cloud Tasks does not receive
  response before the deadline. Failed tasks will be retried according to the
  retry configuration. `503` (Service Unavailable) is considered an App Engine
  system error instead of an application error and will cause Cloud Tasks'
  traffic congestion control to temporarily throttle the queue's dispatches.
  Unlike other types of task targets, a `429` (Too Many Requests) response
  from an app handler does not cause traffic congestion control to throttle
  the queue.

  Enums:
    HttpMethodValueValuesEnum: The HTTP method to use for the request. The
      default is POST. 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 fails 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) and the App Engine
      documentation for your runtime on [How Requests are
      Handled](https://cloud.google.com/appengine/docs/standard/python3/how-
      requests-are-handled).

  Messages:
    HeadersValue: HTTP request headers. This map contains the header field
      names and values. Headers can be set when the task is created. Repeated
      headers are not supported but a header value can contain commas. Cloud
      Tasks sets some headers to default values: * `User-Agent`: By default,
      this header is `"AppEngine-Google;
      (+http://code.google.com/appengine)"`. This header can be modified, but
      Cloud Tasks will append `"AppEngine-Google;
      (+http://code.google.com/appengine)"` to the modified `User-Agent`. If
      the task has a 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 setting `Content-Type` to a particular media type when the
      task is created. For example, `Content-Type` can be set to
      `"application/json"`. * `Content-Length`: This is computed by Cloud
      Tasks. This value is output only. It cannot be changed. The headers
      below cannot be set or overridden: * `Host` * `X-Google-*` *
      `X-AppEngine-*` 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/tasks/docs/creating-
      appengine-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. For more information, see the CreateTask
      documentation.

  Fields:
    appEngineRouting: Task-level setting for App Engine routing. * If
      app_engine_routing_override is set on the queue, this value is used for
      all tasks in the queue, no matter what the setting is for the task-level
      app_engine_routing.
    body: 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.
    headers: HTTP request headers. This map contains the header field names
      and values. Headers can be set when the task is created. Repeated
      headers are not supported but a header value can contain commas. Cloud
      Tasks sets some headers to default values: * `User-Agent`: By default,
      this header is `"AppEngine-Google;
      (+http://code.google.com/appengine)"`. This header can be modified, but
      Cloud Tasks will append `"AppEngine-Google;
      (+http://code.google.com/appengine)"` to the modified `User-Agent`. If
      the task has a 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 setting `Content-Type` to a particular media type when the
      task is created. For example, `Content-Type` can be set to
      `"application/json"`. * `Content-Length`: This is computed by Cloud
      Tasks. This value is output only. It cannot be changed. The headers
      below cannot be set or overridden: * `Host` * `X-Google-*` *
      `X-AppEngine-*` 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/tasks/docs/creating-
      appengine-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. For more information, see the CreateTask
      documentation.
    httpMethod: The HTTP method to use for the request. The default is POST.
      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
      fails 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) and the App
      Engine documentation for your runtime on [How Requests are
      Handled](https://cloud.google.com/appengine/docs/standard/python3/how-
      requests-are-handled).
    relativeUri: The relative URI. The relative URI must begin with "/" and
      must be a valid HTTP relative URI. It can contain a path and query
      string arguments. If the relative URI is empty, then the root path "/"
      will be used. No spaces are allowed, and the maximum length allowed is
      2083 characters.
  """

  class HttpMethodValueValuesEnum(_messages.Enum):
    r"""The HTTP method to use for the request. The default is POST. 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 fails with
    error code 405 (Method Not Allowed). See [Writing a push task request hand
    ler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-
    handlers#writing_a_push_task_request_handler) and the App Engine
    documentation for your runtime on [How Requests are
    Handled](https://cloud.google.com/appengine/docs/standard/python3/how-
    requests-are-handled).

    Values:
      HTTP_METHOD_UNSPECIFIED: HTTP method unspecified
      POST: HTTP POST
      GET: HTTP GET
      HEAD: HTTP HEAD
      PUT: HTTP PUT
      DELETE: HTTP DELETE
      PATCH: HTTP PATCH
      OPTIONS: HTTP OPTIONS
    """
    HTTP_METHOD_UNSPECIFIED = 0
    POST = 1
    GET = 2
    HEAD = 3
    PUT = 4
    DELETE = 5
    PATCH = 6
    OPTIONS = 7

  @encoding.MapUnrecognizedFields('additionalProperties')
  class HeadersValue(_messages.Message):
    r"""HTTP request headers. This map contains the header field names and
    values. Headers can be set when the task is created. Repeated headers are
    not supported but a header value can contain commas. Cloud Tasks sets some
    headers to default values: * `User-Agent`: By default, this header is
    `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can
    be modified, but Cloud Tasks will append `"AppEngine-Google;
    (+http://code.google.com/appengine)"` to the modified `User-Agent`. If the
    task has a 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 setting `Content-
    Type` to a particular media type when the task is created. For example,
    `Content-Type` can be set to `"application/json"`. * `Content-Length`:
    This is computed by Cloud Tasks. This value is output only. It cannot be
    changed. The headers below cannot be set or overridden: * `Host` *
    `X-Google-*` * `X-AppEngine-*` 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/tasks/docs/creating-appengine-
    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. For more information, see the CreateTask documentation.

    Messages:
      AdditionalProperty: An additional property for a HeadersValue object.

    Fields:
      additionalProperties: Additional properties of type HeadersValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a HeadersValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  appEngineRouting = _messages.MessageField('AppEngineRouting', 1)
  body = _messages.BytesField(2)
  headers = _messages.MessageField('HeadersValue', 3)
  httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 4)
  relativeUri = _messages.StringField(5)


class AppEngineRouting(_messages.Message):
  r"""App Engine Routing. Defines routing characteristics specific to App
  Engine - service, version, 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). Using AppEngineRouting requires [`appengine.applicatio
  ns.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
  Google IAM permission for the project and the following scope:
  `https://www.googleapis.com/auth/cloud-platform`

  Fields:
    host: 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, version, and
      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).
    instance: App instance. By default, the task is sent to an instance which
      is available when 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). 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).
    service: App service. By default, the task is sent to the service which is
      the default service when the task is attempted. For some queues or tasks
      which were created using the App Engine Task Queue API, host is not
      parsable into service, version, and 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 is not parsable,
      then service, version, and instance are the empty string.
    version: App version. By default, the task is sent to the version which is
      the default version when the task is attempted. For some queues or tasks
      which were created using the App Engine Task Queue API, host is not
      parsable into service, version, and 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 is not parsable,
      then service, version, and instance are the empty string.
  """

  host = _messages.StringField(1)
  instance = _messages.StringField(2)
  service = _messages.StringField(3)
  version = _messages.StringField(4)


class Attempt(_messages.Message):
  r"""The status of a task attempt.

  Fields:
    dispatchTime: Output only. The time that this attempt was dispatched.
      `dispatch_time` will be truncated to the nearest microsecond.
    responseStatus: Output only. The response from the worker for this
      attempt. If `response_time` is unset, then the task has not been
      attempted or is currently running and the `response_status` field is
      meaningless.
    responseTime: Output only. The time that this attempt response was
      received. `response_time` will be truncated to the nearest microsecond.
    scheduleTime: Output only. The time that this attempt was scheduled.
      `schedule_time` will be truncated to the nearest microsecond.
  """

  dispatchTime = _messages.StringField(1)
  responseStatus = _messages.MessageField('Status', 2)
  responseTime = _messages.StringField(3)
  scheduleTime = _messages.StringField(4)


class Binding(_messages.Message):
  r"""Associates `members`, or principals, with a `role`.

  Fields:
    condition: The condition that is associated with this binding. If the
      condition evaluates to `true`, then this binding applies to the current
      request. If the condition evaluates to `false`, then this binding does
      not apply to the current request. However, a different role binding
      might grant the same role to one or more of the principals in this
      binding. To learn which resources support conditions in their IAM
      policies, see the [IAM
      documentation](https://cloud.google.com/iam/help/conditions/resource-
      policies).
    members: Specifies the principals requesting access for a Google Cloud
      resource. `members` can have the following values: * `allUsers`: A
      special identifier that represents anyone who is on the internet; with
      or without a Google account. * `allAuthenticatedUsers`: A special
      identifier that represents anyone who is authenticated with a Google
      account or a service account. Does not include identities that come from
      external identity providers (IdPs) through identity federation. *
      `user:{emailid}`: An email address that represents a specific Google
      account. For example, `alice@example.com` . *
      `serviceAccount:{emailid}`: An email address that represents a Google
      service account. For example, `my-other-
      app@appspot.gserviceaccount.com`. *
      `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`:
      An identifier for a [Kubernetes service
      account](https://cloud.google.com/kubernetes-engine/docs/how-
      to/kubernetes-service-accounts). For example, `my-
      project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
      `group:{emailid}`: An email address that represents a Google group. For
      example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
      (primary) that represents all the users of that domain. For example,
      `google.com` or `example.com`. * `principal://iam.googleapis.com/locatio
      ns/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A
      single identity in a workforce identity pool. * `principalSet://iam.goog
      leapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
      All workforce identities in a group. * `principalSet://iam.googleapis.co
      m/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{
      attribute_value}`: All workforce identities with a specific attribute
      value. * `principalSet://iam.googleapis.com/locations/global/workforcePo
      ols/{pool_id}/*`: All identities in a workforce identity pool. * `princi
      pal://iam.googleapis.com/projects/{project_number}/locations/global/work
      loadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
      identity in a workload identity pool. * `principalSet://iam.googleapis.c
      om/projects/{project_number}/locations/global/workloadIdentityPools/{poo
      l_id}/group/{group_id}`: A workload identity pool group. * `principalSet
      ://iam.googleapis.com/projects/{project_number}/locations/global/workloa
      dIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
      All identities in a workload identity pool with a certain attribute. * `
      principalSet://iam.googleapis.com/projects/{project_number}/locations/gl
      obal/workloadIdentityPools/{pool_id}/*`: All identities in a workload
      identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An email
      address (plus unique identifier) representing a user that has been
      recently deleted. For example,
      `alice@example.com?uid=123456789012345678901`. If the user is recovered,
      this value reverts to `user:{emailid}` and the recovered user retains
      the role in the binding. *
      `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
      (plus unique identifier) representing a service account that has been
      recently deleted. For example, `my-other-
      app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the
      service account is undeleted, this value reverts to
      `serviceAccount:{emailid}` and the undeleted service account retains the
      role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An
      email address (plus unique identifier) representing a Google group that
      has been recently deleted. For example,
      `admins@example.com?uid=123456789012345678901`. If the group is
      recovered, this value reverts to `group:{emailid}` and the recovered
      group retains the role in the binding. * `deleted:principal://iam.google
      apis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attr
      ibute_value}`: Deleted single identity in a workforce identity pool. For
      example, `deleted:principal://iam.googleapis.com/locations/global/workfo
      rcePools/my-pool-id/subject/my-subject-attribute-value`.
    role: Role that is assigned to the list of `members`, or principals. For
      example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
      overview of the IAM roles and permissions, see the [IAM
      documentation](https://cloud.google.com/iam/docs/roles-overview). For a
      list of the available pre-defined roles, see
      [here](https://cloud.google.com/iam/docs/understanding-roles).
  """

  condition = _messages.MessageField('Expr', 1)
  members = _messages.StringField(2, repeated=True)
  role = _messages.StringField(3)


class BufferTaskRequest(_messages.Message):
  r"""Request message for BufferTask.

  Fields:
    body: Optional. Body of the HTTP request. The body can take any generic
      value. The value is written to the HttpRequest of the [Task].
  """

  body = _messages.MessageField('HttpBody', 1)


class BufferTaskResponse(_messages.Message):
  r"""Response message for BufferTask.

  Fields:
    task: The created task.
  """

  task = _messages.MessageField('Task', 1)


class CloudtasksProjectsLocationsGetCmekConfigRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsGetCmekConfigRequest object.

  Fields:
    name: Required. The config. For example:
      projects/PROJECT_ID/locations/LOCATION_ID/CmekConfig`
  """

  name = _messages.StringField(1, required=True)


class CloudtasksProjectsLocationsGetRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsGetRequest object.

  Fields:
    name: Resource name for the location.
  """

  name = _messages.StringField(1, required=True)


class CloudtasksProjectsLocationsListRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsListRequest object.

  Fields:
    extraLocationTypes: Optional. A list of extra location types that should
      be used as conditions for controlling the visibility of the locations.
    filter: A filter to narrow down results to a preferred subset. The
      filtering language accepts strings like `"displayName=tokyo"`, and is
      documented in more detail in [AIP-160](https://google.aip.dev/160).
    name: The resource that owns the locations collection, if applicable.
    pageSize: The maximum number of results to return. If not set, the service
      selects a default.
    pageToken: A page token received from the `next_page_token` field in the
      response. Send that page token to receive the subsequent page.
  """

  extraLocationTypes = _messages.StringField(1, repeated=True)
  filter = _messages.StringField(2)
  name = _messages.StringField(3, required=True)
  pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(5)


class CloudtasksProjectsLocationsQueuesCreateRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesCreateRequest object.

  Fields:
    parent: Required. The location name in which the queue will be created.
      For example: `projects/PROJECT_ID/locations/LOCATION_ID` The list of
      allowed locations can be obtained by calling Cloud Tasks' implementation
      of ListLocations.
    queue: A Queue resource to be passed as the request body.
  """

  parent = _messages.StringField(1, required=True)
  queue = _messages.MessageField('Queue', 2)


class CloudtasksProjectsLocationsQueuesDeleteRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesDeleteRequest object.

  Fields:
    name: Required. The queue name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
  """

  name = _messages.StringField(1, required=True)


class CloudtasksProjectsLocationsQueuesGetIamPolicyRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesGetIamPolicyRequest object.

  Fields:
    getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
      request body.
    resource: REQUIRED: The resource for which the policy is being requested.
      See [Resource
      names](https://cloud.google.com/apis/design/resource_names) for the
      appropriate value for this field.
  """

  getIamPolicyRequest = _messages.MessageField('GetIamPolicyRequest', 1)
  resource = _messages.StringField(2, required=True)


class CloudtasksProjectsLocationsQueuesGetRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesGetRequest object.

  Fields:
    name: Required. The resource name of the queue. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
  """

  name = _messages.StringField(1, required=True)


class CloudtasksProjectsLocationsQueuesListRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesListRequest object.

  Fields:
    filter: `filter` can be used to specify a subset of queues. Any 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". Note that using filters might cause fewer
      queues than the requested page_size to be returned.
    pageSize: Requested page size. 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 in the response to determine if more queues exist.
    pageToken: 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
      returned from the previous call to ListQueues method. It is an error to
      switch the value of the filter while iterating through pages.
    parent: Required. The location name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID`
  """

  filter = _messages.StringField(1)
  pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(3)
  parent = _messages.StringField(4, required=True)


class CloudtasksProjectsLocationsQueuesPatchRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesPatchRequest object.

  Fields:
    name: Caller-specified and required in CreateQueue, after which it becomes
      output only. The queue name. The queue name must have the following
      format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` *
      `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) * `LOCATION_ID` is the canonical
      ID for the queue's location. The list of available locations can be
      obtained by calling ListLocations. For more information, see
      https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain
      letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length
      is 100 characters.
    queue: A Queue resource to be passed as the request body.
    updateMask: A mask used to specify which fields of the queue are being
      updated. If empty, then all fields will be updated.
  """

  name = _messages.StringField(1, required=True)
  queue = _messages.MessageField('Queue', 2)
  updateMask = _messages.StringField(3)


class CloudtasksProjectsLocationsQueuesPauseRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesPauseRequest object.

  Fields:
    name: Required. The queue name. For example:
      `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
    pauseQueueRequest: A PauseQueueRequest resource to be passed as the
      request body.
  """

  name = _messages.StringField(1, required=True)
  pauseQueueRequest = _messages.MessageField('PauseQueueRequest', 2)


class CloudtasksProjectsLocationsQueuesPurgeRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesPurgeRequest object.

  Fields:
    name: Required. The queue name. For example:
      `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
    purgeQueueRequest: A PurgeQueueRequest resource to be passed as the
      request body.
  """

  name = _messages.StringField(1, required=True)
  purgeQueueRequest = _messages.MessageField('PurgeQueueRequest', 2)


class CloudtasksProjectsLocationsQueuesResumeRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesResumeRequest object.

  Fields:
    name: Required. The queue name. For example:
      `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
    resumeQueueRequest: A ResumeQueueRequest resource to be passed as the
      request body.
  """

  name = _messages.StringField(1, required=True)
  resumeQueueRequest = _messages.MessageField('ResumeQueueRequest', 2)


class CloudtasksProjectsLocationsQueuesSetIamPolicyRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesSetIamPolicyRequest object.

  Fields:
    resource: REQUIRED: The resource for which the policy is being specified.
      See [Resource
      names](https://cloud.google.com/apis/design/resource_names) for the
      appropriate value for this field.
    setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
      request body.
  """

  resource = _messages.StringField(1, required=True)
  setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2)


class CloudtasksProjectsLocationsQueuesTasksBufferRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksBufferRequest object.

  Fields:
    bufferTaskRequest: A BufferTaskRequest resource to be passed as the
      request body.
    queue: Required. The parent queue name. For example:
      projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue
      must already exist.
    taskId: Optional. Task ID for the task being created. If not provided,
      Cloud Tasks generates an ID for the task.
  """

  bufferTaskRequest = _messages.MessageField('BufferTaskRequest', 1)
  queue = _messages.StringField(2, required=True)
  taskId = _messages.StringField(3, required=True)


class CloudtasksProjectsLocationsQueuesTasksCreateRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksCreateRequest object.

  Fields:
    createTaskRequest: A CreateTaskRequest resource to be passed as the
      request body.
    parent: Required. The queue name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` The queue
      must already exist.
  """

  createTaskRequest = _messages.MessageField('CreateTaskRequest', 1)
  parent = _messages.StringField(2, required=True)


class CloudtasksProjectsLocationsQueuesTasksDeleteRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksDeleteRequest object.

  Fields:
    name: Required. The task name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
      `
  """

  name = _messages.StringField(1, required=True)


class CloudtasksProjectsLocationsQueuesTasksGetRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksGetRequest object.

  Enums:
    ResponseViewValueValuesEnum: The response_view specifies which subset of
      the Task will be returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.

  Fields:
    name: Required. The task name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
      `
    responseView: The response_view specifies which subset of the Task will be
      returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.
  """

  class ResponseViewValueValuesEnum(_messages.Enum):
    r"""The response_view specifies which subset of the Task will be returned.
    By default response_view is 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 requires
    `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    permission on the Task resource.

    Values:
      VIEW_UNSPECIFIED: Unspecified. Defaults to BASIC.
      BASIC: The basic view omits fields which can be large or can contain
        sensitive data. This view does not include the body in
        AppEngineHttpRequest. 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.
      FULL: All information is returned. Authorization for FULL requires
        `cloudtasks.tasks.fullView` [Google
        IAM](https://cloud.google.com/iam/) permission on the Queue resource.
    """
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

  name = _messages.StringField(1, required=True)
  responseView = _messages.EnumField('ResponseViewValueValuesEnum', 2)


class CloudtasksProjectsLocationsQueuesTasksListRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksListRequest object.

  Enums:
    ResponseViewValueValuesEnum: The response_view specifies which subset of
      the Task will be returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.

  Fields:
    pageSize: Maximum page size. Fewer tasks than requested might be returned,
      even if more tasks exist; use next_page_token in the response to
      determine if more tasks exist. The maximum page size is 1000. If
      unspecified, the page size will be the maximum.
    pageToken: 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
      returned from the previous call to ListTasks method. The page token is
      valid for only 2 hours.
    parent: Required. The queue name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
    responseView: The response_view specifies which subset of the Task will be
      returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.
  """

  class ResponseViewValueValuesEnum(_messages.Enum):
    r"""The response_view specifies which subset of the Task will be returned.
    By default response_view is 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 requires
    `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    permission on the Task resource.

    Values:
      VIEW_UNSPECIFIED: Unspecified. Defaults to BASIC.
      BASIC: The basic view omits fields which can be large or can contain
        sensitive data. This view does not include the body in
        AppEngineHttpRequest. 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.
      FULL: All information is returned. Authorization for FULL requires
        `cloudtasks.tasks.fullView` [Google
        IAM](https://cloud.google.com/iam/) permission on the Queue resource.
    """
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)
  responseView = _messages.EnumField('ResponseViewValueValuesEnum', 4)


class CloudtasksProjectsLocationsQueuesTasksRunRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTasksRunRequest object.

  Fields:
    name: Required. The task name. For example:
      `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID
      `
    runTaskRequest: A RunTaskRequest resource to be passed as the request
      body.
  """

  name = _messages.StringField(1, required=True)
  runTaskRequest = _messages.MessageField('RunTaskRequest', 2)


class CloudtasksProjectsLocationsQueuesTestIamPermissionsRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsQueuesTestIamPermissionsRequest object.

  Fields:
    resource: REQUIRED: The resource for which the policy detail is being
      requested. See [Resource
      names](https://cloud.google.com/apis/design/resource_names) for the
      appropriate value for this field.
    testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
      passed as the request body.
  """

  resource = _messages.StringField(1, required=True)
  testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2)


class CloudtasksProjectsLocationsUpdateCmekConfigRequest(_messages.Message):
  r"""A CloudtasksProjectsLocationsUpdateCmekConfigRequest object.

  Fields:
    cmekConfig: A CmekConfig resource to be passed as the request body.
    name: Output only. The config resource name which includes the project and
      location and must end in 'cmekConfig', in the format
      projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
    updateMask: List of fields to be updated in this request.
  """

  cmekConfig = _messages.MessageField('CmekConfig', 1)
  name = _messages.StringField(2, required=True)
  updateMask = _messages.StringField(3)


class CmekConfig(_messages.Message):
  r"""Describes the customer-managed encryption key (CMEK) configuration
  associated with a project and location.

  Fields:
    kmsKey: Resource name of the Cloud KMS key, of the form `projects/PROJECT_
      ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that
      will be used to encrypt the Queues & Tasks in the region. Setting this
      as blank will turn off CMEK encryption.
    name: Output only. The config resource name which includes the project and
      location and must end in 'cmekConfig', in the format
      projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`
  """

  kmsKey = _messages.StringField(1)
  name = _messages.StringField(2)


class CreateTaskRequest(_messages.Message):
  r"""Request message for CreateTask.

  Enums:
    ResponseViewValueValuesEnum: The response_view specifies which subset of
      the Task will be returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.

  Fields:
    responseView: The response_view specifies which subset of the Task will be
      returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.
    task: Required. The task to add. 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. 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. If schedule_time is
      not set or is in the past then Cloud Tasks will set it to the current
      time. Task De-duplication: Explicitly specifying a task ID enables task
      de-duplication. If a task's ID is identical to that of an existing task
      or a task that was deleted or executed recently then the call will fail
      with ALREADY_EXISTS. The IDs of deleted tasks are not immediately
      available for reuse. It can take up to 4 hours (or 9 days if the task's
      queue was created using a queue.yaml or queue.xml) for the task ID to be
      released and made available again. Because there is an extra lookup cost
      to identify duplicate task names, these 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.
  """

  class ResponseViewValueValuesEnum(_messages.Enum):
    r"""The response_view specifies which subset of the Task will be returned.
    By default response_view is 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 requires
    `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    permission on the Task resource.

    Values:
      VIEW_UNSPECIFIED: Unspecified. Defaults to BASIC.
      BASIC: The basic view omits fields which can be large or can contain
        sensitive data. This view does not include the body in
        AppEngineHttpRequest. 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.
      FULL: All information is returned. Authorization for FULL requires
        `cloudtasks.tasks.fullView` [Google
        IAM](https://cloud.google.com/iam/) permission on the Queue resource.
    """
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

  responseView = _messages.EnumField('ResponseViewValueValuesEnum', 1)
  task = _messages.MessageField('Task', 2)


class Empty(_messages.Message):
  r"""A generic empty message that you can re-use to avoid defining duplicated
  empty messages in your APIs. A typical example is to use it as the request
  or the response type of an API method. For instance: service Foo { rpc
  Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
  """



class Expr(_messages.Message):
  r"""Represents a textual expression in the Common Expression Language (CEL)
  syntax. CEL is a C-like expression language. The syntax and semantics of CEL
  are documented at https://github.com/google/cel-spec. Example (Comparison):
  title: "Summary size limit" description: "Determines if a summary is less
  than 100 chars" expression: "document.summary.size() < 100" Example
  (Equality): title: "Requestor is owner" description: "Determines if
  requestor is the document owner" expression: "document.owner ==
  request.auth.claims.email" Example (Logic): title: "Public documents"
  description: "Determine whether the document should be publicly visible"
  expression: "document.type != 'private' && document.type != 'internal'"
  Example (Data Manipulation): title: "Notification string" description:
  "Create a notification string with a timestamp." expression: "'New message
  received at ' + string(document.create_time)" The exact variables and
  functions that may be referenced within an expression are determined by the
  service that evaluates it. See the service documentation for additional
  information.

  Fields:
    description: Optional. Description of the expression. This is a longer
      text which describes the expression, e.g. when hovered over it in a UI.
    expression: Textual representation of an expression in Common Expression
      Language syntax.
    location: Optional. String indicating the location of the expression for
      error reporting, e.g. a file name and a position in the file.
    title: Optional. Title for the expression, i.e. a short string describing
      its purpose. This can be used e.g. in UIs which allow to enter the
      expression.
  """

  description = _messages.StringField(1)
  expression = _messages.StringField(2)
  location = _messages.StringField(3)
  title = _messages.StringField(4)


class GetIamPolicyRequest(_messages.Message):
  r"""Request message for `GetIamPolicy` method.

  Fields:
    options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
      `GetIamPolicy`.
  """

  options = _messages.MessageField('GetPolicyOptions', 1)


class GetPolicyOptions(_messages.Message):
  r"""Encapsulates settings provided to GetIamPolicy.

  Fields:
    requestedPolicyVersion: Optional. The maximum policy version that will be
      used to format the policy. Valid values are 0, 1, and 3. Requests
      specifying an invalid value will be rejected. Requests for policies with
      any conditional role bindings must specify version 3. Policies with no
      conditional role bindings may specify any valid value or leave the field
      unset. The policy in the response might use the policy version that you
      specified, or it might use a lower policy version. For example, if you
      specify version 3, but the policy has no conditional role bindings, the
      response uses version 1. To learn which resources support conditions in
      their IAM policies, see the [IAM
      documentation](https://cloud.google.com/iam/help/conditions/resource-
      policies).
  """

  requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32)


class Header(_messages.Message):
  r"""Defines a header message. A header can have a key and a value.

  Fields:
    key: The Key of the header.
    value: The Value of the header.
  """

  key = _messages.StringField(1)
  value = _messages.StringField(2)


class HeaderOverride(_messages.Message):
  r"""Wraps the Header object.

  Fields:
    header: Header embodying a key and a value. Do not put business sensitive
      or personally identifying data in the HTTP Header Override Configuration
      or other similar fields in accordance with Section 12 (Resource Fields)
      of the [Service Specific Terms](https://cloud.google.com/terms/service-
      terms).
  """

  header = _messages.MessageField('Header', 1)


class HttpBody(_messages.Message):
  r"""Message that represents an arbitrary HTTP body. It should only be used
  for payload formats that can't be represented as JSON, such as raw binary or
  an HTML page. This message can be used both in streaming and non-streaming
  API methods in the request as well as the response. It can be used as a top-
  level request field, which is convenient if one wants to extract parameters
  from either the URL or HTTP template into the request fields and also want
  access to the raw HTTP body. Example: message GetResourceRequest { // A
  unique request id. string request_id = 1; // The raw HTTP body is bound to
  this field. google.api.HttpBody http_body = 2; } service ResourceService {
  rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc
  UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); }
  Example with streaming methods: service CaldavService { rpc
  GetCalendar(stream google.api.HttpBody) returns (stream
  google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns
  (stream google.api.HttpBody); } Use of this type only changes how the
  request and response bodies are handled, all other features will continue to
  work unchanged.

  Messages:
    ExtensionsValueListEntry: A ExtensionsValueListEntry object.

  Fields:
    contentType: The HTTP Content-Type header value specifying the content
      type of the body.
    data: The HTTP request/response body as raw binary.
    extensions: Application specific response metadata. Must be set in the
      first response for streaming APIs.
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class ExtensionsValueListEntry(_messages.Message):
    r"""A ExtensionsValueListEntry object.

    Messages:
      AdditionalProperty: An additional property for a
        ExtensionsValueListEntry object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a ExtensionsValueListEntry object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  contentType = _messages.StringField(1)
  data = _messages.BytesField(2)
  extensions = _messages.MessageField('ExtensionsValueListEntry', 3, repeated=True)


class HttpRequest(_messages.Message):
  r"""HTTP request. The task will be pushed to the worker as an HTTP request.
  If the worker or the redirected worker acknowledges the task by returning a
  successful HTTP response code ([`200` - `299`]), the task will be removed
  from the queue. If any other HTTP response code is returned or no response
  is received, the task will be retried according to the following: * User-
  specified throttling: retry configuration, rate limits, and the queue's
  state. * System throttling: To prevent the worker from overloading, Cloud
  Tasks may temporarily reduce the queue's effective rate. User-specified
  settings will not be changed. System throttling happens because: * Cloud
  Tasks backs off on all errors. Normally the backoff specified in rate limits
  will be used. But if the worker returns `429` (Too Many Requests), `503`
  (Service Unavailable), or the rate of errors is high, Cloud Tasks will use a
  higher backoff rate. The retry specified in the `Retry-After` HTTP response
  header is considered. * To prevent traffic spikes and to smooth sudden
  increases in traffic, dispatches ramp up slowly when the queue is newly
  created or idle and if large numbers of tasks suddenly become available to
  dispatch (due to spikes in create task rates, the queue being unpaused, or
  many tasks that are scheduled at the same time).

  Enums:
    HttpMethodValueValuesEnum: The HTTP method to use for the request. The
      default is POST.

  Messages:
    HeadersValue: HTTP request headers. This map contains the header field
      names and values. Headers can be set when the task is created. These
      headers represent a subset of the headers that will accompany the task's
      HTTP request. Some HTTP request headers will be ignored or replaced. A
      partial list of headers that will be ignored or replaced is: * Host:
      This will be computed by Cloud Tasks and derived from HttpRequest.url. *
      Content-Length: This will be computed by Cloud Tasks. * User-Agent: This
      will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only.
      * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud
      Tasks. You can explicitly set `Content-Type` to a media type when the
      task is created. For example, `Content-Type` can be set to
      `"application/octet-stream"` or `"application/json"`. Headers which can
      have multiple values (according to RFC2616) can be specified using
      comma-separated values. The size of the headers must be less than 80KB.

  Fields:
    body: HTTP request body. A request body is allowed only if the HTTP method
      is POST, PUT, or PATCH. It is an error to set body on a task with an
      incompatible HttpMethod.
    headers: HTTP request headers. This map contains the header field names
      and values. Headers can be set when the task is created. These headers
      represent a subset of the headers that will accompany the task's HTTP
      request. Some HTTP request headers will be ignored or replaced. A
      partial list of headers that will be ignored or replaced is: * Host:
      This will be computed by Cloud Tasks and derived from HttpRequest.url. *
      Content-Length: This will be computed by Cloud Tasks. * User-Agent: This
      will be set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only.
      * `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud
      Tasks. You can explicitly set `Content-Type` to a media type when the
      task is created. For example, `Content-Type` can be set to
      `"application/octet-stream"` or `"application/json"`. Headers which can
      have multiple values (according to RFC2616) can be specified using
      comma-separated values. The size of the headers must be less than 80KB.
    httpMethod: The HTTP method to use for the request. The default is POST.
    oauthToken: If specified, an [OAuth
      token](https://developers.google.com/identity/protocols/OAuth2) will be
      generated and attached as an `Authorization` header in the HTTP request.
      This type of authorization should generally only be used when calling
      Google APIs hosted on *.googleapis.com.
    oidcToken: If specified, an
      [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
      token will be generated and attached as an `Authorization` header in the
      HTTP request. This type of authorization can be used for many scenarios,
      including calling Cloud Run, or endpoints where you intend to validate
      the token yourself.
    url: Required. The full url path that the request will be sent to. This
      string must begin with either "http://" or "https://". Some examples
      are: `http://acme.com` and `https://acme.com/sales:8080`. Cloud Tasks
      will encode some characters for safety and compatibility. The maximum
      allowed URL length is 2083 characters after encoding. The `Location`
      header response from a redirect response [`300` - `399`] may be
      followed. The redirect is not counted as a separate attempt.
  """

  class HttpMethodValueValuesEnum(_messages.Enum):
    r"""The HTTP method to use for the request. The default is POST.

    Values:
      HTTP_METHOD_UNSPECIFIED: HTTP method unspecified
      POST: HTTP POST
      GET: HTTP GET
      HEAD: HTTP HEAD
      PUT: HTTP PUT
      DELETE: HTTP DELETE
      PATCH: HTTP PATCH
      OPTIONS: HTTP OPTIONS
    """
    HTTP_METHOD_UNSPECIFIED = 0
    POST = 1
    GET = 2
    HEAD = 3
    PUT = 4
    DELETE = 5
    PATCH = 6
    OPTIONS = 7

  @encoding.MapUnrecognizedFields('additionalProperties')
  class HeadersValue(_messages.Message):
    r"""HTTP request headers. This map contains the header field names and
    values. Headers can be set when the task is created. These headers
    represent a subset of the headers that will accompany the task's HTTP
    request. Some HTTP request headers will be ignored or replaced. A partial
    list of headers that will be ignored or replaced is: * Host: This will be
    computed by Cloud Tasks and derived from HttpRequest.url. * Content-
    Length: This will be computed by Cloud Tasks. * User-Agent: This will be
    set to `"Google-Cloud-Tasks"`. * `X-Google-*`: Google use only. *
    `X-AppEngine-*`: Google use only. `Content-Type` won't be set by Cloud
    Tasks. You can explicitly set `Content-Type` to a media type when the task
    is created. For example, `Content-Type` can be set to `"application/octet-
    stream"` or `"application/json"`. Headers which can have multiple values
    (according to RFC2616) can be specified using comma-separated values. The
    size of the headers must be less than 80KB.

    Messages:
      AdditionalProperty: An additional property for a HeadersValue object.

    Fields:
      additionalProperties: Additional properties of type HeadersValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a HeadersValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  body = _messages.BytesField(1)
  headers = _messages.MessageField('HeadersValue', 2)
  httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 3)
  oauthToken = _messages.MessageField('OAuthToken', 4)
  oidcToken = _messages.MessageField('OidcToken', 5)
  url = _messages.StringField(6)


class HttpTarget(_messages.Message):
  r"""HTTP target. When specified as a Queue, all the tasks with [HttpRequest]
  will be overridden according to the target.

  Enums:
    HttpMethodValueValuesEnum: The HTTP method to use for the request. When
      specified, it overrides HttpRequest for the task. Note that if the value
      is set to HttpMethod the HttpRequest of the task will be ignored at
      execution time.

  Fields:
    headerOverrides: HTTP target headers. This map contains the header field
      names and values. Headers will be set when running the CreateTask and/or
      BufferTask. These headers represent a subset of the headers that will be
      configured for the task's HTTP request. Some HTTP request headers will
      be ignored or replaced. A partial list of headers that will be ignored
      or replaced is: * Several predefined headers, prefixed with
      "X-CloudTasks-", can be used to define properties of the task. * Host:
      This will be computed by Cloud Tasks and derived from HttpRequest.url. *
      Content-Length: This will be computed by Cloud Tasks. `Content-Type`
      won't be set by Cloud Tasks. You can explicitly set `Content-Type` to a
      media type when the task is created. For example,`Content-Type` can be
      set to `"application/octet-stream"` or `"application/json"`. The default
      value is set to "application/json"`. * User-Agent: This will be set to
      `"Google-Cloud-Tasks"`. Headers which can have multiple values
      (according to RFC2616) can be specified using comma-separated values.
      The size of the headers must be less than 80KB. Queue-level headers to
      override headers of all the tasks in the queue. Do not put business
      sensitive or personally identifying data in the HTTP Header Override
      Configuration or other similar fields in accordance with Section 12
      (Resource Fields) of the [Service Specific
      Terms](https://cloud.google.com/terms/service-terms).
    httpMethod: The HTTP method to use for the request. When specified, it
      overrides HttpRequest for the task. Note that if the value is set to
      HttpMethod the HttpRequest of the task will be ignored at execution
      time.
    oauthToken: If specified, an [OAuth
      token](https://developers.google.com/identity/protocols/OAuth2) is
      generated and attached as the `Authorization` header in the HTTP
      request. This type of authorization should generally be used only when
      calling Google APIs hosted on *.googleapis.com. Note that both the
      service account email and the scope MUST be specified when using the
      queue-level authorization override.
    oidcToken: If specified, an
      [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect)
      token is generated and attached as an `Authorization` header in the HTTP
      request. This type of authorization can be used for many scenarios,
      including calling Cloud Run, or endpoints where you intend to validate
      the token yourself. Note that both the service account email and the
      audience MUST be specified when using the queue-level authorization
      override.
    uriOverride: URI override. When specified, overrides the execution URI for
      all the tasks in the queue.
  """

  class HttpMethodValueValuesEnum(_messages.Enum):
    r"""The HTTP method to use for the request. When specified, it overrides
    HttpRequest for the task. Note that if the value is set to HttpMethod the
    HttpRequest of the task will be ignored at execution time.

    Values:
      HTTP_METHOD_UNSPECIFIED: HTTP method unspecified
      POST: HTTP POST
      GET: HTTP GET
      HEAD: HTTP HEAD
      PUT: HTTP PUT
      DELETE: HTTP DELETE
      PATCH: HTTP PATCH
      OPTIONS: HTTP OPTIONS
    """
    HTTP_METHOD_UNSPECIFIED = 0
    POST = 1
    GET = 2
    HEAD = 3
    PUT = 4
    DELETE = 5
    PATCH = 6
    OPTIONS = 7

  headerOverrides = _messages.MessageField('HeaderOverride', 1, repeated=True)
  httpMethod = _messages.EnumField('HttpMethodValueValuesEnum', 2)
  oauthToken = _messages.MessageField('OAuthToken', 3)
  oidcToken = _messages.MessageField('OidcToken', 4)
  uriOverride = _messages.MessageField('UriOverride', 5)


class ListLocationsResponse(_messages.Message):
  r"""The response message for Locations.ListLocations.

  Fields:
    locations: A list of locations that matches the specified filter in the
      request.
    nextPageToken: The standard List next-page token.
  """

  locations = _messages.MessageField('Location', 1, repeated=True)
  nextPageToken = _messages.StringField(2)


class ListQueuesResponse(_messages.Message):
  r"""Response message for ListQueues.

  Fields:
    nextPageToken: A token to retrieve next page of results. To return the
      next page of results, call ListQueues with this value as the page_token.
      If the next_page_token is empty, there are no more results. The page
      token is valid for only 2 hours.
    queues: The list of queues.
  """

  nextPageToken = _messages.StringField(1)
  queues = _messages.MessageField('Queue', 2, repeated=True)


class ListTasksResponse(_messages.Message):
  r"""Response message for listing tasks using ListTasks.

  Fields:
    nextPageToken: A token to retrieve next page of results. To return the
      next page of results, call ListTasks with this value as the page_token.
      If the next_page_token is empty, there are no more results.
    tasks: The list of tasks.
  """

  nextPageToken = _messages.StringField(1)
  tasks = _messages.MessageField('Task', 2, repeated=True)


class Location(_messages.Message):
  r"""A resource that represents a Google Cloud location.

  Messages:
    LabelsValue: Cross-service attributes for the location. For example
      {"cloud.googleapis.com/region": "us-east1"}
    MetadataValue: Service-specific metadata. For example the available
      capacity at the given location.

  Fields:
    displayName: The friendly name for this location, typically a nearby city
      name. For example, "Tokyo".
    labels: Cross-service attributes for the location. For example
      {"cloud.googleapis.com/region": "us-east1"}
    locationId: The canonical id for this location. For example: `"us-east1"`.
    metadata: Service-specific metadata. For example the available capacity at
      the given location.
    name: Resource name for the location, which may vary between
      implementations. For example: `"projects/example-project/locations/us-
      east1"`
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class LabelsValue(_messages.Message):
    r"""Cross-service attributes for the location. For example
    {"cloud.googleapis.com/region": "us-east1"}

    Messages:
      AdditionalProperty: An additional property for a LabelsValue object.

    Fields:
      additionalProperties: Additional properties of type LabelsValue
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a LabelsValue object.

      Fields:
        key: Name of the additional property.
        value: A string attribute.
      """

      key = _messages.StringField(1)
      value = _messages.StringField(2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  @encoding.MapUnrecognizedFields('additionalProperties')
  class MetadataValue(_messages.Message):
    r"""Service-specific metadata. For example the available capacity at the
    given location.

    Messages:
      AdditionalProperty: An additional property for a MetadataValue object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a MetadataValue object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  displayName = _messages.StringField(1)
  labels = _messages.MessageField('LabelsValue', 2)
  locationId = _messages.StringField(3)
  metadata = _messages.MessageField('MetadataValue', 4)
  name = _messages.StringField(5)


class OAuthToken(_messages.Message):
  r"""Contains information needed for generating an [OAuth
  token](https://developers.google.com/identity/protocols/OAuth2). This type
  of authorization should generally only be used when calling Google APIs
  hosted on *.googleapis.com.

  Fields:
    scope: OAuth scope to be used for generating OAuth access token. If not
      specified, "https://www.googleapis.com/auth/cloud-platform" will be
      used.
    serviceAccountEmail: [Service account
      email](https://cloud.google.com/iam/docs/service-accounts) to be used
      for generating OAuth token. The service account must be within the same
      project as the queue. The caller must have iam.serviceAccounts.actAs
      permission for the service account.
  """

  scope = _messages.StringField(1)
  serviceAccountEmail = _messages.StringField(2)


class OidcToken(_messages.Message):
  r"""Contains information needed for generating an [OpenID Connect
  token](https://developers.google.com/identity/protocols/OpenIDConnect). This
  type of authorization can be used for many scenarios, including calling
  Cloud Run, or endpoints where you intend to validate the token yourself.

  Fields:
    audience: Audience to be used when generating OIDC token. If not
      specified, the URI specified in target will be used.
    serviceAccountEmail: [Service account
      email](https://cloud.google.com/iam/docs/service-accounts) to be used
      for generating OIDC token. The service account must be within the same
      project as the queue. The caller must have iam.serviceAccounts.actAs
      permission for the service account.
  """

  audience = _messages.StringField(1)
  serviceAccountEmail = _messages.StringField(2)


class PathOverride(_messages.Message):
  r"""PathOverride. Path message defines path override for HTTP targets.

  Fields:
    path: The URI path (e.g., /users/1234). Default is an empty string.
  """

  path = _messages.StringField(1)


class PauseQueueRequest(_messages.Message):
  r"""Request message for PauseQueue."""


class Policy(_messages.Message):
  r"""An Identity and Access Management (IAM) policy, which specifies access
  controls for Google Cloud resources. A `Policy` is a collection of
  `bindings`. A `binding` binds one or more `members`, or principals, to a
  single `role`. Principals can be user accounts, service accounts, Google
  groups, and domains (such as G Suite). A `role` is a named list of
  permissions; each `role` can be an IAM predefined role or a user-created
  custom role. For some types of Google Cloud resources, a `binding` can also
  specify a `condition`, which is a logical expression that allows access to a
  resource only if the expression evaluates to `true`. A condition can add
  constraints based on attributes of the request, the resource, or both. To
  learn which resources support conditions in their IAM policies, see the [IAM
  documentation](https://cloud.google.com/iam/help/conditions/resource-
  policies). **JSON example:** ``` { "bindings": [ { "role":
  "roles/resourcemanager.organizationAdmin", "members": [
  "user:mike@example.com", "group:admins@example.com", "domain:google.com",
  "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role":
  "roles/resourcemanager.organizationViewer", "members": [
  "user:eve@example.com" ], "condition": { "title": "expirable access",
  "description": "Does not grant access after Sep 2020", "expression":
  "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag":
  "BwWWja0YfJA=", "version": 3 } ``` **YAML example:** ``` bindings: -
  members: - user:mike@example.com - group:admins@example.com -
  domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
  role: roles/resourcemanager.organizationAdmin - members: -
  user:eve@example.com role: roles/resourcemanager.organizationViewer
  condition: title: expirable access description: Does not grant access after
  Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
  etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features,
  see the [IAM documentation](https://cloud.google.com/iam/docs/).

  Fields:
    bindings: Associates a list of `members`, or principals, with a `role`.
      Optionally, may specify a `condition` that determines how and when the
      `bindings` are applied. Each of the `bindings` must contain at least one
      principal. The `bindings` in a `Policy` can refer to up to 1,500
      principals; up to 250 of these principals can be Google groups. Each
      occurrence of a principal counts towards these limits. For example, if
      the `bindings` grant 50 different roles to `user:alice@example.com`, and
      not to any other principal, then you can add another 1,450 principals to
      the `bindings` in the `Policy`.
    etag: `etag` is used for optimistic concurrency control as a way to help
      prevent simultaneous updates of a policy from overwriting each other. It
      is strongly suggested that systems make use of the `etag` in the read-
      modify-write cycle to perform policy updates in order to avoid race
      conditions: An `etag` is returned in the response to `getIamPolicy`, and
      systems are expected to put that etag in the request to `setIamPolicy`
      to ensure that their change will be applied to the same version of the
      policy. **Important:** If you use IAM Conditions, you must include the
      `etag` field whenever you call `setIamPolicy`. If you omit this field,
      then IAM allows you to overwrite a version `3` policy with a version `1`
      policy, and all of the conditions in the version `3` policy are lost.
    version: Specifies the format of the policy. Valid values are `0`, `1`,
      and `3`. Requests that specify an invalid value are rejected. Any
      operation that affects conditional role bindings must specify version
      `3`. This requirement applies to the following operations: * Getting a
      policy that includes a conditional role binding * Adding a conditional
      role binding to a policy * Changing a conditional role binding in a
      policy * Removing any role binding, with or without a condition, from a
      policy that includes conditions **Important:** If you use IAM
      Conditions, you must include the `etag` field whenever you call
      `setIamPolicy`. If you omit this field, then IAM allows you to overwrite
      a version `3` policy with a version `1` policy, and all of the
      conditions in the version `3` policy are lost. If a policy does not
      include any conditions, operations on that policy may specify any valid
      version or leave the field unset. To learn which resources support
      conditions in their IAM policies, see the [IAM
      documentation](https://cloud.google.com/iam/help/conditions/resource-
      policies).
  """

  bindings = _messages.MessageField('Binding', 1, repeated=True)
  etag = _messages.BytesField(2)
  version = _messages.IntegerField(3, variant=_messages.Variant.INT32)


class PurgeQueueRequest(_messages.Message):
  r"""Request message for PurgeQueue."""


class QueryOverride(_messages.Message):
  r"""QueryOverride. Query message defines query override for HTTP targets.

  Fields:
    queryParams: The query parameters (e.g., qparam1=123&qparam2=456). Default
      is an empty string.
  """

  queryParams = _messages.StringField(1)


class Queue(_messages.Message):
  r"""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.

  Enums:
    StateValueValuesEnum: Output only. The state of the queue. `state` can
      only be changed by calling PauseQueue, ResumeQueue, or uploading [queue.
      yaml/xml](https://cloud.google.com/appengine/docs/python/config/queueref
      ). UpdateQueue cannot be used to change `state`.

  Fields:
    appEngineRoutingOverride: Overrides for task-level app_engine_routing.
      These settings apply only to App Engine tasks in this queue. Http tasks
      are not affected. If set, `app_engine_routing_override` is used for all
      App Engine tasks in the queue, no matter what the setting is for the
      task-level app_engine_routing.
    httpTarget: Modifies HTTP target for HTTP tasks.
    name: Caller-specified and required in CreateQueue, after which it becomes
      output only. The queue name. The queue name must have the following
      format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID` *
      `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) * `LOCATION_ID` is the canonical
      ID for the queue's location. The list of available locations can be
      obtained by calling ListLocations. For more information, see
      https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain
      letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length
      is 100 characters.
    purgeTime: Output only. The last time this queue was purged. All tasks
      that were created before this time were purged. A queue can be purged
      using PurgeQueue, the [App Engine Task Queue SDK, or the Cloud Console](
      https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/d
      eleting-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.
    rateLimits: Rate limits for task dispatches. rate_limits and retry_config
      are related because they both control task attempts. However they
      control task attempts in different ways: * 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 controls what happens to particular a task
      after its first attempt fails. That is, retry_config controls task
      retries (the second attempt, third attempt, etc). The queue's actual
      dispatch rate is the result of: * Number of tasks in the queue * User-
      specified throttling: rate_limits, retry_config, and the queue's state.
      * System throttling due to `429` (Too Many Requests) or `503` (Service
      Unavailable) responses from the worker, high error rates, or to smooth
      sudden large traffic spikes.
    retryConfig: Settings that determine the retry behavior. * For tasks
      created using Cloud Tasks: the queue-level retry settings apply to all
      tasks in the queue that were created using Cloud Tasks. Retry settings
      cannot be set on individual tasks. * 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/retryi
      ng-tasks).
    stackdriverLoggingConfig: Configuration options for writing logs to
      [Stackdriver Logging](https://cloud.google.com/logging/docs/). If this
      field is unset, then no logs are written.
    state: Output only. The state of the queue. `state` can only be changed by
      calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://c
      loud.google.com/appengine/docs/python/config/queueref). UpdateQueue
      cannot be used to change `state`.
  """

  class StateValueValuesEnum(_messages.Enum):
    r"""Output only. The state of the queue. `state` can only be changed by
    calling PauseQueue, ResumeQueue, or uploading [queue.yaml/xml](https://clo
    ud.google.com/appengine/docs/python/config/queueref). UpdateQueue cannot
    be used to change `state`.

    Values:
      STATE_UNSPECIFIED: Unspecified state.
      RUNNING: The queue is running. Tasks can be dispatched. If the queue was
        created using Cloud Tasks and the queue has had no activity (method
        calls or task dispatches) for 30 days, the queue may take a few
        minutes to re-activate. Some method calls may return NOT_FOUND and
        tasks may not be dispatched for a few minutes until the queue has been
        re-activated.
      PAUSED: 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.
      DISABLED: 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/c
        onfig/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. To
        permanently delete this queue and all of its tasks, call DeleteQueue.
    """
    STATE_UNSPECIFIED = 0
    RUNNING = 1
    PAUSED = 2
    DISABLED = 3

  appEngineRoutingOverride = _messages.MessageField('AppEngineRouting', 1)
  httpTarget = _messages.MessageField('HttpTarget', 2)
  name = _messages.StringField(3)
  purgeTime = _messages.StringField(4)
  rateLimits = _messages.MessageField('RateLimits', 5)
  retryConfig = _messages.MessageField('RetryConfig', 6)
  stackdriverLoggingConfig = _messages.MessageField('StackdriverLoggingConfig', 7)
  state = _messages.EnumField('StateValueValuesEnum', 8)


class RateLimits(_messages.Message):
  r"""Rate limits. 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, will run a task
  even if the queue has reached its RateLimits.

  Fields:
    maxBurstSize: Output only. The max burst size. Max burst size limits how
      fast tasks in queue are processed when many tasks are in the queue and
      the rate is high. This field allows the queue to have a high rate so
      processing starts shortly after a task is enqueued, but still limits
      resource usage when many tasks are enqueued in a short period of time.
      The [token bucket](https://wikipedia.org/wiki/Token_Bucket) algorithm is
      used to control the rate of task dispatches. Each queue has a token
      bucket that holds tokens, up to the maximum specified by
      `max_burst_size`. Each time a task is dispatched, a token is removed
      from the bucket. Tasks will be dispatched until the queue's bucket runs
      out of tokens. The bucket will be continuously refilled with new tokens
      based on max_dispatches_per_second. Cloud Tasks will pick the value of
      `max_burst_size` based on the value of max_dispatches_per_second. For
      queues that were created or updated using `queue.yaml/xml`,
      `max_burst_size` is equal to [bucket_size](https://cloud.google.com/appe
      ngine/docs/standard/python/config/queueref#bucket_size). Since
      `max_burst_size` is output only, if 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, regardless of whether
      max_dispatches_per_second is updated.
    maxConcurrentDispatches: The maximum number of concurrent tasks that Cloud
      Tasks allows to be dispatched for this queue. After this threshold has
      been reached, Cloud Tasks stops dispatching tasks until the number of
      concurrent requests decreases. If unspecified when the queue is created,
      Cloud Tasks will pick the default. The maximum allowed value is 5,000.
      This field has the same meaning as [max_concurrent_requests in queue.yam
      l/xml](https://cloud.google.com/appengine/docs/standard/python/config/qu
      eueref#max_concurrent_requests).
    maxDispatchesPerSecond: The maximum rate at which tasks are dispatched
      from this queue. If unspecified when the queue is created, Cloud Tasks
      will pick the default. * The maximum allowed value is 500. This field
      has the same meaning as [rate in queue.yaml/xml](https://cloud.google.co
      m/appengine/docs/standard/python/config/queueref#rate).
  """

  maxBurstSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  maxConcurrentDispatches = _messages.IntegerField(2, variant=_messages.Variant.INT32)
  maxDispatchesPerSecond = _messages.FloatField(3)


class ResumeQueueRequest(_messages.Message):
  r"""Request message for ResumeQueue."""


class RetryConfig(_messages.Message):
  r"""Retry config. These settings determine when a failed task attempt is
  retried.

  Fields:
    maxAttempts: Number of attempts per task. Cloud Tasks will attempt the
      task `max_attempts` times (that is, if the first attempt fails, then
      there will be `max_attempts - 1` retries). Must be >= -1. If unspecified
      when the queue is created, Cloud Tasks will pick the default. -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). Note: Cloud
      Tasks stops retrying only when `max_attempts` and `max_retry_duration`
      are both satisfied. When the task has been attempted `max_attempts`
      times and when the `max_retry_duration` time has passed, no further
      attempts are made, and the task is deleted. If you want your task to
      retry infinitely, you must set `max_attempts` to -1 and
      `max_retry_duration` to 0.
    maxBackoff: A task will be scheduled for retry between min_backoff and
      max_backoff duration after it fails, if the queue's RetryConfig
      specifies that the task should be retried. If unspecified when the queue
      is created, Cloud Tasks will pick the default. The value must be given
      as a string that indicates the length of time (in seconds) followed by
      `s` (for "seconds"). For more information on the format, see the
      documentation for [Duration](https://protobuf.dev/reference/protobuf/goo
      gle.protobuf/#duration). `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/confi
      g/queueref#retry_parameters).
    maxDoublings: The time between retries will double `max_doublings` times.
      A task's retry interval starts at min_backoff, then doubles
      `max_doublings` times, then increases linearly, and finally retries at
      intervals of max_backoff up to max_attempts times. For example, if
      min_backoff is 10s, 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 until the task has been attempted
      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/doc
      s/standard/python/config/queueref#retry_parameters).
    maxRetryDuration: 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 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. The value must be given as a string that indicates the length
      of time (in seconds) followed by `s` (for "seconds"). For the maximum
      possible value or the format, see the documentation for [Duration](https
      ://protobuf.dev/reference/protobuf/google.protobuf/#duration).
      `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_paramet
      ers).
    minBackoff: A task will be scheduled for retry between min_backoff and
      max_backoff duration after it fails, if the queue's RetryConfig
      specifies that the task should be retried. If unspecified when the queue
      is created, Cloud Tasks will pick the default. The value must be given
      as a string that indicates the length of time (in seconds) followed by
      `s` (for "seconds"). For more information on the format, see the
      documentation for [Duration](https://protobuf.dev/reference/protobuf/goo
      gle.protobuf/#duration). `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/confi
      g/queueref#retry_parameters).
  """

  maxAttempts = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  maxBackoff = _messages.StringField(2)
  maxDoublings = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  maxRetryDuration = _messages.StringField(4)
  minBackoff = _messages.StringField(5)


class RunTaskRequest(_messages.Message):
  r"""Request message for forcing a task to run now using RunTask.

  Enums:
    ResponseViewValueValuesEnum: The response_view specifies which subset of
      the Task will be returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.

  Fields:
    responseView: The response_view specifies which subset of the Task will be
      returned. By default response_view is 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 requires `cloudtasks.tasks.fullView` [Google
      IAM](https://cloud.google.com/iam/) permission on the Task resource.
  """

  class ResponseViewValueValuesEnum(_messages.Enum):
    r"""The response_view specifies which subset of the Task will be returned.
    By default response_view is 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 requires
    `cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)
    permission on the Task resource.

    Values:
      VIEW_UNSPECIFIED: Unspecified. Defaults to BASIC.
      BASIC: The basic view omits fields which can be large or can contain
        sensitive data. This view does not include the body in
        AppEngineHttpRequest. 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.
      FULL: All information is returned. Authorization for FULL requires
        `cloudtasks.tasks.fullView` [Google
        IAM](https://cloud.google.com/iam/) permission on the Queue resource.
    """
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

  responseView = _messages.EnumField('ResponseViewValueValuesEnum', 1)


class SetIamPolicyRequest(_messages.Message):
  r"""Request message for `SetIamPolicy` method.

  Fields:
    policy: REQUIRED: The complete policy to be applied to the `resource`. The
      size of the policy is limited to a few 10s of KB. An empty policy is a
      valid policy but certain Google Cloud services (such as Projects) might
      reject them.
  """

  policy = _messages.MessageField('Policy', 1)


class StackdriverLoggingConfig(_messages.Message):
  r"""Configuration options for writing logs to [Stackdriver
  Logging](https://cloud.google.com/logging/docs/).

  Fields:
    samplingRatio: Specifies the fraction of operations to write to
      [Stackdriver Logging](https://cloud.google.com/logging/docs/). This
      field may contain any value between 0.0 and 1.0, inclusive. 0.0 is the
      default and means that no operations are logged.
  """

  samplingRatio = _messages.FloatField(1)


class StandardQueryParameters(_messages.Message):
  r"""Query parameters accepted by all methods.

  Enums:
    FXgafvValueValuesEnum: V1 error format.
    AltValueValuesEnum: Data format for response.

  Fields:
    f__xgafv: V1 error format.
    access_token: OAuth access token.
    alt: Data format for response.
    callback: JSONP
    fields: Selector specifying which fields to include in a partial response.
    key: API key. Your API key identifies your project and provides you with
      API access, quota, and reports. Required unless you provide an OAuth 2.0
      token.
    oauth_token: OAuth 2.0 token for the current user.
    prettyPrint: Returns response with indentations and line breaks.
    quotaUser: Available to use for quota purposes for server-side
      applications. Can be any arbitrary string assigned to a user, but should
      not exceed 40 characters.
    trace: A tracing token of the form "token:<tokenid>" to include in api
      requests.
    uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
    upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
  """

  class AltValueValuesEnum(_messages.Enum):
    r"""Data format for response.

    Values:
      json: Responses with Content-Type of application/json
      media: Media download with context-dependent Content-Type
      proto: Responses with Content-Type of application/x-protobuf
    """
    json = 0
    media = 1
    proto = 2

  class FXgafvValueValuesEnum(_messages.Enum):
    r"""V1 error format.

    Values:
      _1: v1 error format
      _2: v2 error format
    """
    _1 = 0
    _2 = 1

  f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1)
  access_token = _messages.StringField(2)
  alt = _messages.EnumField('AltValueValuesEnum', 3, default='json')
  callback = _messages.StringField(4)
  fields = _messages.StringField(5)
  key = _messages.StringField(6)
  oauth_token = _messages.StringField(7)
  prettyPrint = _messages.BooleanField(8, default=True)
  quotaUser = _messages.StringField(9)
  trace = _messages.StringField(10)
  uploadType = _messages.StringField(11)
  upload_protocol = _messages.StringField(12)


class Status(_messages.Message):
  r"""The `Status` type defines a logical error model that is suitable for
  different programming environments, including REST APIs and RPC APIs. It is
  used by [gRPC](https://github.com/grpc). Each `Status` message contains
  three pieces of data: error code, error message, and error details. You can
  find out more about this error model and how to work with it in the [API
  Design Guide](https://cloud.google.com/apis/design/errors).

  Messages:
    DetailsValueListEntry: A DetailsValueListEntry object.

  Fields:
    code: The status code, which should be an enum value of google.rpc.Code.
    details: A list of messages that carry the error details. There is a
      common set of message types for APIs to use.
    message: A developer-facing error message, which should be in English. Any
      user-facing error message should be localized and sent in the
      google.rpc.Status.details field, or localized by the client.
  """

  @encoding.MapUnrecognizedFields('additionalProperties')
  class DetailsValueListEntry(_messages.Message):
    r"""A DetailsValueListEntry object.

    Messages:
      AdditionalProperty: An additional property for a DetailsValueListEntry
        object.

    Fields:
      additionalProperties: Properties of the object. Contains field @type
        with type URL.
    """

    class AdditionalProperty(_messages.Message):
      r"""An additional property for a DetailsValueListEntry object.

      Fields:
        key: Name of the additional property.
        value: A extra_types.JsonValue attribute.
      """

      key = _messages.StringField(1)
      value = _messages.MessageField('extra_types.JsonValue', 2)

    additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True)

  code = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True)
  message = _messages.StringField(3)


class Task(_messages.Message):
  r"""A unit of scheduled work.

  Enums:
    ViewValueValuesEnum: Output only. The view specifies which subset of the
      Task has been returned.

  Fields:
    appEngineHttpRequest: HTTP request that is sent to the App Engine app
      handler. An App Engine task is a task that has AppEngineHttpRequest set.
    createTime: Output only. The time that the task was created. `create_time`
      will be truncated to the nearest second.
    dispatchCount: Output only. The number of attempts dispatched. This count
      includes attempts which have been dispatched but haven't received a
      response.
    dispatchDeadline: 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. Note that when the
      request is cancelled, Cloud Tasks will stop listening for the response,
      but whether the worker stops processing depends on the worker. For
      example, if the worker is stuck, it may not react to cancelled requests.
      The default and maximum values depend on the type of request: * For HTTP
      tasks, the default is 10 minutes. The deadline must be in the interval
      [15 seconds, 30 minutes]. * For App Engine tasks, 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) 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 seconds, 24 hours 15
      seconds]. Regardless of the task's `dispatch_deadline`, the app handler
      will not run for longer than than the service's timeout. We recommend
      setting the `dispatch_deadline` to at most a few seconds more than the
      app handler's timeout. For more information see
      [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine-
      handlers#timeouts). The value must be given as a string that indicates
      the length of time (in seconds) followed by `s` (for "seconds"). For
      more information on the format, see the documentation for [Duration](htt
      ps://protobuf.dev/reference/protobuf/google.protobuf/#duration).
      `dispatch_deadline` will be truncated to the nearest millisecond. The
      deadline is an approximate deadline.
    firstAttempt: Output only. The status of the task's first attempt. Only
      dispatch_time will be set. The other Attempt information is not retained
      by Cloud Tasks.
    httpRequest: HTTP request that is sent to the worker. An HTTP task is a
      task that has HttpRequest set.
    lastAttempt: Output only. The status of the task's last attempt.
    name: Optionally caller-specified in CreateTask. The task name. The task
      name must have the following format: `projects/PROJECT_ID/locations/LOCA
      TION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `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) * `LOCATION_ID` is the canonical
      ID for the task's location. The list of available locations can be
      obtained by calling ListLocations. For more information, see
      https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain
      letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length
      is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]),
      numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is
      500 characters.
    responseCount: Output only. The number of attempts which have received a
      response.
    scheduleTime: The time when the task is scheduled to be attempted or
      retried. `schedule_time` will be truncated to the nearest microsecond.
    view: Output only. The view specifies which subset of the Task has been
      returned.
  """

  class ViewValueValuesEnum(_messages.Enum):
    r"""Output only. The view specifies which subset of the Task has been
    returned.

    Values:
      VIEW_UNSPECIFIED: Unspecified. Defaults to BASIC.
      BASIC: The basic view omits fields which can be large or can contain
        sensitive data. This view does not include the body in
        AppEngineHttpRequest. 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.
      FULL: All information is returned. Authorization for FULL requires
        `cloudtasks.tasks.fullView` [Google
        IAM](https://cloud.google.com/iam/) permission on the Queue resource.
    """
    VIEW_UNSPECIFIED = 0
    BASIC = 1
    FULL = 2

  appEngineHttpRequest = _messages.MessageField('AppEngineHttpRequest', 1)
  createTime = _messages.StringField(2)
  dispatchCount = _messages.IntegerField(3, variant=_messages.Variant.INT32)
  dispatchDeadline = _messages.StringField(4)
  firstAttempt = _messages.MessageField('Attempt', 5)
  httpRequest = _messages.MessageField('HttpRequest', 6)
  lastAttempt = _messages.MessageField('Attempt', 7)
  name = _messages.StringField(8)
  responseCount = _messages.IntegerField(9, variant=_messages.Variant.INT32)
  scheduleTime = _messages.StringField(10)
  view = _messages.EnumField('ViewValueValuesEnum', 11)


class TestIamPermissionsRequest(_messages.Message):
  r"""Request message for `TestIamPermissions` method.

  Fields:
    permissions: The set of permissions to check for the `resource`.
      Permissions with wildcards (such as `*` or `storage.*`) are not allowed.
      For more information see [IAM
      Overview](https://cloud.google.com/iam/docs/overview#permissions).
  """

  permissions = _messages.StringField(1, repeated=True)


class TestIamPermissionsResponse(_messages.Message):
  r"""Response message for `TestIamPermissions` method.

  Fields:
    permissions: A subset of `TestPermissionsRequest.permissions` that the
      caller is allowed.
  """

  permissions = _messages.StringField(1, repeated=True)


class UriOverride(_messages.Message):
  r"""URI Override. When specified, all the HTTP tasks inside the queue will
  be partially or fully overridden depending on the configured values.

  Enums:
    SchemeValueValuesEnum: Scheme override. When specified, the task URI
      scheme is replaced by the provided value (HTTP or HTTPS).
    UriOverrideEnforceModeValueValuesEnum: URI Override Enforce Mode When
      specified, determines the Target UriOverride mode. If not specified, it
      defaults to ALWAYS.

  Fields:
    host: Host override. When specified, replaces the host part of the task
      URL. For example, if the task URL is "https://www.google.com," and host
      value is set to "example.net", the overridden URI will be changed to
      "https://example.net." Host value cannot be an empty string
      (INVALID_ARGUMENT).
    pathOverride: URI path. When specified, replaces the existing path of the
      task URL. Setting the path value to an empty string clears the URI path
      segment.
    port: Port override. When specified, replaces the port part of the task
      URI. For instance, for a URI http://www.google.com/foo and port=123, the
      overridden URI becomes http://www.google.com:123/foo. Note that the port
      value must be a positive integer. Setting the port to 0 (Zero) clears
      the URI port.
    queryOverride: URI query. When specified, replaces the query part of the
      task URI. Setting the query value to an empty string clears the URI
      query segment.
    scheme: Scheme override. When specified, the task URI scheme is replaced
      by the provided value (HTTP or HTTPS).
    uriOverrideEnforceMode: URI Override Enforce Mode When specified,
      determines the Target UriOverride mode. If not specified, it defaults to
      ALWAYS.
  """

  class SchemeValueValuesEnum(_messages.Enum):
    r"""Scheme override. When specified, the task URI scheme is replaced by
    the provided value (HTTP or HTTPS).

    Values:
      SCHEME_UNSPECIFIED: Scheme unspecified. Defaults to HTTPS.
      HTTP: Convert the scheme to HTTP, e.g., https://www.google.ca will
        change to http://www.google.ca.
      HTTPS: Convert the scheme to HTTPS, e.g., http://www.google.ca will
        change to https://www.google.ca.
    """
    SCHEME_UNSPECIFIED = 0
    HTTP = 1
    HTTPS = 2

  class UriOverrideEnforceModeValueValuesEnum(_messages.Enum):
    r"""URI Override Enforce Mode When specified, determines the Target
    UriOverride mode. If not specified, it defaults to ALWAYS.

    Values:
      URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED: UriOverrideEnforceMode
        Unspecified. Defaults to ALWAYS.
      IF_NOT_EXISTS: In the IF_NOT_EXISTS mode, queue-level configuration is
        only applied where task-level configuration does not exist.
      ALWAYS: In the ALWAYS mode, queue-level configuration overrides all
        task-level configuration
    """
    URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0
    IF_NOT_EXISTS = 1
    ALWAYS = 2

  host = _messages.StringField(1)
  pathOverride = _messages.MessageField('PathOverride', 2)
  port = _messages.IntegerField(3)
  queryOverride = _messages.MessageField('QueryOverride', 4)
  scheme = _messages.EnumField('SchemeValueValuesEnum', 5)
  uriOverrideEnforceMode = _messages.EnumField('UriOverrideEnforceModeValueValuesEnum', 6)


encoding.AddCustomJsonFieldMapping(
    StandardQueryParameters, 'f__xgafv', '$.xgafv')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')
