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
|
<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="developerconnect_v1.html">Developer Connect API</a> . <a href="developerconnect_v1.projects.html">projects</a> . <a href="developerconnect_v1.projects.locations.html">locations</a> . <a href="developerconnect_v1.projects.locations.insightsConfigs.html">insightsConfigs</a> . <a href="developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html">deploymentEvents</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">Gets a single Deployment Event.</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">Lists Deployment Events in a given insights config.</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>Gets a single Deployment Event.
Args:
name: string, Required. The name of the deployment event to retrieve. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid} (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The DeploymentEvent resource represents the deployment of the artifact within the InsightsConfig resource.
"artifactDeployments": [ # Output only. The artifact deployments of the DeploymentEvent. Each artifact deployment contains the artifact uri and the runtime configuration uri. For GKE, this would be all the containers images that are deployed in the pod.
{ # The ArtifactDeployment resource represents the deployment of the artifact within the InsightsConfig resource.
"artifactAlias": "A String", # Output only. The artifact alias in the deployment spec, with Tag/SHA. e.g. us-docker.pkg.dev/my-project/my-repo/image:1.0.0
"artifactReference": "A String", # Output only. The artifact that is deployed.
"containerStatusSummary": "A String", # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. "Waiting-ImagePullBackOff : 3"
"deployTime": "A String", # Output only. The time at which the deployment was deployed.
"id": "A String", # Output only. Unique identifier of `ArtifactDeployment`.
"sourceCommitUris": [ # Output only. The source commits at which this artifact was built. Extracted from provenance.
"A String",
],
"undeployTime": "A String", # Output only. The time at which the deployment was undeployed, all artifacts are considered undeployed once this time is set.
},
],
"createTime": "A String", # Output only. The create time of the DeploymentEvent.
"deployTime": "A String", # Output only. The time at which the DeploymentEvent was deployed. This would be the min of all ArtifactDeployment deploy_times.
"name": "A String", # Identifier. The name of the DeploymentEvent. This name is provided by DCI. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}
"runtimeConfig": { # RuntimeConfig represents the runtimes where the application is deployed. # Output only. The runtime configurations where the DeploymentEvent happened.
"appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
"apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
"criticality": "A String", # Output only. The criticality of the App Hub Service.
"environment": "A String", # Output only. The environment of the App Hub Service.
},
"appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
"criticality": "A String", # Output only. The criticality of the App Hub Workload.
"environment": "A String", # Output only. The environment of the App Hub Workload.
"workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.
},
"gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime.
"cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
"deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
},
"googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
"serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
},
"state": "A String", # Output only. The state of the Runtime.
"uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
},
"runtimeDeploymentUri": "A String", # Output only. The runtime assigned URI of the DeploymentEvent. For GKE, this is the fully qualified replica set uri. e.g. container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/apps/replicasets/{replica-set-id} For Cloud Run, this is the revision name.
"state": "A String", # Output only. The state of the DeploymentEvent.
"undeployTime": "A String", # Output only. The time at which the DeploymentEvent was undeployed, all artifacts are considered undeployed once this time is set. This would be the max of all ArtifactDeployment undeploy_times. If any ArtifactDeployment is still active (i.e. does not have an undeploy_time), this field will be empty.
"updateTime": "A String", # Output only. The update time of the DeploymentEvent.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Deployment Events in a given insights config.
Args:
parent: string, Required. The parent insights config that owns this collection of deployment events. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config} (required)
filter: string, Optional. Filter expression that matches a subset of the DeploymentEvents. https://google.aip.dev/160.
pageSize: integer, Optional. The maximum number of deployment events to return. The service may return fewer than this value. If unspecified, at most 50 deployment events will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListDeploymentEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDeploymentEvents` 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 to listing DeploymentEvents.
"deploymentEvents": [ # The list of DeploymentEvents.
{ # The DeploymentEvent resource represents the deployment of the artifact within the InsightsConfig resource.
"artifactDeployments": [ # Output only. The artifact deployments of the DeploymentEvent. Each artifact deployment contains the artifact uri and the runtime configuration uri. For GKE, this would be all the containers images that are deployed in the pod.
{ # The ArtifactDeployment resource represents the deployment of the artifact within the InsightsConfig resource.
"artifactAlias": "A String", # Output only. The artifact alias in the deployment spec, with Tag/SHA. e.g. us-docker.pkg.dev/my-project/my-repo/image:1.0.0
"artifactReference": "A String", # Output only. The artifact that is deployed.
"containerStatusSummary": "A String", # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. "Waiting-ImagePullBackOff : 3"
"deployTime": "A String", # Output only. The time at which the deployment was deployed.
"id": "A String", # Output only. Unique identifier of `ArtifactDeployment`.
"sourceCommitUris": [ # Output only. The source commits at which this artifact was built. Extracted from provenance.
"A String",
],
"undeployTime": "A String", # Output only. The time at which the deployment was undeployed, all artifacts are considered undeployed once this time is set.
},
],
"createTime": "A String", # Output only. The create time of the DeploymentEvent.
"deployTime": "A String", # Output only. The time at which the DeploymentEvent was deployed. This would be the min of all ArtifactDeployment deploy_times.
"name": "A String", # Identifier. The name of the DeploymentEvent. This name is provided by DCI. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}
"runtimeConfig": { # RuntimeConfig represents the runtimes where the application is deployed. # Output only. The runtime configurations where the DeploymentEvent happened.
"appHubService": { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
"apphubService": "A String", # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
"criticality": "A String", # Output only. The criticality of the App Hub Service.
"environment": "A String", # Output only. The environment of the App Hub Service.
},
"appHubWorkload": { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
"criticality": "A String", # Output only. The criticality of the App Hub Workload.
"environment": "A String", # Output only. The environment of the App Hub Workload.
"workload": "A String", # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.
},
"gkeWorkload": { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime.
"cluster": "A String", # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
"deployment": "A String", # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
},
"googleCloudRun": { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
"serviceUri": "A String", # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
},
"state": "A String", # Output only. The state of the Runtime.
"uri": "A String", # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
},
"runtimeDeploymentUri": "A String", # Output only. The runtime assigned URI of the DeploymentEvent. For GKE, this is the fully qualified replica set uri. e.g. container.googleapis.com/projects/{project}/locations/{location}/clusters/{cluster}/k8s/namespaces/{namespace}/apps/replicasets/{replica-set-id} For Cloud Run, this is the revision name.
"state": "A String", # Output only. The state of the DeploymentEvent.
"undeployTime": "A String", # Output only. The time at which the DeploymentEvent was undeployed, all artifacts are considered undeployed once this time is set. This would be the max of all ArtifactDeployment undeploy_times. If any ArtifactDeployment is still active (i.e. does not have an undeploy_time), this field will be empty.
"updateTime": "A String", # Output only. The update time of the DeploymentEvent.
},
],
"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.
}</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>
|
