google-cloud-tasks-v2beta2 0.9.1 → 0.10.0

data/proto_docs/google/cloud/tasks/v2beta2/target.rb

@@ -401,6 +401,340 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # HTTP request.
+        #
+        # The task will be pushed to the worker as an HTTP request. An HTTP request
+        # embodies a url, an http method, headers, body and authorization for the http
+        # task.
+        # @!attribute [rw] url
+        #   @return [::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.
+        # @!attribute [rw] http_method
+        #   @return [::Google::Cloud::Tasks::V2beta2::HttpMethod]
+        #     The HTTP method to use for the request. The default is POST.
+        # @!attribute [rw] headers
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     HTTP request headers.
+        #
+        #     This map contains the header field names and values.
+        #     Headers can be set when running the
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task task is created} or
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#buffer_task 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:
+        #
+        #     * 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
+        #       {::Google::Cloud::Tasks::V2beta2::HttpRequest#url 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][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.
+        # @!attribute [rw] body
+        #   @return [::String]
+        #     HTTP request body.
+        #
+        #     A request body is allowed only if the
+        #     {::Google::Cloud::Tasks::V2beta2::HttpRequest#http_method HTTP method} is POST,
+        #     PUT, or PATCH. It is an error to set body on a task with an incompatible
+        #     {::Google::Cloud::Tasks::V2beta2::HttpMethod HttpMethod}.
+        # @!attribute [rw] oauth_token
+        #   @return [::Google::Cloud::Tasks::V2beta2::OAuthToken]
+        #     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 generally only be used when calling
+        #     Google APIs hosted on *.googleapis.com.
+        # @!attribute [rw] oidc_token
+        #   @return [::Google::Cloud::Tasks::V2beta2::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 can be used for many scenarios, including
+        #     calling Cloud Run, or endpoints where you intend to validate the token
+        #     yourself.
+        class HttpRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class HeadersEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # PathOverride.
+        #
+        # Path message defines path override for HTTP targets.
+        # @!attribute [rw] path
+        #   @return [::String]
+        #     The URI path (e.g., /users/1234). Default is an empty string.
+        class PathOverride
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # QueryOverride.
+        #
+        # Query message defines query override for HTTP targets.
+        # @!attribute [rw] query_params
+        #   @return [::String]
+        #     The query parameters (e.g., qparam1=123&qparam2=456). Default is an empty
+        #     string.
+        class QueryOverride
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Uri Override.
+        #
+        # When specified, all the HTTP tasks inside the queue will be partially or
+        # fully overridden depending on the configured values.
+        # @!attribute [rw] scheme
+        #   @return [::Google::Cloud::Tasks::V2beta2::UriOverride::Scheme]
+        #     Scheme override.
+        #
+        #     When specified, the task URI scheme is replaced by the provided value (HTTP
+        #     or HTTPS).
+        # @!attribute [rw] host
+        #   @return [::String]
+        #     Host override.
+        #
+        #     When specified, replaces the host part of the task URL. For example,
+        #     if the task URL is "https://www.google.com," and host value is set to
+        #     "example.net", the overridden URI will be changed to "https://example.net."
+        #     Host value cannot be an empty string (INVALID_ARGUMENT).
+        # @!attribute [rw] port
+        #   @return [::Integer]
+        #     Port override.
+        #
+        #     When specified, replaces the port part of the task URI. For instance,
+        #     for a URI http://www.google.com/foo and port=123, the overridden URI
+        #     becomes http://www.google.com:123/foo. Note that the port value must be a
+        #     positive integer. Setting the port to 0 (Zero) clears the URI port.
+        # @!attribute [rw] path_override
+        #   @return [::Google::Cloud::Tasks::V2beta2::PathOverride]
+        #     URI path.
+        #
+        #     When specified, replaces the existing path of the task URL. Setting the
+        #     path value to an empty string clears the URI path segment.
+        # @!attribute [rw] query_override
+        #   @return [::Google::Cloud::Tasks::V2beta2::QueryOverride]
+        #     URI Query.
+        #
+        #     When specified, replaces the query part of the task URI. Setting the
+        #     query value to an empty string clears the URI query segment.
+        # @!attribute [rw] uri_override_enforce_mode
+        #   @return [::Google::Cloud::Tasks::V2beta2::UriOverride::UriOverrideEnforceMode]
+        #     URI Override Enforce Mode
+        #
+        #     When specified, determines the Target UriOverride mode. If not specified,
+        #     it defaults to ALWAYS.
+        class UriOverride
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The Scheme for an HTTP request. By default, it is HTTPS.
+          module Scheme
+            # Scheme unspecified. Defaults to HTTPS.
+            SCHEME_UNSPECIFIED = 0
+
+            # Convert the scheme to HTTP, e.g., https://www.google.ca will change to
+            # http://www.google.ca.
+            HTTP = 1
+
+            # Convert the scheme to HTTPS, e.g., http://www.google.ca will change to
+            # https://www.google.ca.
+            HTTPS = 2
+          end
+
+          # UriOverrideEnforceMode mode is to define enforcing mode for the override
+          # modes.
+          module UriOverrideEnforceMode
+            # OverrideMode Unspecified. Defaults to ALWAYS.
+            URI_OVERRIDE_ENFORCE_MODE_UNSPECIFIED = 0
+
+            # In the IF_NOT_EXISTS mode, queue-level configuration is only
+            # applied where task-level configuration does not exist.
+            IF_NOT_EXISTS = 1
+
+            # In the ALWAYS mode, queue-level configuration overrides all
+            # task-level configuration
+            ALWAYS = 2
+          end
+        end
+
+        # HTTP target.
+        #
+        # When specified as a [Queue][target_type], all the tasks with [HttpRequest]
+        # will be overridden according to the target.
+        # @!attribute [rw] uri_override
+        #   @return [::Google::Cloud::Tasks::V2beta2::UriOverride]
+        #     Uri override.
+        #
+        #     When specified, overrides the execution Uri for all the tasks in the queue.
+        # @!attribute [rw] http_method
+        #   @return [::Google::Cloud::Tasks::V2beta2::HttpMethod]
+        #     The HTTP method to use for the request.
+        #
+        #     When specified, it overrides
+        #     {::Google::Cloud::Tasks::V2beta2::HttpTarget#http_method 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.
+        # @!attribute [rw] header_overrides
+        #   @return [::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
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#create_task task is created} and/or
+        #     {::Google::Cloud::Tasks::V2beta2::CloudTasks::Client#buffer_task 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:
+        #     * 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
+        #       {::Google::Cloud::Tasks::V2beta2::HttpRequest#url 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.
+        # @!attribute [rw] oauth_token
+        #   @return [::Google::Cloud::Tasks::V2beta2::OAuthToken]
+        #     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 generally only be used when calling
+        #     Google APIs hosted on *.googleapis.com.
+        # @!attribute [rw] oidc_token
+        #   @return [::Google::Cloud::Tasks::V2beta2::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 can be used for many scenarios, including
+        #     calling Cloud Run, or endpoints where you intend to validate the token
+        #     yourself.
+        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
+
+        # Contains information needed for generating an
+        # [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
+        # 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
+        #     caller must have iam.serviceAccounts.actAs permission for the service
+        #     account.
+        # @!attribute [rw] scope
+        #   @return [::String]
+        #     OAuth scope to be used for generating OAuth access token.
+        #     If not specified, "https://www.googleapis.com/auth/cloud-platform"
+        #     will be used.
+        class OAuthToken
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Contains information needed for generating an
+        # [OpenID Connect
+        # 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
+        #     caller must have iam.serviceAccounts.actAs permission for the service
+        #     account.
+        # @!attribute [rw] audience
+        #   @return [::String]
+        #     Audience to be used when generating OIDC token. If not specified, the URI
+        #     specified in target will be used.
+        class OidcToken
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # The HTTP method used to execute the task.
         module HttpMethod
           # HTTP method unspecified
