Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [cloudscheduler] correct timezone/offset information for Cloud Scheduler headers #10048

Merged
merged 4 commits into from Nov 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions java-scheduler/README.md
Expand Up @@ -20,7 +20,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>26.23.0</version>
<version>26.26.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -195,7 +195,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/java11.html
[stability-image]: https://img.shields.io/badge/stability-stable-green
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-scheduler.svg
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-scheduler/2.24.0
[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-scheduler/2.30.0
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
Expand Down
Expand Up @@ -277,8 +277,8 @@ public int getHeadersCount() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -335,8 +335,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -384,8 +384,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -440,8 +440,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1442,8 +1442,8 @@ public int getHeadersCount() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1500,8 +1500,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1549,8 +1549,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1605,8 +1605,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1667,8 +1667,8 @@ public Builder clearHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1725,8 +1725,8 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -1781,8 +1781,8 @@ public Builder putHeaders(java.lang.String key, java.lang.String value) {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down
Expand Up @@ -139,8 +139,8 @@ public interface AppEngineHttpTargetOrBuilder
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -185,8 +185,8 @@ public interface AppEngineHttpTargetOrBuilder
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -234,8 +234,8 @@ public interface AppEngineHttpTargetOrBuilder
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -280,8 +280,8 @@ public interface AppEngineHttpTargetOrBuilder
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down Expand Up @@ -330,8 +330,8 @@ java.lang.String getHeadersOrDefault(
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* If the job has an
* [body][google.cloud.scheduler.v1.AppEngineHttpTarget.body], Cloud Scheduler
Expand Down
Expand Up @@ -272,8 +272,8 @@ public int getHeadersCount() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -313,8 +313,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -345,8 +345,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -384,8 +384,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1380,8 +1380,8 @@ public int getHeadersCount() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1421,8 +1421,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1453,8 +1453,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1492,8 +1492,8 @@ public java.util.Map<java.lang.String, java.lang.String> getHeadersMap() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1537,8 +1537,8 @@ public Builder clearHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1578,8 +1578,8 @@ public java.util.Map<java.lang.String, java.lang.String> getMutableHeaders() {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down Expand Up @@ -1617,8 +1617,8 @@ public Builder putHeaders(java.lang.String key, java.lang.String value) {
* * `X-CloudScheduler`: This header will be set to true.
* * `X-CloudScheduler-JobName`: This header will contain the job name.
* * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
* the unix-cron format, this header will contain the job schedule time in
* RFC3339 UTC "Zulu" format.
* the unix-cron format, this header will contain the job schedule as an
* offset of UTC parsed according to RFC3339.
*
* The total size of headers must be less than 80KB.
* </pre>
Expand Down