target.rb in google-cloud-tasks-1.0.0

- old
+ new

@@ -17,14 +17,10 @@
   module Cloud
     module Tasks
       module V2beta3
         # HTTP request.
         #
-        # Warning: This is an [alpha](https://cloud.google.com/terms/launch-stages)
-        # feature. If you haven't already joined, you can [use this form to sign
-        # up](https://docs.google.com/forms/d/e/1FAIpQLSfc4uEy9CBHKYUSdnY1hdhKDCX7julVZHy3imOiR-XrU7bUNQ/viewform).
-        #
         # 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 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:
@@ -105,21 +101,22 @@
         #     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 be used when sending requests to a GCP
-        #     endpoint.
+        #     This type of authorization should generally only be used when calling
+        #     Google APIs hosted on *.googleapis.com.
         # @!attribute [rw] oidc_token
         #   @return [Google::Cloud::Tasks::V2beta3::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 should be used when sending requests to third
-        #     party endpoints.
+        #     This type of authorization can be used for many scenarios, including
+        #     calling Cloud Run, or endpoints where you intend to validate the token
+        #     yourself.
         class HttpRequest; end
 
         # App Engine HTTP queue.
         #
         # The task will be delivered to the App Engine application hostname
@@ -146,13 +143,10 @@
         # App Engine HTTP request.
         #
         # The message defines the HTTP request that is sent to an App Engine app when
         # the task is dispatched.
         #
-        # This proto can only be used for tasks in a queue which has
-        # {Google::Cloud::Tasks::V2beta3::Queue#app_engine_http_queue app_engine_http_queue} set.
-        #
         # Using {Google::Cloud::Tasks::V2beta3::AppEngineHttpRequest AppEngineHttpRequest} requires
         # [`appengine.applications.get`](https://cloud.google.com/appengine/docs/admin-api/access-control)
         # Google IAM permission for the project
         # and the following scope:
         #
@@ -194,17 +188,21 @@
         # 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`]. `503` is
-        # considered an App Engine system error instead of an application
-        # error. Requests returning error `503` will be retried regardless of
-        # retry configuration and not counted against retry counts.
-        # Any other response code or a failure to receive a response before the
-        # deadline is a failed attempt.
+        # 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 {Google::Cloud::Tasks::V2beta3::Task#dispatch_deadline deadline}. Failed
+        # tasks will be retried according to the
+        # {Queue::RetryConfig 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.
         # @!attribute [rw] http_method
         #   @return [Google::Cloud::Tasks::V2beta3::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
@@ -364,12 +362,12 @@
         #     Routed](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed).
         class AppEngineRouting; end
 
         # Contains information needed for generating an
         # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
-        # This type of authorization should be used when sending requests to a GCP
-        # endpoint.
+        # This type of authorization should generally only be used when calling Google
+        # APIs hosted on *.googleapis.com.
         # @!attribute [rw] service_account_email
         #   @return [String]
         #     [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
@@ -382,12 +380,13 @@
         #     will be used.
         class OAuthToken; end
 
         # Contains information needed for generating an
         # [OpenID Connect
-        # token](https://developers.google.com/identity/protocols/OpenIDConnect). This
-        # type of authorization should be used when sending requests to third party
-        # endpoints.
+        # 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.
         # @!attribute [rw] service_account_email
         #   @return [String]
         #     [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
\ No newline at end of file