diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/metadata.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/metadata.ex index 5d3ef68dfb..a6b69396a0 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/metadata.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/metadata.ex @@ -20,7 +20,7 @@ defmodule GoogleApi.CloudScheduler.V1 do API client metadata for GoogleApi.CloudScheduler.V1. """ - @discovery_revision "20220721" + @discovery_revision "20240301" def discovery_revision(), do: @discovery_revision end diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/app_engine_http_target.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/app_engine_http_target.ex index 5e5716860a..aa98d923bf 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/app_engine_http_target.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/app_engine_http_target.ex @@ -23,7 +23,7 @@ defmodule GoogleApi.CloudScheduler.V1.Model.AppEngineHttpTarget do * `appEngineRouting` (*type:* `GoogleApi.CloudScheduler.V1.Model.AppEngineRouting.t`, *default:* `nil`) - App Engine Routing setting for the job. * `body` (*type:* `String.t`, *default:* `nil`) - Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible HttpMethod. - * `headers` (*type:* `map()`, *default:* `nil`) - HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `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. If the job has an body, Cloud Scheduler sets the following headers: * `Content-Type`: By default, the `Content-Type` header is set to `"application/octet-stream"`. The default can be overridden by explictly setting `Content-Type` to a particular media type when the job is created. For example, `Content-Type` can be set to `"application/json"`. * `Content-Length`: This is computed by Cloud Scheduler. This value is output only. It cannot be changed. The headers below are output only. They cannot be set or overridden: * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. + * `headers` (*type:* `map()`, *default:* `nil`) - HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: * `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google; (+http://code.google.com/appengine)"` to the modified `User-Agent`. * `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 as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The headers below are output only. They cannot be set or overridden: * `Content-Length`: This is computed by Cloud Scheduler. * `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also be sent to the job handler. * `httpMethod` (*type:* `String.t`, *default:* `nil`) - The HTTP method to use for the request. PATCH and OPTIONS are not permitted. * `relativeUri` (*type:* `String.t`, *default:* `nil`) - The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters. """ diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/http_target.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/http_target.ex index 9dd55b0d4e..f10cf01473 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/http_target.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/http_target.ex @@ -22,7 +22,7 @@ defmodule GoogleApi.CloudScheduler.V1.Model.HttpTarget do ## Attributes * `body` (*type:* `String.t`, *default:* `nil`) - HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. - * `headers` (*type:* `map()`, *default:* `nil`) - The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A partial list of headers that will be ignored or replaced is below: - Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `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 total size of headers must be less than 80KB. + * `headers` (*type:* `map()`, *default:* `nil`) - HTTP request headers. This map contains the header field names and values. The user can specify HTTP request headers to send with the job's HTTP request. Repeated headers are not supported, but a header value can contain commas. The following headers represent a subset of the headers that accompany the job's HTTP request. Some HTTP request headers are ignored or replaced. A partial list of headers that are ignored or replaced is below: * Host: This will be computed by Cloud Scheduler and derived from uri. * `Content-Length`: This will be computed by Cloud Scheduler. * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`. * `X-Google-*`: Google internal use only. * `X-AppEngine-*`: Google internal use only. * `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 as an offset of UTC parsed according to RFC3339. If the job has a body and the following headers are not set by the user, Cloud Scheduler sets default values: * `Content-Type`: This will be set to `"application/octet-stream"`. You can override this default by explicitly setting `Content-Type` to a particular media type when creating the job. For example, you can set `Content-Type` to `"application/json"`. The total size of headers must be less than 80KB. * `httpMethod` (*type:* `String.t`, *default:* `nil`) - Which HTTP method to use for the request. * `oauthToken` (*type:* `GoogleApi.CloudScheduler.V1.Model.OAuthToken.t`, *default:* `nil`) - 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. * `oidcToken` (*type:* `GoogleApi.CloudScheduler.V1.Model.OidcToken.t`, *default:* `nil`) - 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. diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/job.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/job.ex index d88f7f139d..58187218ef 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/job.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/job.ex @@ -29,7 +29,7 @@ defmodule GoogleApi.CloudScheduler.V1.Model.Job do * `name` (*type:* `String.t`, *default:* `nil`) - Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the job's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters. * `pubsubTarget` (*type:* `GoogleApi.CloudScheduler.V1.Model.PubsubTarget.t`, *default:* `nil`) - Pub/Sub target. * `retryConfig` (*type:* `GoogleApi.CloudScheduler.V1.Model.RetryConfig.t`, *default:* `nil`) - Settings that determine the retry behavior. - * `schedule` (*type:* `String.t`, *default:* `nil`) - Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. + * `schedule` (*type:* `String.t`, *default:* `nil`) - Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. * `scheduleTime` (*type:* `DateTime.t`, *default:* `nil`) - Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. * `state` (*type:* `String.t`, *default:* `nil`) - Output only. State of the job. * `status` (*type:* `GoogleApi.CloudScheduler.V1.Model.Status.t`, *default:* `nil`) - Output only. The response from the target for the last attempted execution. diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/location.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/location.ex index 324947e80d..ca23e25021 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/location.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/location.ex @@ -17,7 +17,7 @@ defmodule GoogleApi.CloudScheduler.V1.Model.Location do @moduledoc """ - A resource that represents Google Cloud Platform location. + A resource that represents a Google Cloud location. ## Attributes diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/pubsub_message.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/pubsub_message.ex index 39771ae31c..da99e538a0 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/pubsub_message.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/pubsub_message.ex @@ -21,10 +21,10 @@ defmodule GoogleApi.CloudScheduler.V1.Model.PubsubMessage do ## Attributes - * `attributes` (*type:* `map()`, *default:* `nil`) - Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription. - * `data` (*type:* `String.t`, *default:* `nil`) - The message data field. If this field is empty, the message must contain at least one attribute. + * `attributes` (*type:* `map()`, *default:* `nil`) - Optional. Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription. + * `data` (*type:* `String.t`, *default:* `nil`) - Optional. The message data field. If this field is empty, the message must contain at least one attribute. * `messageId` (*type:* `String.t`, *default:* `nil`) - ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call. - * `orderingKey` (*type:* `String.t`, *default:* `nil`) - If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering). + * `orderingKey` (*type:* `String.t`, *default:* `nil`) - Optional. If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering). * `publishTime` (*type:* `DateTime.t`, *default:* `nil`) - The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. """ diff --git a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/retry_config.ex b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/retry_config.ex index 9d8e255647..caa902ed1e 100644 --- a/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/retry_config.ex +++ b/clients/cloud_scheduler/lib/google_api/cloud_scheduler/v1/model/retry_config.ex @@ -22,10 +22,10 @@ defmodule GoogleApi.CloudScheduler.V1.Model.RetryConfig do ## Attributes * `maxBackoffDuration` (*type:* `String.t`, *default:* `nil`) - The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. - * `maxDoublings` (*type:* `integer()`, *default:* `nil`) - The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the a job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. + * `maxDoublings` (*type:* `integer()`, *default:* `nil`) - The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3, then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this field is 5. * `maxRetryDuration` (*type:* `String.t`, *default:* `nil`) - The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are reached. The default value for max_retry_duration is zero, which means retry duration is unlimited. * `minBackoffDuration` (*type:* `String.t`, *default:* `nil`) - The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. - * `retryCount` (*type:* `integer()`, *default:* `nil`) - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. + * `retryCount` (*type:* `integer()`, *default:* `nil`) - The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If retry_count is 0, a job attempt will not be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. Setting retry_count to 0 does not prevent failed jobs from running according to schedule after the failure. If retry_count is set to a non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first. Values greater than 5 and negative values are not allowed. """ use GoogleApi.Gax.ModelBase