@@ -420,6 +754,12 @@ module Google
 
           # HTTP DELETE
           DELETE = 5
+
+          # HTTP PATCH
+          PATCH = 6
+
+          # HTTP OPTIONS
+          OPTIONS = 7
         end
       end
     end

data/proto_docs/google/cloud/tasks/v2beta2/task.rb

@@ -39,7 +39,7 @@ module Google
         #        projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects)
         #     * `LOCATION_ID` is the canonical ID for the task's location.
         #        The list of available locations can be obtained by calling
-        #        [ListLocations][google.cloud.location.Locations.ListLocations].
+        #        `::Google::Cloud::Location::Locations::Client#list_locations`.
         #        For more information, see https://cloud.google.com/about/locations/.
         #     * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or
         #       hyphens (-). The maximum length is 100 characters.
@@ -64,6 +64,12 @@ module Google
         #
         #     A pull task is a task that has
         #     {::Google::Cloud::Tasks::V2beta2::PullMessage PullMessage} set.
+        # @!attribute [rw] http_request
+        #   @return [::Google::Cloud::Tasks::V2beta2::HttpRequest]
+        #     HTTP request that is sent to the task's target.
+        #
+        #     An HTTP task is a task that has
+        #     {::Google::Cloud::Tasks::V2beta2::HttpRequest HttpRequest} set.
         # @!attribute [rw] schedule_time
         #   @return [::Google::Protobuf::Timestamp]
         #     The time when the task is scheduled to be attempted.

