Class: Google::Cloud::Tasks::V2beta2::HttpTarget

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/tasks/v2beta2/target.rb

Overview

HTTP target.

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

Defined Under Namespace

Classes: Header, HeaderOverride

Instance Attribute Summary collapse

Instance Attribute Details

#header_overrides ⇒ ::Array<::Google::Cloud::Tasks::V2beta2::HttpTarget::HeaderOverride>

Returns HTTP target headers.

This map contains the header field names and values. Headers will be set when running the task is created and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

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:

  • Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
  • 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-CloudTasks".
  • 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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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. Queue-level headers to override headers of all the tasks in the queue.

Returns:

  • (::Array<::Google::Cloud::Tasks::V2beta2::HttpTarget::HeaderOverride>) —

    HTTP target headers.

    This map contains the header field names and values. Headers will be set when running the task is created and/or [task is created][google.cloud.tasks.v2beta2.CloudTasks.BufferTask].

    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:

    • Any header that is prefixed with "X-CloudTasks-" will be treated as service header. Service headers define properties of the task and are predefined in CloudTask.
    • 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-CloudTasks".
    • 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][google.cloud.tasks.v2beta3.CloudTasks.CreateTask]. 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. Queue-level headers to override headers of all the tasks in the queue.



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'proto_docs/google/cloud/tasks/v2beta2/target.rb', line 669

class HttpTarget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a header message. A header can have a key and a value.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the header.
  class Header
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Wraps the Header object.
  # @!attribute [rw] header
  #   @return [::Google::Cloud::Tasks::V2beta2::HttpTarget::Header]
  #     header embodying a key and a value.
  class HeaderOverride
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#http_method ⇒ ::Google::Cloud::Tasks::V2beta2::HttpMethod

Returns 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][GET] the [HttpRequest][body] of the task will be ignored at execution time.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'proto_docs/google/cloud/tasks/v2beta2/target.rb', line 669

class HttpTarget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a header message. A header can have a key and a value.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the header.
  class Header
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Wraps the Header object.
  # @!attribute [rw] header
  #   @return [::Google::Cloud::Tasks::V2beta2::HttpTarget::Header]
  #     header embodying a key and a value.
  class HeaderOverride
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oauth_token ⇒ ::Google::Cloud::Tasks::V2beta2::OAuthToken

Returns If specified, an OAuth token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'proto_docs/google/cloud/tasks/v2beta2/target.rb', line 669

class HttpTarget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a header message. A header can have a key and a value.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the header.
  class Header
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Wraps the Header object.
  # @!attribute [rw] header
  #   @return [::Google::Cloud::Tasks::V2beta2::HttpTarget::Header]
  #     header embodying a key and a value.
  class HeaderOverride
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#oidc_token ⇒ ::Google::Cloud::Tasks::V2beta2::OidcToken

Returns If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.

Returns:

  • (::Google::Cloud::Tasks::V2beta2::OidcToken) —

    If specified, an OIDC token will be generated and attached as an Authorization header in the HTTP request.

    This type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'proto_docs/google/cloud/tasks/v2beta2/target.rb', line 669

class HttpTarget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a header message. A header can have a key and a value.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the header.
  class Header
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Wraps the Header object.
  # @!attribute [rw] header
  #   @return [::Google::Cloud::Tasks::V2beta2::HttpTarget::Header]
  #     header embodying a key and a value.
  class HeaderOverride
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#uri_override ⇒ ::Google::Cloud::Tasks::V2beta2::UriOverride

Returns Uri override.

When specified, overrides the execution Uri for all the tasks in the queue.

Returns:



669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'proto_docs/google/cloud/tasks/v2beta2/target.rb', line 669

class HttpTarget
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Defines a header message. A header can have a key and a value.
  # @!attribute [rw] key
  #   @return [::String]
  #     The key of the header.
  # @!attribute [rw] value
  #   @return [::String]
  #     The value of the header.
  class Header
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Wraps the Header object.
  # @!attribute [rw] header
  #   @return [::Google::Cloud::Tasks::V2beta2::HttpTarget::Header]
  #     header embodying a key and a value.
  class HeaderOverride
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end