Class: Google::Apis::CloudtasksV2::HttpTarget

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudtasks_v2/classes.rb,
lib/google/apis/cloudtasks_v2/representations.rb,
lib/google/apis/cloudtasks_v2/representations.rb

Overview

HTTP target. When specified as a Queue, all the tasks with [HttpRequest] will be overridden according to the target.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpTarget

Returns a new instance of HttpTarget.



833
834
835
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 833

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#header_overrides ⇒ Array<Google::Apis::CloudtasksV2::HeaderOverride>

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). Corresponds to the JSON propertyheaderOverrides`

Returns:



803
804
805
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 803

def header_overrides
  @header_overrides
end

#http_method ⇒ String

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

Returns:

  • (String) 


810
811
812
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 810

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:



817
818
819
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 817

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:



825
826
827
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 825

def oidc_token
  @oidc_token
end

#uri_override ⇒ Google::Apis::CloudtasksV2::UriOverride

URI Override. When specified, all the HTTP tasks inside the queue will be partially or fully overridden depending on the configured values. Corresponds to the JSON property uriOverride

Returns:



831
832
833
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 831

def uri_override
  @uri_override
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



838
839
840
841
842
843
844
 
# File 'lib/google/apis/cloudtasks_v2/classes.rb', line 838

def update!(**args)
  @header_overrides = args[:header_overrides] if args.key?(:header_overrides)
  @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)
  @uri_override = args[:uri_override] if args.key?(:uri_override)
end