Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 93f0e30

Browse files
committedDec 20, 2022
feat(workloadmanager): update the api
#### workloadmanager:v1 The following keys were added: - resources.projects.resources.locations.resources.insights.methods.writeInsight (Total Keys: 12) - schemas.Insight (Total Keys: 7) - schemas.SapDiscovery (Total Keys: 31) - schemas.SapValidation (Total Keys: 9) - schemas.WriteInsightRequest (Total Keys: 4) - schemas.WriteInsightResponse (Total Keys: 2)
1 parent ee942d9 commit 93f0e30

File tree

3 files changed

+424
-2
lines changed

3 files changed

+424
-2
lines changed
 

‎docs/dyn/workloadmanager_v1.projects.locations.html

+5
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@ <h2>Instance Methods</h2>
7979
</p>
8080
<p class="firstline">Returns the evaluations Resource.</p>
8181

82+
<p class="toc_element">
83+
<code><a href="workloadmanager_v1.projects.locations.insights.html">insights()</a></code>
84+
</p>
85+
<p class="firstline">Returns the insights Resource.</p>
86+
8287
<p class="toc_element">
8388
<code><a href="workloadmanager_v1.projects.locations.operations.html">operations()</a></code>
8489
</p>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
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="workloadmanager_v1.html">Workload Manager API</a> . <a href="workloadmanager_v1.projects.html">projects</a> . <a href="workloadmanager_v1.projects.locations.html">locations</a> . <a href="workloadmanager_v1.projects.locations.insights.html">insights</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="#writeInsight">writeInsight(location, body=None, x__xgafv=None)</a></code></p>
82+
<p class="firstline">Write the data insights to workload manager data warehouse.</p>
83+
<h3>Method Details</h3>
84+
<div class="method">
85+
<code class="details" id="close">close()</code>
86+
<pre>Close httplib2 connections.</pre>
87+
</div>
88+
89+
<div class="method">
90+
<code class="details" id="writeInsight">writeInsight(location, body=None, x__xgafv=None)</code>
91+
<pre>Write the data insights to workload manager data warehouse.
92+
93+
Args:
94+
location: string, Required. The GCP location. The format is: projects/{project}/locations/{location}. (required)
95+
body: object, The request body.
96+
The object takes the form of:
97+
98+
{ # Request for sending the data insights.
99+
&quot;insight&quot;: { # A presentation of host resource usage where the workload runs. # Required. The metrics data details.
100+
&quot;sapDiscovery&quot;: { # The schema of SAP system discovery data. # The insights data for sap system discovery. This is a copy of SAP System proto and should get updated whenever that one changes.
101+
&quot;applicationLayer&quot;: { # Message describing the system component. # An SAP system may run without an application layer.
102+
&quot;applicationType&quot;: &quot;A String&quot;, # The component is a SAP application.
103+
&quot;databaseType&quot;: &quot;A String&quot;, # The component is a SAP database.
104+
&quot;hostProject&quot;: &quot;A String&quot;, # Pantheon Project in which the resources reside.
105+
&quot;resources&quot;: [ # The resources in a component.
106+
{ # Message describing a resource.
107+
&quot;relatedResources&quot;: [ # A list of resource URIs related to this resource.
108+
&quot;A String&quot;,
109+
],
110+
&quot;resourceKind&quot;: &quot;A String&quot;, # ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
111+
&quot;resourceType&quot;: &quot;A String&quot;, # The type of this resource.
112+
&quot;resourceUri&quot;: &quot;A String&quot;, # URI of the resource, includes project, location, and name.
113+
&quot;updateTime&quot;: &quot;A String&quot;, # Unix timestamp of when this resource last had its discovery data updated.
114+
},
115+
],
116+
&quot;sid&quot;: &quot;A String&quot;, # The sap identifier, used by the SAP software and helps differentiate systems for customers.
117+
},
118+
&quot;databaseLayer&quot;: { # Message describing the system component. # An SAP System must have a database.
119+
&quot;applicationType&quot;: &quot;A String&quot;, # The component is a SAP application.
120+
&quot;databaseType&quot;: &quot;A String&quot;, # The component is a SAP database.
121+
&quot;hostProject&quot;: &quot;A String&quot;, # Pantheon Project in which the resources reside.
122+
&quot;resources&quot;: [ # The resources in a component.
123+
{ # Message describing a resource.
124+
&quot;relatedResources&quot;: [ # A list of resource URIs related to this resource.
125+
&quot;A String&quot;,
126+
],
127+
&quot;resourceKind&quot;: &quot;A String&quot;, # ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
128+
&quot;resourceType&quot;: &quot;A String&quot;, # The type of this resource.
129+
&quot;resourceUri&quot;: &quot;A String&quot;, # URI of the resource, includes project, location, and name.
130+
&quot;updateTime&quot;: &quot;A String&quot;, # Unix timestamp of when this resource last had its discovery data updated.
131+
},
132+
],
133+
&quot;sid&quot;: &quot;A String&quot;, # The sap identifier, used by the SAP software and helps differentiate systems for customers.
134+
},
135+
&quot;metadata&quot;: { # Message describing SAP discovery system metadata # The metadata for SAP system discovery data.
136+
&quot;customerRegion&quot;: &quot;A String&quot;, # Customer region string for customer&#x27;s use. Does not represent GCP region.
137+
&quot;definedSystem&quot;: &quot;A String&quot;, # Customer defined, something like &quot;E-commerce pre prod&quot;
138+
&quot;environmentType&quot;: &quot;A String&quot;, # Should be &quot;prod&quot;, &quot;QA&quot;, &quot;dev&quot;, &quot;staging&quot;, etc.
139+
&quot;sapProduct&quot;: &quot;A String&quot;, # This sap product name
140+
},
141+
&quot;systemId&quot;: &quot;A String&quot;, # A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.
142+
&quot;updateTime&quot;: &quot;A String&quot;, # Unix timestamp this system has been updated last.
143+
},
144+
&quot;sapValidation&quot;: { # A presentation of SAP workload insight. The schema of SAP workloads validation related data. # The insights data for the sap workload validation.
145+
&quot;validationDetails&quot;: [ # A list of SAP validation metrics data.
146+
{ # Message describing the SAP validation metrics.
147+
&quot;details&quot;: { # The pairs of metrics data: field name &amp; field value.
148+
&quot;a_key&quot;: &quot;A String&quot;,
149+
},
150+
&quot;sapValidationType&quot;: &quot;A String&quot;, # The SAP system that the validation data is from.
151+
},
152+
],
153+
},
154+
&quot;sentTime&quot;: &quot;A String&quot;, # Output only. [Output only] Create time stamp
155+
},
156+
&quot;requestId&quot;: &quot;A String&quot;, # Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
157+
}
158+
159+
x__xgafv: string, V1 error format.
160+
Allowed values
161+
1 - v1 error format
162+
2 - v2 error format
163+
164+
Returns:
165+
An object of the form:
166+
167+
{ # The response for write insights request.
168+
}</pre>
169+
</div>
170+
171+
</body></html>

