generated/google/apis/cloudtasks_v2beta3/classes.rb in google-api-client-0.28.4 vs generated/google/apis/cloudtasks_v2beta3/classes.rb in google-api-client-0.28.5

- old
+ new

@@ -38,18 +38,22 @@ # 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). + # [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). # Corresponds to the JSON property `appEngineRoutingOverride` # @return [Google::Apis::CloudtasksV2beta3::AppEngineRouting] attr_accessor :app_engine_routing_override def initialize(**args) @@ -73,15 +77,16 @@ # 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) + # [How Requests are + # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- + # are-routed) # and how routing is affected by - # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ - # dispatchref). + # [dispatch + # files](https://cloud.google.com/appengine/docs/python/config/dispatchref). # Traffic is encrypted during transport and never leaves Google datacenters. # Because this traffic is carried over a communication mechanism internal to # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). # The request to the handler, however, will appear to have used the HTTP # protocol. @@ -95,16 +100,17 @@ # 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://cloud.google.com/appengine/docs/standard/python/ - # config/appref). + # [`login: + # admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). # Because tasks are not run as any user, they cannot be dispatched to URIs # restricted with - # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) + # [`login: + # required`](https://cloud.google.com/appengine/docs/standard/python/config/ + # appref) # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application # error. Requests returning error `503` will be retried regardless of @@ -116,18 +122,22 @@ # 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). + # [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). # Corresponds to the JSON property `appEngineRouting` # @return [Google::Apis::CloudtasksV2beta3::AppEngineRouting] attr_accessor :app_engine_routing # HTTP request body. @@ -162,12 +172,13 @@ # * `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/appengine/docs/python/taskqueue/ - # push/creating-handlers#reading_request_headers). + # [request + # headers](https://cloud.google.com/appengine/docs/python/taskqueue/push/ + # creating-handlers#reading_request_headers). # These headers are set only when the task is dispatched, so they are not # visible when the task is returned in a Cloud Tasks response. # Although there is no specific limit for the maximum number of headers or # the size, there is a limit on the maximum size of the Task. For more # information, see the CreateTask documentation. @@ -177,16 +188,18 @@ # 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 will fail # with error code 405 (Method Not Allowed). See - # [Writing a push task request handler](https://cloud.google.com/appengine/docs/ - # java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler) + # [Writing a push task request + # handler](https://cloud.google.com/appengine/docs/java/taskqueue/push/creating- + # handlers#writing_a_push_task_request_handler) # and the documentation for the request handlers in the language your app is # written in e.g. - # [Python Request Handler](https://cloud.google.com/appengine/docs/python/tools/ - # webapp/requesthandlerclass). + # [Python Request + # Handler](https://cloud.google.com/appengine/docs/python/tools/webapp/ + # requesthandlerclass). # Corresponds to the JSON property `httpMethod` # @return [String] attr_accessor :http_method # The relative URI. @@ -214,46 +227,53 @@ # 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). + # [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). class AppEngineRouting include Google::Apis::Core::Hashable # 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 <app-id>.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). + # [How Requests are + # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- + # are-routed). # Corresponds to the JSON property `host` # @return [String] attr_accessor :host # 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). + # [manual scaling is used in App Engine + # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app- + # engine?hl=en_US#scaling_types_and_instance_classes). # App Engine Flex does not support instances. For more information, see - # [App Engine Standard request routing](https://cloud.google.com/appengine/docs/ - # standard/python/how-requests-are-routed) - # and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/ - # flexible/python/how-requests-are-routed). + # [App Engine Standard request + # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests- + # are-routed) + # and [App Engine Flex request + # routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests- + # are-routed). # Corresponds to the JSON property `instance` # @return [String] attr_accessor :instance # App service. @@ -313,18 +333,18 @@ # `dispatch_time` will be truncated to the nearest microsecond. # Corresponds to the JSON property `dispatchTime` # @return [String] attr_accessor :dispatch_time - # 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). The error model is designed to be: + # 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview - # The `Status` message contains three pieces of data: error code, error message, - # and error details. The error code should be an enum value of + # The `Status` message contains three pieces of data: error code, error + # message, and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary @@ -405,11 +425,11 @@ # account. For example, `alice@gmail.com` . # * `serviceAccount:`emailid``: An email address that represents a service # account. For example, `my-other-app@appspot.gserviceaccount.com`. # * `group:`emailid``: An email address that represents a Google group. # For example, `admins@example.com`. - # * `domain:`domain``: A Google Apps domain name that represents all the + # * `domain:`domain``: The G Suite domain (primary) that represents all the # users of that domain. For example, `google.com` or `example.com`. # Corresponds to the JSON property `members` # @return [Array<String>] attr_accessor :members @@ -805,12 +825,13 @@ # 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) + # [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 @@ -821,13 +842,13 @@ # 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/deleting-tasks-and-queues# - # purging_all_tasks_from_a_queue). + # [App Engine Task Queue SDK, or the Cloud + # Console](https://cloud.google.com/appengine/docs/standard/python/taskqueue/ + # push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue). # Purge time will be truncated to the nearest microsecond. Purge # time will be unset if the queue has never been purged. # Corresponds to the JSON property `purgeTime` # @return [String] attr_accessor :purge_time @@ -920,24 +941,26 @@ # 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.yaml/xml](https://cloud.google.com/appengine/ - # docs/standard/python/config/queueref#max_concurrent_requests). + # [max_concurrent_requests in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#max_concurrent_requests). # Corresponds to the JSON property `maxConcurrentDispatches` # @return [Fixnum] attr_accessor :max_concurrent_dispatches # The maximum rate at which tasks are dispatched from this queue. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # * For App Engine queues, the maximum allowed value # is 500. # This field has the same meaning as - # [rate in queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/ - # python/config/queueref#rate). + # [rate in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#rate). # Corresponds to the JSON property `maxDispatchesPerSecond` # @return [Float] attr_accessor :max_dispatches_per_second def initialize(**args) @@ -976,12 +999,13 @@ # 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). + # [task_retry_limit in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#retry_parameters). # Corresponds to the JSON property `maxAttempts` # @return [Fixnum] attr_accessor :max_attempts # A task will be scheduled for retry between @@ -991,12 +1015,13 @@ # retried. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # `max_backoff` will be truncated to the nearest second. # This field has the same meaning as - # [max_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/ - # docs/standard/python/config/queueref#retry_parameters). + # [max_backoff_seconds in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#retry_parameters). # Corresponds to the JSON property `maxBackoff` # @return [String] attr_accessor :max_backoff # The time between retries will double `max_doublings` times. @@ -1016,12 +1041,13 @@ # times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, # 240s, 300s, 300s, .... # If unspecified when the queue is created, Cloud Tasks will pick the # default. # This field has the same meaning as - # [max_doublings in queue.yaml/xml](https://cloud.google.com/appengine/docs/ - # standard/python/config/queueref#retry_parameters). + # [max_doublings in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#retry_parameters). # Corresponds to the JSON property `maxDoublings` # @return [Fixnum] attr_accessor :max_doublings # If positive, `max_retry_duration` specifies the time limit for @@ -1033,12 +1059,13 @@ # If zero, then the task age is unlimited. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # `max_retry_duration` will be truncated to the nearest second. # This field has the same meaning as - # [task_age_limit in queue.yaml/xml](https://cloud.google.com/appengine/docs/ - # standard/python/config/queueref#retry_parameters). + # [task_age_limit in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#retry_parameters). # Corresponds to the JSON property `maxRetryDuration` # @return [String] attr_accessor :max_retry_duration # A task will be scheduled for retry between @@ -1048,12 +1075,13 @@ # retried. # If unspecified when the queue is created, Cloud Tasks will pick the # default. # `min_backoff` will be truncated to the nearest second. # This field has the same meaning as - # [min_backoff_seconds in queue.yaml/xml](https://cloud.google.com/appengine/ - # docs/standard/python/config/queueref#retry_parameters). + # [min_backoff_seconds in + # queue.yaml/xml](https://cloud.google.com/appengine/docs/standard/python/config/ + # queueref#retry_parameters). # Corresponds to the JSON property `minBackoff` # @return [String] attr_accessor :min_backoff def initialize(**args) @@ -1152,18 +1180,18 @@ def update!(**args) @policy = args[:policy] if args.key?(:policy) end end - # 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). The error model is designed to be: + # 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). The error model is designed to be: # - Simple to use and understand for most users # - Flexible enough to meet unexpected needs # # Overview - # The `Status` message contains three pieces of data: error code, error message, - # and error details. The error code should be an enum value of + # The `Status` message contains three pieces of data: error code, error + # message, and error details. The error code should be an enum value of # google.rpc.Code, but it may accept additional error codes if needed. The # error message should be a developer-facing English message that helps # developers *understand* and *resolve* the error. If a localized user-facing # error message is needed, put the localized message in the error details or # localize it in the client. The optional error details may contain arbitrary @@ -1241,15 +1269,16 @@ # 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) + # [How Requests are + # Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests- + # are-routed) # and how routing is affected by - # [dispatch files](https://cloud.google.com/appengine/docs/python/config/ - # dispatchref). + # [dispatch + # files](https://cloud.google.com/appengine/docs/python/config/dispatchref). # Traffic is encrypted during transport and never leaves Google datacenters. # Because this traffic is carried over a communication mechanism internal to # Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS). # The request to the handler, however, will appear to have used the HTTP # protocol. @@ -1263,16 +1292,17 @@ # 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://cloud.google.com/appengine/docs/standard/python/ - # config/appref). + # [`login: + # admin`](https://cloud.google.com/appengine/docs/standard/python/config/appref). # Because tasks are not run as any user, they cannot be dispatched to URIs # restricted with - # [`login: required`](https://cloud.google.com/appengine/docs/standard/python/ - # config/appref) + # [`login: + # required`](https://cloud.google.com/appengine/docs/standard/python/config/ + # appref) # Task dispatches also do not follow redirects. # The task attempt has succeeded if the app's request handler returns # an HTTP response code in the range [`200` - `299`]. `503` is # considered an App Engine system error instead of an application # error. Requests returning error `503` will be retried regardless of @@ -1288,11 +1318,11 @@ # Corresponds to the JSON property `createTime` # @return [String] attr_accessor :create_time # Output only. The number of attempts dispatched. - # This count includes tasks which have been dispatched but haven't + # This count includes attempts which have been dispatched but haven't # received a response. # Corresponds to the JSON property `dispatchCount` # @return [Fixnum] attr_accessor :dispatch_count @@ -1305,12 +1335,13 @@ # 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 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) + # [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 @@ -1340,11 +1371,12 @@ # The task name must have the following format: # `projects/PROJECT_ID/locations/LOCATION_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) + # [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