1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="gkehub_v1beta.html">GKE Hub API</a> . <a href="gkehub_v1beta.projects.html">projects</a> . <a href="gkehub_v1beta.projects.locations.html">locations</a> . <a href="gkehub_v1beta.projects.locations.rollouts.html">rollouts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve a single rollout.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Retrieve the list of all rollouts.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Retrieve a single rollout.
Args:
name: string, Required. The name of the rollout to retrieve. projects/{project}/locations/{location}/rollouts/{rollout} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Rollout contains the Rollout metadata and configuration.
"completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
"createTime": "A String", # Output only. The timestamp at which the Rollout was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout.
"etag": "A String", # Output only. etag of the Rollout Ex. abc1234
"excludedClusters": [ # Optional. Output only. The excluded clusters from the rollout.
{ # An excluded cluster from the rollout.
"membership": "A String", # Output only. The name of the fleet Membership resource associated to the excluded cluster.
"reason": "A String", # Output only. The reason for excluding the cluster from the rollout.
},
],
"feature": { # Feature config to use for Rollout. # Optional. Feature config to use for Rollout.
"binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Configuration for Binary Authorization.
"evaluationMode": "A String", # Optional. Mode of operation for binauthz policy evaluation.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to audit. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Configuration for Security Posture.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
},
"labels": { # Optional. Labels for this Rollout.
"a_key": "A String",
},
"membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
"a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
"lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
"stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
"targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
{ # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
"cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters/. I.e. for GKE clusters, it is formatted as: //container.googleapis.com/projects//locations//clusters/. For GDCE, it is formatted as: //edgecontainer.googleapis.com/projects//locations//clusters/.
"nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters//nodePools/.
"operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
"reason": "A String", # Optional. Output only. A human-readable description of the current status.
"state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
},
],
},
},
"name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
"rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. Empty for user initiated rollouts.
"schedule": { # Schedule represents the schedule of the Rollout. # Output only. The schedule of the Rollout.
"waves": [ # Output only. The schedule of each wave in the Rollout.
{ # WaveSchedule represents the schedule of a single rollout wave.
"waveEndTime": "A String", # Output only. The time at which the wave ends.
"waveNumber": 42, # Output only. The wave number to which this schedule applies.
"waveStartTime": "A String", # Output only. The time at which the wave starts.
},
],
},
"stages": [ # Output only. The stages of the Rollout. Note: this is only populated for google-initiated rollouts.
{ # Stage represents a single stage in the Rollout.
"endTime": "A String", # Optional. Output only. The time at which the wave ended.
"soakDuration": "A String", # Optional. Duration to soak after this wave before starting the next wave.
"stageNumber": 42, # Output only. The wave number to which this status applies.
"startTime": "A String", # Optional. Output only. The time at which the wave started.
"state": "A String", # Output only. The state of the wave.
},
],
"state": "A String", # Output only. State specifies various states of the Rollout.
"stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout was last updated.
"versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters. Note: Currently for GDCE clusters only.
"desiredVersion": "A String", # Optional. Desired version of the component.
"type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Retrieve the list of all rollouts.
Args:
parent: string, Required. The parent, which owns this collection of rollout. Format: projects/{project}/locations/{location} (required)
filter: string, Optional. Lists Rollouts that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
pageSize: integer, The maximum number of rollout to return. The service may return fewer than this value. If unspecified, at most 50 rollouts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, A page token, received from a previous `ListRollouts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollouts` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for listing rollouts.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"rollouts": [ # The rollouts from the specified parent resource.
{ # Rollout contains the Rollout metadata and configuration.
"completeTime": "A String", # Output only. The timestamp at which the Rollout was completed.
"createTime": "A String", # Output only. The timestamp at which the Rollout was created.
"deleteTime": "A String", # Output only. The timestamp at the Rollout was deleted.
"displayName": "A String", # Optional. Human readable display name of the Rollout.
"etag": "A String", # Output only. etag of the Rollout Ex. abc1234
"excludedClusters": [ # Optional. Output only. The excluded clusters from the rollout.
{ # An excluded cluster from the rollout.
"membership": "A String", # Output only. The name of the fleet Membership resource associated to the excluded cluster.
"reason": "A String", # Output only. The reason for excluding the cluster from the rollout.
},
],
"feature": { # Feature config to use for Rollout. # Optional. Feature config to use for Rollout.
"binaryAuthorizationConfig": { # BinaryAuthorizationConfig defines the fleet level configuration of binary authorization feature. # Optional. Configuration for Binary Authorization.
"evaluationMode": "A String", # Optional. Mode of operation for binauthz policy evaluation.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to audit. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Optional. Configuration for Security Posture.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
},
"labels": { # Optional. Labels for this Rollout.
"a_key": "A String",
},
"membershipStates": { # Output only. States of upgrading control plane or node pool targets of a single cluster (GKE Hub membership) that's part of this Rollout. The key is the membership name of the cluster. The value is the state of the cluster.
"a_key": { # Metadata about single cluster (GKE Hub membership) that's part of this Rollout.
"lastUpdateTime": "A String", # Optional. Output only. The time this status and any related Rollout-specific details for the membership were updated.
"stageAssignment": 42, # Output only. The stage assignment of this cluster in this rollout.
"targets": [ # Output only. The targets of the rollout - clusters or node pools that are being upgraded. All targets belongs to the same cluster, identified by the membership name (key of membership_states map).
{ # Metadata about the status of targets (clusters or node pools) involved in the Rollout.
"cluster": "A String", # Optional. Output only. The resource link of the Cluster resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters/. I.e. for GKE clusters, it is formatted as: //container.googleapis.com/projects//locations//clusters/. For GDCE, it is formatted as: //edgecontainer.googleapis.com/projects//locations//clusters/.
"nodePool": "A String", # Optional. Output only. The resource link of the NodePool resource upgraded in this Rollout. It is formatted as: ///projects//locations//clusters//nodePools/.
"operation": "A String", # Optional. Output only. The operation resource name performing the mutation.
"reason": "A String", # Optional. Output only. A human-readable description of the current status.
"state": "A String", # Output only. The high-level, machine-readable status of this Rollout for the target.
},
],
},
},
"name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.
"rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. Empty for user initiated rollouts.
"schedule": { # Schedule represents the schedule of the Rollout. # Output only. The schedule of the Rollout.
"waves": [ # Output only. The schedule of each wave in the Rollout.
{ # WaveSchedule represents the schedule of a single rollout wave.
"waveEndTime": "A String", # Output only. The time at which the wave ends.
"waveNumber": 42, # Output only. The wave number to which this schedule applies.
"waveStartTime": "A String", # Output only. The time at which the wave starts.
},
],
},
"stages": [ # Output only. The stages of the Rollout. Note: this is only populated for google-initiated rollouts.
{ # Stage represents a single stage in the Rollout.
"endTime": "A String", # Optional. Output only. The time at which the wave ended.
"soakDuration": "A String", # Optional. Duration to soak after this wave before starting the next wave.
"stageNumber": 42, # Output only. The wave number to which this status applies.
"startTime": "A String", # Optional. Output only. The time at which the wave started.
"state": "A String", # Output only. The state of the wave.
},
],
"state": "A String", # Output only. State specifies various states of the Rollout.
"stateReason": "A String", # Output only. A human-readable description explaining the reason for the current state.
"uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all Rollout resources. If a Rollout resource is deleted and another resource with the same name is created, it gets a different uid.
"updateTime": "A String", # Output only. The timestamp at which the Rollout was last updated.
"versionUpgrade": { # Config for version upgrade of clusters. # Optional. Config for version upgrade of clusters. Note: Currently for GDCE clusters only.
"desiredVersion": "A String", # Optional. Desired version of the component.
"type": "A String", # Optional. Type of version upgrade specifies which component should be upgraded.
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
