google-cloud-scheduler-v1 0.4.5 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -22,7 +22,8 @@ module Google
22
22
  module Scheduler
23
23
  module V1
24
24
  # Http target. The job will be pushed to the job handler by means of
25
- # an HTTP request via an {::Google::Cloud::Scheduler::V1::HttpTarget#http_method http_method} such as HTTP
25
+ # an HTTP request via an
26
+ # {::Google::Cloud::Scheduler::V1::HttpTarget#http_method http_method} such as HTTP
26
27
  # POST, HTTP GET, etc. The job is acknowledged by means of an HTTP
27
28
  # response code in the range [200 - 299]. A failure to receive a response
28
29
  # constitutes a failed execution. For a redirected request, the response
@@ -53,6 +54,11 @@ module Google
53
54
  # * `User-Agent`: This will be set to `"Google-Cloud-Scheduler"`.
54
55
  # * `X-Google-*`: Google internal use only.
55
56
  # * `X-AppEngine-*`: Google internal use only.
57
+ # * `X-CloudScheduler`: This header will be set to true.
58
+ # * `X-CloudScheduler-JobName`: This header will contain the job name.
59
+ # * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
60
+ # the unix-cron format, this header will contain the job schedule time in
61
+ # RFC3339 UTC "Zulu" format.
56
62
  #
57
63
  # The total size of headers must be less than 80KB.
58
64
  # @!attribute [rw] body
@@ -94,7 +100,8 @@ module Google
94
100
  end
95
101
 
96
102
  # App Engine target. The job will be pushed to a job handler by means
97
- # of an HTTP request via an {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#http_method http_method} such
103
+ # of an HTTP request via an
104
+ # {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#http_method http_method} such
98
105
  # as HTTP POST, HTTP GET, etc. The job is acknowledged by means of an
99
106
  # HTTP response code in the range [200 - 299]. Error 503 is
100
107
  # considered an App Engine system error instead of an application
@@ -132,9 +139,14 @@ module Google
132
139
  # `"AppEngine-Google; (+http://code.google.com/appengine)"` to the
133
140
  # modified `User-Agent`.
134
141
  # * `X-CloudScheduler`: This header will be set to true.
142
+ # * `X-CloudScheduler-JobName`: This header will contain the job name.
143
+ # * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs specified in
144
+ # the unix-cron format, this header will contain the job schedule time in
145
+ # RFC3339 UTC "Zulu" format.
135
146
  #
136
- # If the job has an {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler sets
137
- # the following headers:
147
+ # If the job has an
148
+ # {::Google::Cloud::Scheduler::V1::AppEngineHttpTarget#body body}, Cloud Scheduler
149
+ # sets the following headers:
138
150
  #
139
151
  # * `Content-Type`: By default, the `Content-Type` header is set to
140
152
  # `"application/octet-stream"`. The default can be overridden by explictly
@@ -157,7 +169,8 @@ module Google
157
169
  #
158
170
  # HTTP request body. A request body is allowed only if the HTTP method is
159
171
  # POST or PUT. It will result in invalid argument error to set a body on a
160
- # job with an incompatible {::Google::Cloud::Scheduler::V1::HttpMethod HttpMethod}.
172
+ # job with an incompatible
173
+ # {::Google::Cloud::Scheduler::V1::HttpMethod HttpMethod}.
161
174
  class AppEngineHttpTarget
162
175
  include ::Google::Protobuf::MessageExts
163
176
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -178,7 +191,7 @@ module Google
178
191
  # @return [::String]
179
192
  # Required. The name of the Cloud Pub/Sub topic to which messages will
180
193
  # be published when a job is delivered. The topic name must be in the
181
- # same format as required by PubSub's
194
+ # same format as required by Pub/Sub's
182
195
  # [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest),
183
196
  # for example `projects/PROJECT_ID/topics/TOPIC_ID`.
184
197
  #
@@ -241,7 +254,7 @@ module Google
241
254
  #
242
255
  # Requests can only be sent to a specific instance if
243
256
  # [manual scaling is used in App Engine
244
- # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).
257
+ # Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes).
245
258
  # App Engine Flex does not support instances. For more information, see
246
259
  # [App Engine Standard request
247
260
  # routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed)
@@ -278,7 +291,8 @@ module Google
278
291
  # {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} `+ '.' +`
279
292
  # {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service}
280
293
  #
281
- # * `instance =` {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance}
294
+ # * `instance =`
295
+ # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance}
282
296
  #
283
297
  # * `instance_dot_service =`
284
298
  # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} `+ '.' +`
@@ -294,19 +308,23 @@ module Google
294
308
  # {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service}
295
309
  #
296
310
  #
297
- # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} is empty, then the job will be sent
298
- # to the service which is the default service when the job is attempted.
311
+ # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service} is empty,
312
+ # then the job will be sent to the service which is the default service when
313
+ # the job is attempted.
299
314
  #
300
- # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} is empty, then the job will be sent
301
- # to the version which is the default version when the job is attempted.
315
+ # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version} is empty,
316
+ # then the job will be sent to the version which is the default version when
317
+ # the job is attempted.
302
318
  #
303
- # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is empty, then the job will be
304
- # sent to an instance which is available when the job is attempted.
319
+ # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is
320
+ # empty, then the job will be sent to an instance which is available when the
321
+ # job is attempted.
305
322
  #
306
323
  # If {::Google::Cloud::Scheduler::V1::AppEngineRouting#service service},
307
324
  # {::Google::Cloud::Scheduler::V1::AppEngineRouting#version version}, or
