Debian Codegraph @

docs/dyn/developerconnect_v1.projects.locations.insightsConfigs.deploymentEvents.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <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>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82 <p class="firstline">Gets a single Deployment Event.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Lists Deployment Events in a given insights config.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets a single Deployment Event.
98
99 Args:
100 name: string, Required. The name of the deployment event to retrieve. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid} (required)
101 x__xgafv: string, V1 error format.
102 Allowed values
103 1 - v1 error format
104 2 - v2 error format
105
106 Returns:
107 An object of the form:
108
109 { # The DeploymentEvent resource represents the deployment of the artifact within the InsightsConfig resource.
110 &quot;artifactDeployments&quot;: [ # 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.
111 { # The ArtifactDeployment resource represents the deployment of the artifact within the InsightsConfig resource.
112 &quot;artifactAlias&quot;: &quot;A String&quot;, # 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
113 &quot;artifactReference&quot;: &quot;A String&quot;, # Output only. The artifact that is deployed.
114 &quot;containerStatusSummary&quot;: &quot;A String&quot;, # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. &quot;Waiting-ImagePullBackOff : 3&quot;
115 &quot;deployTime&quot;: &quot;A String&quot;, # Output only. The time at which the deployment was deployed.
116 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier of `ArtifactDeployment`.
117 &quot;sourceCodeUris&quot;: [ # Output only. The URIs of the source code, if available. For Cloud Run source deploy for example: `gs://my-bucket/my-folder/1234567890.abcde-fdbe.zip#1234567890`
118 &quot;A String&quot;,
119 ],
120 &quot;sourceCommitUris&quot;: [ # Output only. The source commits at which this artifact was built. Extracted from provenance.
121 &quot;A String&quot;,
122 ],
123 &quot;undeployTime&quot;: &quot;A String&quot;, # Output only. The time at which the deployment was undeployed, all artifacts are considered undeployed once this time is set.
124 },
125 ],
126 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time of the DeploymentEvent.
127 &quot;deployTime&quot;: &quot;A String&quot;, # Output only. The time at which the DeploymentEvent was deployed. This would be the min of all ArtifactDeployment deploy_times.
128 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the DeploymentEvent. This name is provided by Developer Connect insights. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}
129 &quot;runtimeConfig&quot;: { # RuntimeConfig represents the runtimes where the application is deployed. # Output only. The runtime configurations where the DeploymentEvent happened.
130 &quot;appHubService&quot;: { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
131 &quot;apphubService&quot;: &quot;A String&quot;, # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
132 &quot;criticality&quot;: &quot;A String&quot;, # Output only. The criticality of the App Hub Service.
133 &quot;environment&quot;: &quot;A String&quot;, # Output only. The environment of the App Hub Service.
134 },
135 &quot;appHubWorkload&quot;: { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
136 &quot;criticality&quot;: &quot;A String&quot;, # Output only. The criticality of the App Hub Workload.
137 &quot;environment&quot;: &quot;A String&quot;, # Output only. The environment of the App Hub Workload.
138 &quot;workload&quot;: &quot;A String&quot;, # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.
139 },
140 &quot;gkeWorkload&quot;: { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime.
141 &quot;cluster&quot;: &quot;A String&quot;, # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
142 &quot;deployment&quot;: &quot;A String&quot;, # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
143 },
144 &quot;googleCloudRun&quot;: { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
145 &quot;serviceUri&quot;: &quot;A String&quot;, # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
146 },
147 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the Runtime.
148 &quot;uri&quot;: &quot;A String&quot;, # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
149 },
150 &quot;runtimeDeploymentUri&quot;: &quot;A String&quot;, # 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.
151 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the DeploymentEvent.
152 &quot;undeployTime&quot;: &quot;A String&quot;, # 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.
153 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time of the DeploymentEvent.
154 }</pre>
155 </div>
156
157 <div class="method">
158 <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
159 <pre>Lists Deployment Events in a given insights config.
160
161 Args:
162 parent: string, Required. The parent insights config that owns this collection of deployment events. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config} (required)
163 filter: string, Optional. Filter expression that matches a subset of the DeploymentEvents. https://google.aip.dev/160.
164 orderBy: string, Optional. Field to use to order the list of DeploymentEvents. Expects AIP-132 format &quot;field_name asc&quot; or &quot;field_name desc&quot;, e.g. &quot;deploy_time desc&quot; Supported fields for ordering are: deploy_time, update_time. Currently, only sorting by a single field is supported. If this field is not provided, the list will be sorted by &quot;deploy_time desc&quot;. For more details on the ordering syntax, see https://google.aip.dev/132#ordering.
165 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.
166 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.
167 x__xgafv: string, V1 error format.
168 Allowed values
169 1 - v1 error format
170 2 - v2 error format
171
172 Returns:
173 An object of the form:
174
175 { # Response to listing DeploymentEvents.
176 &quot;deploymentEvents&quot;: [ # The list of DeploymentEvents.
177 { # The DeploymentEvent resource represents the deployment of the artifact within the InsightsConfig resource.
178 &quot;artifactDeployments&quot;: [ # 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.
179 { # The ArtifactDeployment resource represents the deployment of the artifact within the InsightsConfig resource.
180 &quot;artifactAlias&quot;: &quot;A String&quot;, # 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
181 &quot;artifactReference&quot;: &quot;A String&quot;, # Output only. The artifact that is deployed.
182 &quot;containerStatusSummary&quot;: &quot;A String&quot;, # Output only. The summary of container status of the artifact deployment. Format as `ContainerStatusState-Reason : restartCount` e.g. &quot;Waiting-ImagePullBackOff : 3&quot;
183 &quot;deployTime&quot;: &quot;A String&quot;, # Output only. The time at which the deployment was deployed.
184 &quot;id&quot;: &quot;A String&quot;, # Output only. Unique identifier of `ArtifactDeployment`.
185 &quot;sourceCodeUris&quot;: [ # Output only. The URIs of the source code, if available. For Cloud Run source deploy for example: `gs://my-bucket/my-folder/1234567890.abcde-fdbe.zip#1234567890`
186 &quot;A String&quot;,
187 ],
188 &quot;sourceCommitUris&quot;: [ # Output only. The source commits at which this artifact was built. Extracted from provenance.
189 &quot;A String&quot;,
190 ],
191 &quot;undeployTime&quot;: &quot;A String&quot;, # Output only. The time at which the deployment was undeployed, all artifacts are considered undeployed once this time is set.
192 },
193 ],
194 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The create time of the DeploymentEvent.
195 &quot;deployTime&quot;: &quot;A String&quot;, # Output only. The time at which the DeploymentEvent was deployed. This would be the min of all ArtifactDeployment deploy_times.
196 &quot;name&quot;: &quot;A String&quot;, # Identifier. The name of the DeploymentEvent. This name is provided by Developer Connect insights. Format: projects/{project}/locations/{location}/insightsConfigs/{insights_config}/deploymentEvents/{uuid}
197 &quot;runtimeConfig&quot;: { # RuntimeConfig represents the runtimes where the application is deployed. # Output only. The runtime configurations where the DeploymentEvent happened.
198 &quot;appHubService&quot;: { # AppHubService represents the App Hub Service. # Output only. App Hub Service.
199 &quot;apphubService&quot;: &quot;A String&quot;, # Required. Output only. Immutable. The name of the App Hub Service. Format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`.
200 &quot;criticality&quot;: &quot;A String&quot;, # Output only. The criticality of the App Hub Service.
201 &quot;environment&quot;: &quot;A String&quot;, # Output only. The environment of the App Hub Service.
202 },
203 &quot;appHubWorkload&quot;: { # AppHubWorkload represents the App Hub Workload. # Output only. App Hub Workload.
204 &quot;criticality&quot;: &quot;A String&quot;, # Output only. The criticality of the App Hub Workload.
205 &quot;environment&quot;: &quot;A String&quot;, # Output only. The environment of the App Hub Workload.
206 &quot;workload&quot;: &quot;A String&quot;, # Required. Output only. Immutable. The name of the App Hub Workload. Format: `projects/{project}/locations/{location}/applications/{application}/workloads/{workload}`.
207 },
208 &quot;gkeWorkload&quot;: { # GKEWorkload represents the Google Kubernetes Engine runtime. # Output only. Google Kubernetes Engine runtime.
209 &quot;cluster&quot;: &quot;A String&quot;, # Required. Immutable. The name of the GKE cluster. Format: `projects/{project}/locations/{location}/clusters/{cluster}`.
210 &quot;deployment&quot;: &quot;A String&quot;, # Output only. The name of the GKE deployment. Format: `projects/{project}/locations/{location}/clusters/{cluster}/namespaces/{namespace}/deployments/{deployment}`.
211 },
212 &quot;googleCloudRun&quot;: { # GoogleCloudRun represents the Cloud Run runtime. # Output only. Cloud Run runtime.
213 &quot;serviceUri&quot;: &quot;A String&quot;, # Required. Immutable. The name of the Cloud Run service. Format: `projects/{project}/locations/{location}/services/{service}`.
214 },
215 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the Runtime.
216 &quot;uri&quot;: &quot;A String&quot;, # Required. Immutable. The URI of the runtime configuration. For GKE, this is the cluster name. For Cloud Run, this is the service name.
217 },
218 &quot;runtimeDeploymentUri&quot;: &quot;A String&quot;, # 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.
219 &quot;state&quot;: &quot;A String&quot;, # Output only. The state of the DeploymentEvent.
220 &quot;undeployTime&quot;: &quot;A String&quot;, # 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.
221 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The update time of the DeploymentEvent.
222 },
223 ],
224 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
225 }</pre>
226 </div>
227
228 <div class="method">
229 <code class="details" id="list_next">list_next()</code>
230 <pre>Retrieves the next page of results.
231
232 Args:
233 previous_request: The request for the previous page. (required)
234 previous_response: The response from the request for the previous page. (required)
235
236 Returns:
237 A request object that you can call &#x27;execute()&#x27; on to request the next
238 page. Returns None if there are no more items in the collection.
239 </pre>
240 </div>
241
242 </body></html>