Class: Google::Apis::CloudtasksV2::HttpRequest

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudtasks_v2/classes.rb,
generated/google/apis/cloudtasks_v2/representations.rb,
generated/google/apis/cloudtasks_v2/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 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).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpRequest

Returns a new instance of HttpRequest.



554
555
556
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 554

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.

Returns:

  • (String) 


504
505
506
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 504

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 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. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


521
522
523
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 521

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

Returns:

  • (String) 


526
527
528
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 526

def http_method
  @http_method
end

#oauth_token ⇒ Google::Apis::CloudtasksV2::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

Returns:



533
534
535
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 533

def oauth_token
  @oauth_token
end

#oidc_token ⇒ Google::Apis::CloudtasksV2::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

Returns:



541
542
543
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 541

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

Returns:

  • (String) 


552
553
554
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 552

def url
  @url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



559
560
561
562
563
564
565
566
 
# File 'generated/google/apis/cloudtasks_v2/classes.rb', line 559

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