Class: Google::Apis::CloudtasksV2beta3::HttpRequest
- Inherits:
-
Object
- Object
- Google::Apis::CloudtasksV2beta3::HttpRequest
- Defined in:
- generated/google/apis/cloudtasks_v2beta3/classes.rb,
generated/google/apis/cloudtasks_v2beta3/representations.rb,
generated/google/apis/cloudtasks_v2beta3/representations.rb
Overview
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 theRetry-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).
Instance Attribute Summary collapse
-
#body ⇒ String
HTTP request body.
-
#headers ⇒ Hash<String,String>
HTTP request headers.
-
#http_method ⇒ String
The HTTP method to use for the request.
-
#oauth_token ⇒ Google::Apis::CloudtasksV2beta3::OAuthToken
Contains information needed for generating an OAuth token.
-
#oidc_token ⇒ Google::Apis::CloudtasksV2beta3::OidcToken
Contains information needed for generating an OpenID Connect token.
-
#url ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpRequest
constructor
A new instance of HttpRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ HttpRequest
Returns a new instance of HttpRequest.
710 711 712 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 710 def initialize(**args) update!(**args) end |
Instance Attribute Details
#body ⇒ String
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.
Corresponds to the JSON property body
NOTE: Values are automatically base64 encoded/decoded in the client library.
649 650 651 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 649 def body @body end |
#headers ⇒ Hash<String,String>
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 setContent-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. Corresponds to the JSON propertyheaders
674 675 676 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 674 def headers @headers end |
#http_method ⇒ String
The HTTP method to use for the request. The default is POST.
Corresponds to the JSON property httpMethod
679 680 681 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 679 def http_method @http_method end |
#oauth_token ⇒ Google::Apis::CloudtasksV2beta3::OAuthToken
Contains information needed for generating an
OAuth token.
This type of authorization should generally only be used when calling Google
APIs hosted on *.googleapis.com.
Corresponds to the JSON property oauthToken
687 688 689 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 687 def oauth_token @oauth_token end |
#oidc_token ⇒ Google::Apis::CloudtasksV2beta3::OidcToken
Contains information needed for generating an
OpenID Connect
token.
This type of authorization can be used for many scenarios, including
calling Cloud Run, or endpoints where you intend to validate the token
yourself.
Corresponds to the JSON property oidcToken
697 698 699 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 697 def oidc_token @oidc_token end |
#url ⇒ String
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.
Corresponds to the JSON property url
708 709 710 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 708 def url @url end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
715 716 717 718 719 720 721 722 |
# File 'generated/google/apis/cloudtasks_v2beta3/classes.rb', line 715 def update!(**args) @body = args[:body] if args.key?(:body) @headers = args[:headers] if args.key?(:headers) @http_method = args[:http_method] if args.key?(:http_method) @oauth_token = args[:oauth_token] if args.key?(:oauth_token) @oidc_token = args[:oidc_token] if args.key?(:oidc_token) @url = args[:url] if args.key?(:url) end |