308
- # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is invalid, then the job will be sent
309
- # to the default version of the default service when the job is attempted.
325
+ # {::Google::Cloud::Scheduler::V1::AppEngineRouting#instance instance} is invalid,
326
+ # then the job will be sent to the default version of the default service
327
+ # when the job is attempted.
310
328
  class AppEngineRouting
311
329
  include ::Google::Protobuf::MessageExts
312
330
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
@@ -26,8 +26,6 @@ module Google
26
26
  # service Foo {
27
27
  # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
28
28
  # }
29
- #
30
- # The JSON representation for `Empty` is empty JSON object `{}`.
31
29
  class Empty
32
30
  include ::Google::Protobuf::MessageExts
33
31
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -28,12 +28,14 @@ module Google
28
28
  # [API Design Guide](https://cloud.google.com/apis/design/errors).
29
29
  # @!attribute [rw] code
30
30
  # @return [::Integer]
31
- # The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].
31
+ # The status code, which should be an enum value of
32
+ # [google.rpc.Code][google.rpc.Code].
32
33
  # @!attribute [rw] message
33
34
  # @return [::String]
34
35
  # A developer-facing error message, which should be in English. Any
35
36
  # user-facing error message should be localized and sent in the
36
- # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized by the client.
37
+ # {::Google::Rpc::Status#details google.rpc.Status.details} field, or localized
38
+ # by the client.
37
39
  # @!attribute [rw] details
38
40
  # @return [::Array<::Google::Protobuf::Any>]
39
41
  # A list of messages that carry the error details. There is a common set of
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-scheduler-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.4.5
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-01-11 00:00:00.000000000 Z
11
+ date: 2023-03-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: '0.7'
19
+ version: 0.18.0
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: '0.7'
29
+ version: 0.18.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -44,34 +44,54 @@ dependencies:
44
44
  - - "~>"
45
45
  - !ruby/object:Gem::Version
46
46
  version: '1.0'
47
+ - !ruby/object:Gem::Dependency
48
+ name: google-cloud-location
49
+ requirement: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0.4'
54
+ - - "<"
55
+ - !ruby/object:Gem::Version
56
+ version: 2.a
57
+ type: :runtime
58
+ prerelease: false
59
+ version_requirements: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: '0.4'
64
+ - - "<"
65
+ - !ruby/object:Gem::Version
66
+ version: 2.a
47
67
  - !ruby/object:Gem::Dependency
48
68
  name: google-style
49
69
  requirement: !ruby/object:Gem::Requirement
50
70
  requirements:
51
71
  - - "~>"
52
72
  - !ruby/object:Gem::Version
53
- version: 1.25.1
73
+ version: 1.26.3
54
74
  type: :development
55
75
  prerelease: false
56
76
  version_requirements: !ruby/object:Gem::Requirement
57
77
  requirements:
58
78
  - - "~>"
59
79
  - !ruby/object:Gem::Version
60
- version: 1.25.1
80
+ version: 1.26.3
61
81
  - !ruby/object:Gem::Dependency
62
82
  name: minitest
63
83
  requirement: !ruby/object:Gem::Requirement
64
84
  requirements:
65
85
  - - "~>"
66
86
  - !ruby/object:Gem::Version
67
- version: '5.14'
87
+ version: '5.16'
68
88
  type: :development
69
89
  prerelease: false
70
90
  version_requirements: !ruby/object:Gem::Requirement
71
91
  requirements:
72
92
  - - "~>"
73
93
  - !ruby/object:Gem::Version
74
- version: '5.14'
94
+ version: '5.16'
75
95
  - !ruby/object:Gem::Dependency
76
96
  name: minitest-focus
77
97
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +126,14 @@ dependencies:
106
126
  requirements:
107
127
  - - ">="
108
128
  - !ruby/object:Gem::Version
109
- version: '12.0'
129
+ version: '13.0'
110
130
  type: :development
111
131
  prerelease: false
112
132
  version_requirements: !ruby/object:Gem::Requirement
113
133
  requirements:
114
134
  - - ">="
115
135
  - !ruby/object:Gem::Version
116
- version: '12.0'
136
+ version: '13.0'
117
137
  - !ruby/object:Gem::Dependency
118
138
  name: redcarpet
119
139
  requirement: !ruby/object:Gem::Requirement
@@ -185,7 +205,9 @@ files:
185
205
  - lib/google/cloud/scheduler/v1/target_pb.rb
186
206
  - lib/google/cloud/scheduler/v1/version.rb
187
207
  - proto_docs/README.md
208
+ - proto_docs/google/api/client.rb
188
209
  - proto_docs/google/api/field_behavior.rb
210
+ - proto_docs/google/api/launch_stage.rb
189
211
  - proto_docs/google/api/resource.rb
190
212
  - proto_docs/google/cloud/scheduler/v1/cloudscheduler.rb
191
213
  - proto_docs/google/cloud/scheduler/v1/job.rb
@@ -208,15 +230,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
208
230
  requirements:
209
231
  - - ">="
210
232
  - !ruby/object:Gem::Version
211
- version: '2.5'
233
+ version: '2.6'
212
234
  required_rubygems_version: !ruby/object:Gem::Requirement
213
235
  requirements:
214
236
  - - ">="
215
237
  - !ruby/object:Gem::Version
216
238
  version: '0'
217
239
  requirements: []
218
- rubygems_version: 3.3.4
240
+ rubygems_version: 3.4.2
219
241
  signing_key:
220
242
  specification_version: 4
221
- summary: API Client library for the Cloud Scheduler V1 API
243
+ summary: Creates and manages jobs run on a regular recurring schedule.
222
244
  test_files: []