data/proto_docs/google/iam/v1/policy.rb

@@ -40,6 +40,7 @@ module Google
       #
       # **JSON example:**
       #
+      # ```
       #     {
       #       "bindings": [
       #         {
@@ -67,9 +68,11 @@ module Google
       #       "etag": "BwWWja0YfJA=",
       #       "version": 3
       #     }
+      # ```
       #
       # **YAML example:**
       #
+      # ```
       #     bindings:
       #     - members:
       #       - user:mike@example.com
@@ -86,6 +89,7 @@ module Google
       #         expression: request.time < timestamp('2020-10-01T00:00:00.000Z')
       #     etag: BwWWja0YfJA=
       #     version: 3
+      # ```
       #
       # For a description of IAM and its features, see the
       # [IAM documentation](https://cloud.google.com/iam/docs/).
@@ -157,7 +161,7 @@ module Google
       #     For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
       # @!attribute [rw] members
       #   @return [::Array<::String>]
-      #     Specifies the principals requesting access for a Cloud Platform resource.
+      #     Specifies the principals requesting access for a Google Cloud resource.
       #     `members` can have the following values:
       #
       #     * `allUsers`: A special identifier that represents anyone who is
@@ -267,8 +271,8 @@ module Google
       #     }
       #
       # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
-      # logging. It also exempts jose@example.com from DATA_READ logging, and
-      # aliya@example.com from DATA_WRITE logging.
+      # logging. It also exempts `jose@example.com` from DATA_READ logging, and
+      # `aliya@example.com` from DATA_WRITE logging.
       # @!attribute [rw] service
       #   @return [::String]
       #     Specifies a service that will be enabled for audit logging.
@@ -356,7 +360,7 @@ module Google
       #     Required
       # @!attribute [rw] member
       #   @return [::String]
-      #     A single identity requesting access for a Cloud Platform resource.
+      #     A single identity requesting access for a Google Cloud resource.
       #     Follows the same format of Binding.members.
       #     Required
       # @!attribute [rw] condition

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-tasks-v2beta2
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -44,6 +44,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: google-cloud-location
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.a
 - !ruby/object:Gem::Dependency
   name: grpc-google-iam-v1
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +207,7 @@ files:
 - README.md
 - lib/google-cloud-tasks-v2beta2.rb
 - lib/google/cloud/tasks/v2beta2.rb
+- lib/google/cloud/tasks/v2beta2/bindings_override.rb
 - lib/google/cloud/tasks/v2beta2/cloud_tasks.rb
 - lib/google/cloud/tasks/v2beta2/cloud_tasks/client.rb
 - lib/google/cloud/tasks/v2beta2/cloud_tasks/credentials.rb
@@ -196,6 +217,7 @@ files:
 - lib/google/cloud/tasks/v2beta2/cloud_tasks/rest/service_stub.rb
 - lib/google/cloud/tasks/v2beta2/cloudtasks_pb.rb
 - lib/google/cloud/tasks/v2beta2/cloudtasks_services_pb.rb
+- lib/google/cloud/tasks/v2beta2/old_target_pb.rb
 - lib/google/cloud/tasks/v2beta2/queue_pb.rb
 - lib/google/cloud/tasks/v2beta2/rest.rb
 - lib/google/cloud/tasks/v2beta2/target_pb.rb
@@ -204,6 +226,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/httpbody.rb
 - proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
 - proto_docs/google/cloud/tasks/v2beta2/cloudtasks.rb
@@ -239,7 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Manages the execution of large numbers of distributed requests.