‎googleapiclient/discovery_cache/documents/workloadmanager.v1.json

+248-2
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"canonicalName": "Workload Manager",
1515
"description": "",
1616
"discoveryVersion": "v1",
17-
"documentationLink": "https://g3doc.corp.google.com/company/teams/compute-fe/index.md?cl=head",
17+
"documentationLink": "https://cloud.google.com/workload-manager/docs",
1818
"fullyEncodeReservedExpansion": true,
1919
"icons": {
2020
"x16": "http://www.google.com/images/icons/product/search-16.gif",
@@ -290,6 +290,38 @@
290290
}
291291
}
292292
},
293+
"insights": {
294+
"methods": {
295+
"writeInsight": {
296+
"description": "Write the data insights to workload manager data warehouse.",
297+
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/insights:writeInsight",
298+
"httpMethod": "POST",
299+
"id": "workloadmanager.projects.locations.insights.writeInsight",
300+
"parameterOrder": [
301+
"location"
302+
],
303+
"parameters": {
304+
"location": {
305+
"description": "Required. The GCP location. The format is: projects/{project}/locations/{location}.",
306+
"location": "path",
307+
"pattern": "^projects/[^/]+/locations/[^/]+$",
308+
"required": true,
309+
"type": "string"
310+
}
311+
},
312+
"path": "v1/{+location}/insights:writeInsight",
313+
"request": {
314+
"$ref": "WriteInsightRequest"
315+
},
316+
"response": {
317+
"$ref": "WriteInsightResponse"
318+
},
319+
"scopes": [
320+
"https://www.googleapis.com/auth/cloud-platform"
321+
]
322+
}
323+
}
324+
},
293325
"operations": {
294326
"methods": {
295327
"cancel": {
@@ -418,7 +450,7 @@
418450
}
419451
}
420452
},
421-
"revision": "20221123",
453+
"revision": "20221213",
422454
"rootUrl": "https://workloadmanager.googleapis.com/",
423455
"schemas": {
424456
"CancelOperationRequest": {
@@ -505,6 +537,27 @@
505537
},
506538
"type": "object"
507539
},
540+
"Insight": {
541+
"description": "A presentation of host resource usage where the workload runs.",
542+
"id": "Insight",
543+
"properties": {
544+
"sapDiscovery": {
545+
"$ref": "SapDiscovery",
546+
"description": "The insights data for sap system discovery. This is a copy of SAP System proto and should get updated whenever that one changes."
547+
},
548+
"sapValidation": {
549+
"$ref": "SapValidation",
550+
"description": "The insights data for the sap workload validation."
551+
},
552+
"sentTime": {
553+
"description": "Output only. [Output only] Create time stamp",
554+
"format": "google-datetime",
555+
"readOnly": true,
556+
"type": "string"
557+
}
558+
},
559+
"type": "object"
560+
},
508561
"ListEvaluationsResponse": {
509562
"description": "Message for response to listing Evaluations",
510563
"id": "ListEvaluationsResponse",
@@ -741,6 +794,178 @@
741794
},
742795
"type": "object"
743796
},
797+
"SapDiscovery": {
798+
"description": "The schema of SAP system discovery data.",
799+
"id": "SapDiscovery",
800+
"properties": {
801+
"applicationLayer": {
802+
"$ref": "SapDiscoveryComponent",
803+
"description": "An SAP system may run without an application layer."
804+
},
805+
"databaseLayer": {
806+
"$ref": "SapDiscoveryComponent",
807+
"description": "An SAP System must have a database."
808+
},
809+
"metadata": {
810+
"$ref": "SapDiscoveryMetadata",
811+
"description": "The metadata for SAP system discovery data."
812+
},
813+
"systemId": {
814+
"description": "A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.",
815+
"type": "string"
816+
},
817+
"updateTime": {
818+
"description": "Unix timestamp this system has been updated last.",
819+
"format": "google-datetime",
820+
"type": "string"
821+
}
822+
},
823+
"type": "object"
824+
},
825+
"SapDiscoveryComponent": {
826+
"description": "Message describing the system component.",
827+
"id": "SapDiscoveryComponent",
828+
"properties": {
829+
"applicationType": {
830+
"description": "The component is a SAP application.",
831+
"type": "string"
832+
},
833+
"databaseType": {
834+
"description": "The component is a SAP database.",
835+
"type": "string"
836+
},
837+
"hostProject": {
838+
"description": "Pantheon Project in which the resources reside.",
839+
"type": "string"
840+
},
841+
"resources": {
842+
"description": "The resources in a component.",
843+
"items": {
844+
"$ref": "SapDiscoveryResource"
845+
},
846+
"type": "array"
847+
},
848+
"sid": {
849+
"description": "The sap identifier, used by the SAP software and helps differentiate systems for customers.",
850+
"type": "string"
851+
}
852+
},
853+
"type": "object"
854+
},
855+
"SapDiscoveryMetadata": {
856+
"description": "Message describing SAP discovery system metadata",
857+
"id": "SapDiscoveryMetadata",
858+
"properties": {
859+
"customerRegion": {
860+
"description": "Customer region string for customer's use. Does not represent GCP region.",
861+
"type": "string"
862+
},
863+
"definedSystem": {
864+
"description": "Customer defined, something like \"E-commerce pre prod\"",
865+
"type": "string"
866+
},
867+
"environmentType": {
868+
"description": "Should be \"prod\", \"QA\", \"dev\", \"staging\", etc.",
869+
"type": "string"
870+
},
871+
"sapProduct": {
872+
"description": "This sap product name",
873+
"type": "string"
874+
}
875+
},
876+
"type": "object"
877+
},
878+
"SapDiscoveryResource": {
879+
"description": "Message describing a resource.",
880+
"id": "SapDiscoveryResource",
881+
"properties": {
882+
"relatedResources": {
883+
"description": "A list of resource URIs related to this resource.",
884+
"items": {
885+
"type": "string"
886+
},
887+
"type": "array"
888+
},
889+
"resourceKind": {
890+
"description": "ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.",
891+
"type": "string"
892+
},
893+
"resourceType": {
894+
"description": "The type of this resource.",
895+
"enum": [
896+
"RESOURCE_TYPE_UNSPECIFIED",
897+
"COMPUTE",
898+
"STORAGE",
899+
"NETWORK"
900+
],
901+
"enumDescriptions": [
902+
"Undefined resource type.",
903+
"This is a compute resource.",
904+
"This a storage resource.",
905+
"This is a network resource."
906+
],
907+
"type": "string"
908+
},
909+
"resourceUri": {
910+
"description": "URI of the resource, includes project, location, and name.",
911+
"type": "string"
912+
},
913+
"updateTime": {
914+
"description": "Unix timestamp of when this resource last had its discovery data updated.",
915+
"format": "google-datetime",
916+
"type": "string"
917+
}
918+
},
919+
"type": "object"
920+
},
921+
"SapValidation": {
922+
"description": "A presentation of SAP workload insight. The schema of SAP workloads validation related data.",
923+
"id": "SapValidation",
924+
"properties": {
925+
"validationDetails": {
926+
"description": "A list of SAP validation metrics data.",
927+
"items": {
928+
"$ref": "SapValidationValidationDetail"
929+
},
930+
"type": "array"
931+
}
932+
},
933+
"type": "object"
934+
},
935+
"SapValidationValidationDetail": {
936+
"description": "Message describing the SAP validation metrics.",
937+
"id": "SapValidationValidationDetail",
938+
"properties": {
939+
"details": {
940+
"additionalProperties": {
941+
"type": "string"
942+
},
943+
"description": "The pairs of metrics data: field name & field value.",
944+
"type": "object"
945+
},
946+
"sapValidationType": {
947+
"description": "The SAP system that the validation data is from.",
948+
"enum": [
949+
"SAP_VALIDATION_TYPE_UNSPECIFIED",
950+
"SYSTEM",
951+
"COROSYNC",
952+
"PACEMAKER",
953+
"HANA",
954+
"NETWEAVER"
955+
],
956+
"enumDescriptions": [
957+
"Unspecified type.",
958+
"The SAP system named SYSTEM.",
959+
"The SAP system named COROSYNC.",
960+
"The SAP system named PACEMAKER.",
961+
"The SAP system named HANA.",
962+
"The SAP system named NETWEAVER."
963+
],
964+
"type": "string"
965+
}
966+
},
967+
"type": "object"
968+
},
744969
"Status": {
745970
"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
746971
"id": "Status",
@@ -767,6 +992,27 @@
767992
}
768993
},
769994
"type": "object"
995+
},
996+
"WriteInsightRequest": {
997+
"description": "Request for sending the data insights.",
998+
"id": "WriteInsightRequest",
999+
"properties": {
1000+
"insight": {
1001+
"$ref": "Insight",
1002+
"description": "Required. The metrics data details."
1003+
},
1004+
"requestId": {
1005+
"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).",
1006+
"type": "string"
1007+
}
1008+
},
1009+
"type": "object"
1010+
},
1011+
"WriteInsightResponse": {
1012+
"description": "The response for write insights request.",
1013+
"id": "WriteInsightResponse",
1014+
"properties": {},
1015+
"type": "object"
7701016
}
7711017
},
7721018
"servicePath": "",

0 commit comments

Comments
 (0)
Please sign in to comment.