lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/target.rb in google-cloud-scheduler-1.1.1 vs lib/google/cloud/scheduler/v1/doc/google/cloud/scheduler/v1/target.rb in google-cloud-scheduler-1.1.2
- old
+ new
@@ -23,13 +23,11 @@
# response code in the range [200 - 299]. A failure to receive a response
# constitutes a failed execution. For a redirected request, the response
# returned by the redirected request is considered.
# @!attribute [rw] uri
# @return [String]
- # Required.
- #
- # The full URI path that the request will be sent to. This string
+ # Required. The full URI path that the request will be sent to. This string
# must begin with either "http://" or "https://". Some examples of
# valid values for {Google::Cloud::Scheduler::V1::HttpTarget#uri uri} are:
# `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will
# encode some characters for safety and compatibility. The maximum allowed
# URL length is 2083 characters after encoding.
@@ -63,21 +61,22 @@
# 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 be used when sending requests to a GCP
- # endpoint.
+ # This type of authorization should generally only be used when calling
+ # Google APIs hosted on *.googleapis.com.
# @!attribute [rw] oidc_token
# @return [Google::Cloud::Scheduler::V1::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 should be used when sending requests to third
- # party endpoints or Cloud Run.
+ # 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; end
# App Engine target. The job will be pushed to a job handler by means
# of an HTTP request via an {Google::Cloud::Scheduler::V1::AppEngineHttpTarget#http_method http_method} such
# as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an
@@ -147,13 +146,11 @@
# Pub/Sub target. The job will be delivered by publishing a message to
# the given Pub/Sub topic.
# @!attribute [rw] topic_name
# @return [String]
- # Required.
- #
- # The name of the Cloud Pub/Sub topic to which messages will
+ # Required. The name of the Cloud Pub/Sub topic to which messages will
# be published when a job is delivered. The topic name must be in the
# same format as required by PubSub's
# [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
# for example `projects/PROJECT_ID/topics/TOPIC_ID`.
#
@@ -272,12 +269,12 @@
# to the default version of the default service when the job is attempted.
class AppEngineRouting; end
# Contains information needed for generating an
# [OAuth token](https://developers.google.com/identity/protocols/OAuth2).
- # This type of authorization should be used when sending requests to a GCP
- # endpoint.
+ # 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 job. The caller
@@ -289,12 +286,13 @@
# will be used.
class OAuthToken; end
# Contains information needed for generating an
# [OpenID Connect
- # token](https://developers.google.com/identity/protocols/OpenIDConnect). This
- # type of authorization should be used when sending requests to third party
- # endpoints or Cloud Run.
+ # 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 job. The caller
\ No newline at end of file