google-cloud-run-v2 0.4.0 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +6 -6
- data/README.md +3 -3
- data/lib/google/cloud/run/v2/execution_pb.rb +76 -0
- data/lib/google/cloud/run/v2/execution_services_pb.rb +49 -0
- data/lib/google/cloud/run/v2/execution_template_pb.rb +29 -0
- data/lib/google/cloud/run/v2/executions/client.rb +635 -0
- data/lib/google/cloud/run/v2/executions/credentials.rb +47 -0
- data/lib/google/cloud/run/v2/executions/operations.rb +770 -0
- data/lib/google/cloud/run/v2/executions/paths.rb +73 -0
- data/lib/google/cloud/run/v2/executions.rb +50 -0
- data/lib/google/cloud/run/v2/job_pb.rb +104 -0
- data/lib/google/cloud/run/v2/job_services_pb.rb +65 -0
- data/lib/google/cloud/run/v2/jobs/client.rb +1259 -0
- data/lib/google/cloud/run/v2/jobs/credentials.rb +47 -0
- data/lib/google/cloud/run/v2/jobs/operations.rb +770 -0
- data/lib/google/cloud/run/v2/jobs/paths.rb +166 -0
- data/lib/google/cloud/run/v2/jobs.rb +50 -0
- data/lib/google/cloud/run/v2/k8s.min_pb.rb +6 -0
- data/lib/google/cloud/run/v2/revision_services_pb.rb +2 -2
- data/lib/google/cloud/run/v2/revisions/client.rb +2 -2
- data/lib/google/cloud/run/v2/service_services_pb.rb +2 -2
- data/lib/google/cloud/run/v2/services/client.rb +13 -10
- data/lib/google/cloud/run/v2/task_pb.rb +81 -0
- data/lib/google/cloud/run/v2/task_services_pb.rb +47 -0
- data/lib/google/cloud/run/v2/task_template_pb.rb +36 -0
- data/lib/google/cloud/run/v2/tasks/client.rb +512 -0
- data/lib/google/cloud/run/v2/tasks/credentials.rb +47 -0
- data/lib/google/cloud/run/v2/tasks/paths.rb +77 -0
- data/lib/google/cloud/run/v2/tasks.rb +49 -0
- data/lib/google/cloud/run/v2/version.rb +1 -1
- data/lib/google/cloud/run/v2.rb +4 -1
- data/proto_docs/google/cloud/run/v2/execution.rb +223 -0
- data/proto_docs/google/cloud/run/v2/execution_template.rb +76 -0
- data/proto_docs/google/cloud/run/v2/job.rb +308 -0
- data/proto_docs/google/cloud/run/v2/k8s.min.rb +29 -7
- data/proto_docs/google/cloud/run/v2/service.rb +11 -8
- data/proto_docs/google/cloud/run/v2/task.rb +229 -0
- data/proto_docs/google/cloud/run/v2/task_template.rb +66 -0
- data/proto_docs/google/cloud/run/v2/vendor_settings.rb +2 -1
- metadata +29 -2
data/lib/google/cloud/run/v2.rb
CHANGED
@@ -16,8 +16,11 @@
|
|
16
16
|
|
17
17
|
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
18
|
|
19
|
+
require "google/cloud/run/v2/executions"
|
20
|
+
require "google/cloud/run/v2/jobs"
|
19
21
|
require "google/cloud/run/v2/revisions"
|
20
22
|
require "google/cloud/run/v2/services"
|
23
|
+
require "google/cloud/run/v2/tasks"
|
21
24
|
require "google/cloud/run/v2/version"
|
22
25
|
|
23
26
|
module Google
|
@@ -29,7 +32,7 @@ module Google
|
|
29
32
|
# @example
|
30
33
|
#
|
31
34
|
# require "google/cloud/run/v2"
|
32
|
-
# client = ::Google::Cloud::Run::V2::
|
35
|
+
# client = ::Google::Cloud::Run::V2::Executions::Client.new
|
33
36
|
#
|
34
37
|
module V2
|
35
38
|
end
|
@@ -0,0 +1,223 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Run
|
23
|
+
module V2
|
24
|
+
# Request message for obtaining a Execution by its full name.
|
25
|
+
# @!attribute [rw] name
|
26
|
+
# @return [::String]
|
27
|
+
# Required. The full name of the Execution.
|
28
|
+
# Format:
|
29
|
+
# projects/\\{project}/locations/\\{location}/jobs/\\{job}/executions/\\{execution},
|
30
|
+
# where \\{project} can be project id or number.
|
31
|
+
class GetExecutionRequest
|
32
|
+
include ::Google::Protobuf::MessageExts
|
33
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
34
|
+
end
|
35
|
+
|
36
|
+
# Request message for retrieving a list of Executions.
|
37
|
+
# @!attribute [rw] parent
|
38
|
+
# @return [::String]
|
39
|
+
# Required. The Execution from which the Executions should be listed.
|
40
|
+
# To list all Executions across Jobs, use "-" instead of Job name.
|
41
|
+
# Format: projects/\\{project}/locations/\\{location}/jobs/\\{job}, where \\{project}
|
42
|
+
# can be project id or number.
|
43
|
+
# @!attribute [rw] page_size
|
44
|
+
# @return [::Integer]
|
45
|
+
# Maximum number of Executions to return in this call.
|
46
|
+
# @!attribute [rw] page_token
|
47
|
+
# @return [::String]
|
48
|
+
# A page token received from a previous call to ListExecutions.
|
49
|
+
# All other parameters must match.
|
50
|
+
# @!attribute [rw] show_deleted
|
51
|
+
# @return [::Boolean]
|
52
|
+
# If true, returns deleted (but unexpired) resources along with active ones.
|
53
|
+
class ListExecutionsRequest
|
54
|
+
include ::Google::Protobuf::MessageExts
|
55
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
|
+
end
|
57
|
+
|
58
|
+
# Response message containing a list of Executions.
|
59
|
+
# @!attribute [rw] executions
|
60
|
+
# @return [::Array<::Google::Cloud::Run::V2::Execution>]
|
61
|
+
# The resulting list of Executions.
|
62
|
+
# @!attribute [rw] next_page_token
|
63
|
+
# @return [::String]
|
64
|
+
# A token indicating there are more items than page_size. Use it in the next
|
65
|
+
# ListExecutions request to continue.
|
66
|
+
class ListExecutionsResponse
|
67
|
+
include ::Google::Protobuf::MessageExts
|
68
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
69
|
+
end
|
70
|
+
|
71
|
+
# Request message for deleting an Execution.
|
72
|
+
# @!attribute [rw] name
|
73
|
+
# @return [::String]
|
74
|
+
# Required. The name of the Execution to delete.
|
75
|
+
# Format:
|
76
|
+
# projects/\\{project}/locations/\\{location}/jobs/\\{job}/executions/\\{execution},
|
77
|
+
# where \\{project} can be project id or number.
|
78
|
+
# @!attribute [rw] validate_only
|
79
|
+
# @return [::Boolean]
|
80
|
+
# Indicates that the request should be validated without actually
|
81
|
+
# deleting any resources.
|
82
|
+
# @!attribute [rw] etag
|
83
|
+
# @return [::String]
|
84
|
+
# A system-generated fingerprint for this version of the resource.
|
85
|
+
# This may be used to detect modification conflict during updates.
|
86
|
+
class DeleteExecutionRequest
|
87
|
+
include ::Google::Protobuf::MessageExts
|
88
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
89
|
+
end
|
90
|
+
|
91
|
+
# Execution represents the configuration of a single execution. A execution an
|
92
|
+
# immutable resource that references a container image which is run to
|
93
|
+
# completion.
|
94
|
+
# @!attribute [r] name
|
95
|
+
# @return [::String]
|
96
|
+
# Output only. The unique name of this Execution.
|
97
|
+
# @!attribute [r] uid
|
98
|
+
# @return [::String]
|
99
|
+
# Output only. Server assigned unique identifier for the Execution. The value is a UUID4
|
100
|
+
# string and guaranteed to remain unchanged until the resource is deleted.
|
101
|
+
# @!attribute [r] generation
|
102
|
+
# @return [::Integer]
|
103
|
+
# Output only. A number that monotonically increases every time the user
|
104
|
+
# modifies the desired state.
|
105
|
+
# @!attribute [rw] labels
|
106
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
107
|
+
# KRM-style labels for the resource.
|
108
|
+
# User-provided labels are shared with Google's billing system, so they can
|
109
|
+
# be used to filter, or break down billing charges by team, component,
|
110
|
+
# environment, state, etc. For more information, visit
|
111
|
+
# https://cloud.google.com/resource-manager/docs/creating-managing-labels or
|
112
|
+
# https://cloud.google.com/run/docs/configuring/labels
|
113
|
+
# Cloud Run will populate some labels with 'run.googleapis.com' or
|
114
|
+
# 'serving.knative.dev' namespaces. Those labels are read-only, and user
|
115
|
+
# changes will not be preserved.
|
116
|
+
# @!attribute [rw] annotations
|
117
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
118
|
+
# KRM-style annotations for the resource.
|
119
|
+
# @!attribute [r] create_time
|
120
|
+
# @return [::Google::Protobuf::Timestamp]
|
121
|
+
# Output only. Represents time when the execution was acknowledged by the execution
|
122
|
+
# controller. It is not guaranteed to be set in happens-before order across
|
123
|
+
# separate operations.
|
124
|
+
# @!attribute [r] start_time
|
125
|
+
# @return [::Google::Protobuf::Timestamp]
|
126
|
+
# Output only. Represents time when the execution started to run.
|
127
|
+
# It is not guaranteed to be set in happens-before order across separate
|
128
|
+
# operations.
|
129
|
+
# @!attribute [r] completion_time
|
130
|
+
# @return [::Google::Protobuf::Timestamp]
|
131
|
+
# Output only. Represents time when the execution was completed. It is not guaranteed to
|
132
|
+
# be set in happens-before order across separate operations.
|
133
|
+
# @!attribute [r] update_time
|
134
|
+
# @return [::Google::Protobuf::Timestamp]
|
135
|
+
# Output only. The last-modified time.
|
136
|
+
# @!attribute [r] delete_time
|
137
|
+
# @return [::Google::Protobuf::Timestamp]
|
138
|
+
# Output only. For a deleted resource, the deletion time. It is only
|
139
|
+
# populated as a response to a Delete request.
|
140
|
+
# @!attribute [r] expire_time
|
141
|
+
# @return [::Google::Protobuf::Timestamp]
|
142
|
+
# Output only. For a deleted resource, the time after which it will be
|
143
|
+
# permamently deleted. It is only populated as a response to a Delete
|
144
|
+
# request.
|
145
|
+
# @!attribute [rw] launch_stage
|
146
|
+
# @return [::Google::Api::LaunchStage]
|
147
|
+
# Set the launch stage to a preview stage on write to allow use of preview
|
148
|
+
# features in that stage. On read, describes whether the resource uses
|
149
|
+
# preview features. Launch Stages are defined at [Google Cloud Platform
|
150
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
151
|
+
# @!attribute [r] job
|
152
|
+
# @return [::String]
|
153
|
+
# Output only. The name of the parent Job.
|
154
|
+
# @!attribute [r] parallelism
|
155
|
+
# @return [::Integer]
|
156
|
+
# Output only. Specifies the maximum desired number of tasks the execution should
|
157
|
+
# run at any given time. Must be <= task_count. The actual number of
|
158
|
+
# tasks running in steady state will be less than this number when
|
159
|
+
# ((.spec.task_count - .status.successful) < .spec.parallelism), i.e. when
|
160
|
+
# the work left to do is less than max parallelism. More info:
|
161
|
+
# https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
|
162
|
+
# @!attribute [r] task_count
|
163
|
+
# @return [::Integer]
|
164
|
+
# Output only. Specifies the desired number of tasks the execution should run.
|
165
|
+
# Setting to 1 means that parallelism is limited to 1 and the success of
|
166
|
+
# that task signals the success of the execution.
|
167
|
+
# More info:
|
168
|
+
# https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
|
169
|
+
# @!attribute [r] template
|
170
|
+
# @return [::Google::Cloud::Run::V2::TaskTemplate]
|
171
|
+
# Output only. The template used to create tasks for this execution.
|
172
|
+
# @!attribute [r] reconciling
|
173
|
+
# @return [::Boolean]
|
174
|
+
# Output only. Indicates whether the resource's reconciliation is still in progress.
|
175
|
+
# See comments in `Job.reconciling` for additional information on
|
176
|
+
# reconciliation process in Cloud Run.
|
177
|
+
# @!attribute [r] conditions
|
178
|
+
# @return [::Array<::Google::Cloud::Run::V2::Condition>]
|
179
|
+
# Output only. The Condition of this Execution, containing its readiness status, and
|
180
|
+
# detailed error information in case it did not reach the desired state.
|
181
|
+
# @!attribute [r] observed_generation
|
182
|
+
# @return [::Integer]
|
183
|
+
# Output only. The generation of this Execution. See comments in `reconciling` for
|
184
|
+
# additional information on reconciliation process in Cloud Run.
|
185
|
+
# @!attribute [r] running_count
|
186
|
+
# @return [::Integer]
|
187
|
+
# Output only. The number of actively running tasks.
|
188
|
+
# @!attribute [r] succeeded_count
|
189
|
+
# @return [::Integer]
|
190
|
+
# Output only. The number of tasks which reached phase Succeeded.
|
191
|
+
# @!attribute [r] failed_count
|
192
|
+
# @return [::Integer]
|
193
|
+
# Output only. The number of tasks which reached phase Failed.
|
194
|
+
# @!attribute [r] etag
|
195
|
+
# @return [::String]
|
196
|
+
# Output only. A system-generated fingerprint for this version of the
|
197
|
+
# resource. May be used to detect modification conflict during updates.
|
198
|
+
class Execution
|
199
|
+
include ::Google::Protobuf::MessageExts
|
200
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
201
|
+
|
202
|
+
# @!attribute [rw] key
|
203
|
+
# @return [::String]
|
204
|
+
# @!attribute [rw] value
|
205
|
+
# @return [::String]
|
206
|
+
class LabelsEntry
|
207
|
+
include ::Google::Protobuf::MessageExts
|
208
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
209
|
+
end
|
210
|
+
|
211
|
+
# @!attribute [rw] key
|
212
|
+
# @return [::String]
|
213
|
+
# @!attribute [rw] value
|
214
|
+
# @return [::String]
|
215
|
+
class AnnotationsEntry
|
216
|
+
include ::Google::Protobuf::MessageExts
|
217
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
218
|
+
end
|
219
|
+
end
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|
223
|
+
end
|
@@ -0,0 +1,76 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Run
|
23
|
+
module V2
|
24
|
+
# ExecutionTemplate describes the data an execution should have when created
|
25
|
+
# from a template.
|
26
|
+
# @!attribute [rw] labels
|
27
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
28
|
+
# KRM-style labels for the resource.
|
29
|
+
# @!attribute [rw] annotations
|
30
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
31
|
+
# KRM-style annotations for the resource.
|
32
|
+
# @!attribute [rw] parallelism
|
33
|
+
# @return [::Integer]
|
34
|
+
# Specifies the maximum desired number of tasks the execution should run at
|
35
|
+
# given time. Must be <= task_count.
|
36
|
+
# When the job is run, if this field is 0 or unset, the maximum possible
|
37
|
+
# value will be used for that execution.
|
38
|
+
# The actual number of tasks running in steady state will be less than this
|
39
|
+
# number when there are fewer tasks waiting to be completed remaining,
|
40
|
+
# i.e. when the work left to do is less than max parallelism.
|
41
|
+
# @!attribute [rw] task_count
|
42
|
+
# @return [::Integer]
|
43
|
+
# Specifies the desired number of tasks the execution should run.
|
44
|
+
# Setting to 1 means that parallelism is limited to 1 and the success of
|
45
|
+
# that task signals the success of the execution.
|
46
|
+
# More info:
|
47
|
+
# https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/
|
48
|
+
# @!attribute [rw] template
|
49
|
+
# @return [::Google::Cloud::Run::V2::TaskTemplate]
|
50
|
+
# Required. Describes the task(s) that will be created when executing an execution.
|
51
|
+
class ExecutionTemplate
|
52
|
+
include ::Google::Protobuf::MessageExts
|
53
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
54
|
+
|
55
|
+
# @!attribute [rw] key
|
56
|
+
# @return [::String]
|
57
|
+
# @!attribute [rw] value
|
58
|
+
# @return [::String]
|
59
|
+
class LabelsEntry
|
60
|
+
include ::Google::Protobuf::MessageExts
|
61
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
62
|
+
end
|
63
|
+
|
64
|
+
# @!attribute [rw] key
|
65
|
+
# @return [::String]
|
66
|
+
# @!attribute [rw] value
|
67
|
+
# @return [::String]
|
68
|
+
class AnnotationsEntry
|
69
|
+
include ::Google::Protobuf::MessageExts
|
70
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
@@ -0,0 +1,308 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2022 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Run
|
23
|
+
module V2
|
24
|
+
# Request message for creating a Job.
|
25
|
+
# @!attribute [rw] parent
|
26
|
+
# @return [::String]
|
27
|
+
# Required. The location and project in which this Job should be created.
|
28
|
+
# Format: projects/\\{project}/locations/\\{location}, where \\{project} can be
|
29
|
+
# project id or number.
|
30
|
+
# @!attribute [rw] job
|
31
|
+
# @return [::Google::Cloud::Run::V2::Job]
|
32
|
+
# Required. The Job instance to create.
|
33
|
+
# @!attribute [rw] job_id
|
34
|
+
# @return [::String]
|
35
|
+
# Required. The unique identifier for the Job. The name of the job becomes
|
36
|
+
# \\{parent}/jobs/\\{job_id}.
|
37
|
+
# @!attribute [rw] validate_only
|
38
|
+
# @return [::Boolean]
|
39
|
+
# Indicates that the request should be validated and default values
|
40
|
+
# populated, without persisting the request or creating any resources.
|
41
|
+
class CreateJobRequest
|
42
|
+
include ::Google::Protobuf::MessageExts
|
43
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
44
|
+
end
|
45
|
+
|
46
|
+
# Request message for obtaining a Job by its full name.
|
47
|
+
# @!attribute [rw] name
|
48
|
+
# @return [::String]
|
49
|
+
# Required. The full name of the Job.
|
50
|
+
# Format: projects/\\{project}/locations/\\{location}/jobs/\\{job}, where \\{project}
|
51
|
+
# can be project id or number.
|
52
|
+
class GetJobRequest
|
53
|
+
include ::Google::Protobuf::MessageExts
|
54
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
55
|
+
end
|
56
|
+
|
57
|
+
# Request message for updating a Job.
|
58
|
+
# @!attribute [rw] job
|
59
|
+
# @return [::Google::Cloud::Run::V2::Job]
|
60
|
+
# Required. The Job to be updated.
|
61
|
+
# @!attribute [rw] validate_only
|
62
|
+
# @return [::Boolean]
|
63
|
+
# Indicates that the request should be validated and default values
|
64
|
+
# populated, without persisting the request or updating any resources.
|
65
|
+
# @!attribute [rw] allow_missing
|
66
|
+
# @return [::Boolean]
|
67
|
+
# If set to true, and if the Job does not exist, it will create a new
|
68
|
+
# one. Caller must have both create and update permissions for this call if
|
69
|
+
# this is set to true.
|
70
|
+
class UpdateJobRequest
|
71
|
+
include ::Google::Protobuf::MessageExts
|
72
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
73
|
+
end
|
74
|
+
|
75
|
+
# Request message for retrieving a list of Jobs.
|
76
|
+
# @!attribute [rw] parent
|
77
|
+
# @return [::String]
|
78
|
+
# Required. The location and project to list resources on.
|
79
|
+
# Format: projects/\\{project}/locations/\\{location}, where \\{project} can be
|
80
|
+
# project id or number.
|
81
|
+
# @!attribute [rw] page_size
|
82
|
+
# @return [::Integer]
|
83
|
+
# Maximum number of Jobs to return in this call.
|
84
|
+
# @!attribute [rw] page_token
|
85
|
+
# @return [::String]
|
86
|
+
# A page token received from a previous call to ListJobs.
|
87
|
+
# All other parameters must match.
|
88
|
+
# @!attribute [rw] show_deleted
|
89
|
+
# @return [::Boolean]
|
90
|
+
# If true, returns deleted (but unexpired) resources along with active ones.
|
91
|
+
class ListJobsRequest
|
92
|
+
include ::Google::Protobuf::MessageExts
|
93
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
94
|
+
end
|
95
|
+
|
96
|
+
# Response message containing a list of Jobs.
|
97
|
+
# @!attribute [rw] jobs
|
98
|
+
# @return [::Array<::Google::Cloud::Run::V2::Job>]
|
99
|
+
# The resulting list of Jobs.
|
100
|
+
# @!attribute [rw] next_page_token
|
101
|
+
# @return [::String]
|
102
|
+
# A token indicating there are more items than page_size. Use it in the next
|
103
|
+
# ListJobs request to continue.
|
104
|
+
class ListJobsResponse
|
105
|
+
include ::Google::Protobuf::MessageExts
|
106
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
107
|
+
end
|
108
|
+
|
109
|
+
# Request message to delete a Job by its full name.
|
110
|
+
# @!attribute [rw] name
|
111
|
+
# @return [::String]
|
112
|
+
# Required. The full name of the Job.
|
113
|
+
# Format: projects/\\{project}/locations/\\{location}/jobs/\\{job}, where \\{project}
|
114
|
+
# can be project id or number.
|
115
|
+
# @!attribute [rw] validate_only
|
116
|
+
# @return [::Boolean]
|
117
|
+
# Indicates that the request should be validated without actually
|
118
|
+
# deleting any resources.
|
119
|
+
# @!attribute [rw] etag
|
120
|
+
# @return [::String]
|
121
|
+
# A system-generated fingerprint for this version of the
|
122
|
+
# resource. May be used to detect modification conflict during updates.
|
123
|
+
class DeleteJobRequest
|
124
|
+
include ::Google::Protobuf::MessageExts
|
125
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
126
|
+
end
|
127
|
+
|
128
|
+
# Request message to create a new Execution of a Job.
|
129
|
+
# @!attribute [rw] name
|
130
|
+
# @return [::String]
|
131
|
+
# Required. The full name of the Job.
|
132
|
+
# Format: projects/\\{project}/locations/\\{location}/jobs/\\{job}, where \\{project}
|
133
|
+
# can be project id or number.
|
134
|
+
# @!attribute [rw] validate_only
|
135
|
+
# @return [::Boolean]
|
136
|
+
# Indicates that the request should be validated without actually
|
137
|
+
# deleting any resources.
|
138
|
+
# @!attribute [rw] etag
|
139
|
+
# @return [::String]
|
140
|
+
# A system-generated fingerprint for this version of the
|
141
|
+
# resource. May be used to detect modification conflict during updates.
|
142
|
+
class RunJobRequest
|
143
|
+
include ::Google::Protobuf::MessageExts
|
144
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
145
|
+
end
|
146
|
+
|
147
|
+
# Job represents the configuration of a single job. A job an immutable resource
|
148
|
+
# that references a container image which is run to completion.
|
149
|
+
# @!attribute [rw] name
|
150
|
+
# @return [::String]
|
151
|
+
# The fully qualified name of this Job.
|
152
|
+
#
|
153
|
+
# Format:
|
154
|
+
# projects/\\{project}/locations/\\{location}/jobs/\\{job}
|
155
|
+
# @!attribute [r] uid
|
156
|
+
# @return [::String]
|
157
|
+
# Output only. Server assigned unique identifier for the Execution. The value is a UUID4
|
158
|
+
# string and guaranteed to remain unchanged until the resource is deleted.
|
159
|
+
# @!attribute [r] generation
|
160
|
+
# @return [::Integer]
|
161
|
+
# Output only. A number that monotonically increases every time the user
|
162
|
+
# modifies the desired state.
|
163
|
+
# @!attribute [rw] labels
|
164
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
165
|
+
# KRM-style labels for the resource.
|
166
|
+
# User-provided labels are shared with Google's billing system, so they can
|
167
|
+
# be used to filter, or break down billing charges by team, component,
|
168
|
+
# environment, state, etc. For more information, visit
|
169
|
+
# https://cloud.google.com/resource-manager/docs/creating-managing-labels or
|
170
|
+
# https://cloud.google.com/run/docs/configuring/labels
|
171
|
+
# Cloud Run will populate some labels with 'run.googleapis.com' or
|
172
|
+
# 'serving.knative.dev' namespaces. Those labels are read-only, and user
|
173
|
+
# changes will not be preserved.
|
174
|
+
# @!attribute [rw] annotations
|
175
|
+
# @return [::Google::Protobuf::Map{::String => ::String}]
|
176
|
+
# KRM-style annotations for the resource. Unstructured key value map that may
|
177
|
+
# be set by external tools to store and arbitrary metadata.
|
178
|
+
# They are not queryable and should be preserved
|
179
|
+
# when modifying objects. Cloud Run will populate some annotations using
|
180
|
+
# 'run.googleapis.com' or 'serving.knative.dev' namespaces. This field
|
181
|
+
# follows Kubernetes annotations' namespacing, limits, and rules. More info:
|
182
|
+
# https://kubernetes.io/docs/user-guide/annotations
|
183
|
+
# @!attribute [r] create_time
|
184
|
+
# @return [::Google::Protobuf::Timestamp]
|
185
|
+
# Output only. The creation time.
|
186
|
+
# @!attribute [r] update_time
|
187
|
+
# @return [::Google::Protobuf::Timestamp]
|
188
|
+
# Output only. The last-modified time.
|
189
|
+
# @!attribute [r] delete_time
|
190
|
+
# @return [::Google::Protobuf::Timestamp]
|
191
|
+
# Output only. The deletion time.
|
192
|
+
# @!attribute [r] expire_time
|
193
|
+
# @return [::Google::Protobuf::Timestamp]
|
194
|
+
# Output only. For a deleted resource, the time after which it will be
|
195
|
+
# permamently deleted.
|
196
|
+
# @!attribute [r] creator
|
197
|
+
# @return [::String]
|
198
|
+
# Output only. Email address of the authenticated creator.
|
199
|
+
# @!attribute [r] last_modifier
|
200
|
+
# @return [::String]
|
201
|
+
# Output only. Email address of the last authenticated modifier.
|
202
|
+
# @!attribute [rw] client
|
203
|
+
# @return [::String]
|
204
|
+
# Arbitrary identifier for the API client.
|
205
|
+
# @!attribute [rw] client_version
|
206
|
+
# @return [::String]
|
207
|
+
# Arbitrary version identifier for the API client.
|
208
|
+
# @!attribute [rw] launch_stage
|
209
|
+
# @return [::Google::Api::LaunchStage]
|
210
|
+
# The launch stage as defined by [Google Cloud Platform
|
211
|
+
# Launch Stages](https://cloud.google.com/terms/launch-stages).
|
212
|
+
# Cloud Run supports `ALPHA`, `BETA`, and `GA`. If no value is specified, GA
|
213
|
+
# is assumed.
|
214
|
+
# @!attribute [rw] binary_authorization
|
215
|
+
# @return [::Google::Cloud::Run::V2::BinaryAuthorization]
|
216
|
+
# Settings for the Binary Authorization feature.
|
217
|
+
# @!attribute [rw] template
|
218
|
+
# @return [::Google::Cloud::Run::V2::ExecutionTemplate]
|
219
|
+
# Required. The template used to create executions for this Job.
|
220
|
+
# @!attribute [r] observed_generation
|
221
|
+
# @return [::Integer]
|
222
|
+
# Output only. The generation of this Job. See comments in `reconciling` for additional
|
223
|
+
# information on reconciliation process in Cloud Run.
|
224
|
+
# @!attribute [r] terminal_condition
|
225
|
+
# @return [::Google::Cloud::Run::V2::Condition]
|
226
|
+
# Output only. The Condition of this Job, containing its readiness status, and
|
227
|
+
# detailed error information in case it did not reach the desired state.
|
228
|
+
# @!attribute [r] conditions
|
229
|
+
# @return [::Array<::Google::Cloud::Run::V2::Condition>]
|
230
|
+
# Output only. The Conditions of all other associated sub-resources. They contain
|
231
|
+
# additional diagnostics information in case the Job does not reach its
|
232
|
+
# desired state. See comments in `reconciling` for additional information on
|
233
|
+
# reconciliation process in Cloud Run.
|
234
|
+
# @!attribute [r] execution_count
|
235
|
+
# @return [::Integer]
|
236
|
+
# Output only. Number of executions created for this job.
|
237
|
+
# @!attribute [r] latest_created_execution
|
238
|
+
# @return [::Google::Cloud::Run::V2::ExecutionReference]
|
239
|
+
# Output only. Name of the last created execution.
|
240
|
+
# @!attribute [r] reconciling
|
241
|
+
# @return [::Boolean]
|
242
|
+
# Output only. Returns true if the Job is currently being acted upon by the system to
|
243
|
+
# bring it into the desired state.
|
244
|
+
#
|
245
|
+
# When a new Job is created, or an existing one is updated, Cloud Run
|
246
|
+
# will asynchronously perform all necessary steps to bring the Job to the
|
247
|
+
# desired state. This process is called reconciliation.
|
248
|
+
# While reconciliation is in process, `observed_generation` and
|
249
|
+
# `latest_succeeded_execution`, will have transient values that might
|
250
|
+
# mismatch the intended state: Once reconciliation is over (and this field is
|
251
|
+
# false), there are two possible outcomes: reconciliation succeeded and the
|
252
|
+
# state matches the Job, or there was an error, and reconciliation failed.
|
253
|
+
# This state can be found in `terminal_condition.state`.
|
254
|
+
#
|
255
|
+
# If reconciliation succeeded, the following fields will match:
|
256
|
+
# `observed_generation` and `generation`, `latest_succeeded_execution` and
|
257
|
+
# `latest_created_execution`.
|
258
|
+
#
|
259
|
+
# If reconciliation failed, `observed_generation` and
|
260
|
+
# `latest_succeeded_execution` will have the state of the last succeeded
|
261
|
+
# execution or empty for newly created Job. Additional information on the
|
262
|
+
# failure can be found in `terminal_condition` and `conditions`.
|
263
|
+
# @!attribute [r] etag
|
264
|
+
# @return [::String]
|
265
|
+
# Output only. A system-generated fingerprint for this version of the
|
266
|
+
# resource. May be used to detect modification conflict during updates.
|
267
|
+
class Job
|
268
|
+
include ::Google::Protobuf::MessageExts
|
269
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
270
|
+
|
271
|
+
# @!attribute [rw] key
|
272
|
+
# @return [::String]
|
273
|
+
# @!attribute [rw] value
|
274
|
+
# @return [::String]
|
275
|
+
class LabelsEntry
|
276
|
+
include ::Google::Protobuf::MessageExts
|
277
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
278
|
+
end
|
279
|
+
|
280
|
+
# @!attribute [rw] key
|
281
|
+
# @return [::String]
|
282
|
+
# @!attribute [rw] value
|
283
|
+
# @return [::String]
|
284
|
+
class AnnotationsEntry
|
285
|
+
include ::Google::Protobuf::MessageExts
|
286
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
287
|
+
end
|
288
|
+
end
|
289
|
+
|
290
|
+
# Reference to an Execution. Use /Executions.GetExecution with the given name
|
291
|
+
# to get full execution including the latest status.
|
292
|
+
# @!attribute [rw] name
|
293
|
+
# @return [::String]
|
294
|
+
# Name of the execution.
|
295
|
+
# @!attribute [rw] create_time
|
296
|
+
# @return [::Google::Protobuf::Timestamp]
|
297
|
+
# Creation timestamp of the execution.
|
298
|
+
# @!attribute [rw] completion_time
|
299
|
+
# @return [::Google::Protobuf::Timestamp]
|
300
|
+
# Creation timestamp of the execution.
|
301
|
+
class ExecutionReference
|
302
|
+
include ::Google::Protobuf::MessageExts
|
303
|
+
extend ::Google::Protobuf::MessageExts::ClassMethods
|
304
|
+
end
|
305
|
+
end
|
306
|
+
end
|
307
|
+
end
|
308
|
+
end
|