You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/google-api-services-cloudscheduler/v1/1.26.0/com/google/api/services/cloudscheduler/v1/model/HttpTarget.java
+12-9Lines changed: 12 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -68,7 +68,8 @@ public final class HttpTarget extends com.google.api.client.json.GenericJson {
68
68
* If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be
69
69
* generated and attached as an `Authorization` header in the HTTP request.
70
70
*
71
-
* This type of authorization should be used when sending requests to a GCP endpoint.
71
+
* This type of authorization should generally only be used when calling Google APIs hosted on
72
+
* *.googleapis.com.
72
73
* The value may be {@code null}.
73
74
*/
74
75
@com.google.api.client.util.Key
@@ -78,8 +79,8 @@ public final class HttpTarget extends com.google.api.client.json.GenericJson {
78
79
* If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token
79
80
* will be generated and attached as an `Authorization` header in the HTTP request.
80
81
*
81
-
* This type of authorization should be used when sending requests to third party endpoints or
82
-
* Cloud Run.
82
+
* This type of authorization can be used for many scenarios, including calling Cloud Run, or
83
+
* endpoints where you intend to validate the token yourself.
83
84
* The value may be {@code null}.
84
85
*/
85
86
@com.google.api.client.util.Key
@@ -202,7 +203,8 @@ public HttpTarget setHttpMethod(java.lang.String httpMethod) {
202
203
* If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be
203
204
* generated and attached as an `Authorization` header in the HTTP request.
204
205
*
205
-
* This type of authorization should be used when sending requests to a GCP endpoint.
206
+
* This type of authorization should generally only be used when calling Google APIs hosted on
207
+
* *.googleapis.com.
206
208
* @return value or {@code null} for none
207
209
*/
208
210
publicOAuthTokengetOauthToken() {
@@ -213,7 +215,8 @@ public OAuthToken getOauthToken() {
213
215
* If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be
214
216
* generated and attached as an `Authorization` header in the HTTP request.
215
217
*
216
-
* This type of authorization should be used when sending requests to a GCP endpoint.
218
+
* This type of authorization should generally only be used when calling Google APIs hosted on
219
+
* *.googleapis.com.
217
220
* @param oauthToken oauthToken or {@code null} for none
Copy file name to clipboardExpand all lines: clients/google-api-services-cloudscheduler/v1/1.26.0/com/google/api/services/cloudscheduler/v1/model/OAuthToken.java
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@
19
19
/**
20
20
* Contains information needed for generating an [OAuth
21
21
* token](https://developers.google.com/identity/protocols/OAuth2). This type of authorization
22
-
* should be used when sending requests to a GCP endpoint.
22
+
* should generally only be used when calling Google APIs hosted on *.googleapis.com.
23
23
*
24
24
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
25
25
* transmitted over HTTP when working with the Cloud Scheduler API. For a detailed explanation see:
Copy file name to clipboardExpand all lines: clients/google-api-services-cloudscheduler/v1/1.26.0/com/google/api/services/cloudscheduler/v1/model/OidcToken.java
+2-1Lines changed: 2 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,8 @@
19
19
/**
20
20
* Contains information needed for generating an [OpenID Connect
21
21
* token](https://developers.google.com/identity/protocols/OpenIDConnect). This type of
22
-
* authorization should be used when sending requests to third party endpoints or Cloud Run.
22
+
* authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you
23
+
* intend to validate the token yourself.
23
24
*
24
25
* <p> This is the Java data model class that specifies how to parse/serialize into the JSON that is
25
26
* transmitted over HTTP when working with the Cloud Scheduler API. For a detailed explanation see:
Copy file name to clipboardExpand all lines: clients/google-api-services-cloudscheduler/v1/1.26.0/com/google/api/services/cloudscheduler/v1/model/Status.java
+4-42Lines changed: 4 additions & 42 deletions
Original file line number
Diff line number
Diff line change
@@ -19,49 +19,11 @@
19
19
/**
20
20
* The `Status` type defines a logical error model that is suitable for different programming
21
21
* environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc).
22
-
* The error model is designed to be:
22
+
* Each `Status` message contains three pieces of data: error code, error message, and error
23
+
* details.
23
24
*
24
-
* - Simple to use and understand for most users - Flexible enough to meet unexpected needs
25
-
*
26
-
* # Overview
27
-
*
28
-
* The `Status` message contains three pieces of data: error code, error message, and error details.
29
-
* The error code should be an enum value of google.rpc.Code, but it may accept additional error
30
-
* codes if needed. The error message should be a developer-facing English message that helps
31
-
* developers *understand* and *resolve* the error. If a localized user-facing error message is
32
-
* needed, put the localized message in the error details or localize it in the client. The optional
33
-
* error details may contain arbitrary information about the error. There is a predefined set of
34
-
* error detail types in the package `google.rpc` that can be used for common error conditions.
35
-
*
36
-
* # Language mapping
37
-
*
38
-
* The `Status` message is the logical representation of the error model, but it is not necessarily
39
-
* the actual wire format. When the `Status` message is exposed in different client libraries and
40
-
* different wire protocols, it can be mapped differently. For example, it will likely be mapped to
41
-
* some exceptions in Java, but more likely mapped to some error codes in C.
42
-
*
43
-
* # Other uses
44
-
*
45
-
* The error model and the `Status` message can be used in a variety of environments, either with or
46
-
* without APIs, to provide a consistent developer experience across different environments.
47
-
*
48
-
* Example uses of this error model include:
49
-
*
50
-
* - Partial errors. If a service needs to return partial errors to the client, it may embed the
51
-
* `Status` in the normal response to indicate the partial errors.
52
-
*
53
-
* - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status`
54
-
* message for error reporting.
55
-
*
56
-
* - Batch operations. If a client uses batch request and batch response, the `Status` message
57
-
* should be used directly inside batch response, one for each error sub-response.
58
-
*
59
-
* - Asynchronous operations. If an API call embeds asynchronous operation results in its
60
-
* response, the status of those operations should be represented directly using the `Status`
61
-
* message.
62
-
*
63
-
* - Logging. If some API errors are stored in logs, the message `Status` could be used directly
64
-
* after any stripping needed for security/privacy reasons.
25
+
* You can find out more about this error model and how to work with it in the [API Design
0 commit comments