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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
|
<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="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>
<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="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Delete the data insights from workload manager data warehouse.</p>
<p class="toc_element">
<code><a href="#writeInsight">writeInsight(location, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Write the data insights to workload manager data warehouse.</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="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Delete the data insights from workload manager data warehouse.
Args:
name: string, Required. The system id of the SAP system resource to delete. Formatted as projects/{project}/locations/{location}/sapSystems/{sap_system_id} (required)
requestId: string, 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 the 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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="writeInsight">writeInsight(location, body=None, x__xgafv=None)</code>
<pre>Write the data insights to workload manager data warehouse.
Args:
location: string, Required. The GCP location. The format is: projects/{project}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # Request for sending the data insights.
"agentVersion": "A String", # Optional. The agent version collected this data point.
"insight": { # A presentation of host resource usage where the workload runs. # Required. The metrics data details.
"agentStatus": { # The schema of agent status data. # The insights data for the agent status.
"agentName": "A String", # Output only. The name of the agent.
"availableVersion": "A String", # Output only. The available version of the agent in artifact registry.
"cloudApiAccessFullScopesGranted": "A String", # Output only. Whether the agent has full access to Cloud APIs.
"configurationErrorMessage": "A String", # Output only. The error message for the agent configuration if invalid.
"configurationFilePath": "A String", # Output only. The path to the agent configuration file.
"configurationValid": "A String", # Output only. Whether the agent configuration is valid.
"installedVersion": "A String", # Output only. The installed version of the agent on the host.
"instanceUri": "A String", # Output only. The URI of the instance. Format: projects//zones//instances/
"kernelVersion": { # KernelVersion encapsulates the kernel version data for the system. # Output only. The kernel version of the system.
"distroKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the distro-specific kernel version, the portion of the string following the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"osKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the OS-specific kernel version, the portion of the string up to the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"rawString": "A String", # Optional. Raw string of the kernel version.
},
"references": [ # Output only. Optional references to public documentation.
{ # The reference to public documentation.
"name": "A String", # Output only. The name of the reference.
"url": "A String", # Output only. The URL of the reference.
},
],
"services": [ # Output only. The services (process metrics, host metrics, etc.).
{ # The status of a service (process metrics, host metrics, etc.).
"configValues": [ # Output only. The configuration values for the service.
{ # The configuration value.
"isDefault": True or False, # Output only. Whether the configuration value is the default value or overridden.
"name": "A String", # Output only. The name of the configuration value.
"value": "A String", # Output only. The value of the configuration value.
},
],
"errorMessage": "A String", # Output only. The error message for the service if it is not fully functional.
"fullyFunctional": "A String", # Output only. Whether the service is fully functional (all checks passed).
"iamPermissions": [ # Output only. The permissions required for the service.
{ # The IAM permission status.
"granted": "A String", # Output only. Whether the permission is granted.
"name": "A String", # Output only. The name of the permission.
},
],
"name": "A String", # Output only. The name of the service.
"state": "A String", # Output only. The state of the service (enabled or disabled in the configuration).
"unspecifiedStateMessage": "A String", # Output only. The message to display when the service state is unspecified.
},
],
"systemdServiceEnabled": "A String", # Output only. Whether the agent service is enabled in systemd.
"systemdServiceRunning": "A String", # Output only. Whether the agent service is running in systemd.
},
"instanceId": "A String", # Required. The instance id where the insight is generated from
"sapDiscovery": { # 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.
"applicationLayer": { # Message describing the system component. # Optional. An SAP system may run without an application layer.
"applicationProperties": { # A set of properties describing an SAP Application layer. # Optional. The component is a SAP application.
"abap": True or False, # Optional. Deprecated: ApplicationType now tells you whether this is ABAP or Java.
"appInstanceNumber": "A String", # Optional. Instance number of the SAP application instance.
"applicationType": "A String", # Required. Type of the application. Netweaver, etc.
"ascsInstanceNumber": "A String", # Optional. Instance number of the ASCS instance.
"ascsUri": "A String", # Optional. Resource URI of the recognized ASCS host of the application.
"ersInstanceNumber": "A String", # Optional. Instance number of the ERS instance.
"kernelVersion": "A String", # Optional. Kernel version for Netweaver running in the system.
"nfsUri": "A String", # Optional. Resource URI of the recognized shared NFS of the application. May be empty if the application server has only a single node.
},
"databaseProperties": { # A set of properties describing an SAP Database layer. # Optional. The component is a SAP database.
"databaseSid": "A String", # Optional. SID of the system database.
"databaseType": "A String", # Required. Type of the database. HANA, DB2, etc.
"databaseVersion": "A String", # Optional. The version of the database software running in the system.
"instanceNumber": "A String", # Optional. Instance number of the SAP instance.
"landscapeId": "A String", # Optional. Landscape ID from the HANA nameserver.
"primaryInstanceUri": "A String", # Required. URI of the recognized primary instance of the database.
"sharedNfsUri": "A String", # Optional. URI of the recognized shared NFS of the database. May be empty if the database has only a single node.
},
"haHosts": [ # Optional. A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
"A String",
],
"hostProject": "A String", # Required. Pantheon Project in which the resources reside.
"region": "A String", # Optional. The region this component's resources are primarily located in.
"replicationSites": [ # Optional. A list of replication sites used in Disaster Recovery (DR) configurations.
{ # A replication site used in Disaster Recovery (DR) configurations.
"component": # Object with schema name: SapDiscoveryComponent # Optional. The system component for the site.
"sourceSite": "A String", # Optional. The name of the source site from which this one replicates.
},
],
"resources": [ # Optional. The resources in a component.
{ # Message describing a resource.
"instanceProperties": { # A set of properties only present for an instance type resource # Optional. A set of properties only applying to instance type resources.
"appInstances": [ # Optional. App server instances on the host
{ # Fields to describe an SAP application server instance.
"name": "A String", # Optional. Instance name of the SAP application instance.
"number": "A String", # Optional. Instance number of the SAP application instance.
},
],
"clusterInstances": [ # Optional. A list of instance URIs that are part of a cluster with this one.
"A String",
],
"diskMounts": [ # Optional. Disk mounts on the instance.
{ # Disk mount on the instance.
"diskNames": [ # Optional. Names of the disks providing this mount point.
"A String",
],
"mountPoint": "A String", # Optional. Filesystem mount point.
"name": "A String", # Optional. Name of the disk.
},
],
"instanceNumber": "A String", # Optional. The VM's instance number.
"instanceRole": "A String", # Optional. Bitmask of instance role, a resource may have multiple roles at once.
"isDrSite": True or False, # Optional. Instance is part of a DR site.
"osKernelVersion": { # KernelVersion encapsulates the kernel version data for the system. # Optional. The kernel version of the instance.
"distroKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the distro-specific kernel version, the portion of the string following the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"osKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the OS-specific kernel version, the portion of the string up to the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"rawString": "A String", # Optional. Raw string of the kernel version.
},
"virtualHostname": "A String", # Optional. A virtual hostname of the instance if it has one.
},
"relatedResources": [ # Optional. A list of resource URIs related to this resource.
"A String",
],
"resourceKind": "A String", # Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"resourceType": "A String", # Required. The type of this resource.
"resourceUri": "A String", # Required. URI of the resource, includes project, location, and name.
"updateTime": "A String", # Required. Unix timestamp of when this resource last had its discovery data updated.
},
],
"sid": "A String", # Optional. The SAP identifier, used by the SAP software and helps differentiate systems for customers.
"topologyType": "A String", # Optional. The detected topology of the component.
},
"databaseLayer": { # Message describing the system component. # Required. An SAP System must have a database.
"applicationProperties": { # A set of properties describing an SAP Application layer. # Optional. The component is a SAP application.
"abap": True or False, # Optional. Deprecated: ApplicationType now tells you whether this is ABAP or Java.
"appInstanceNumber": "A String", # Optional. Instance number of the SAP application instance.
"applicationType": "A String", # Required. Type of the application. Netweaver, etc.
"ascsInstanceNumber": "A String", # Optional. Instance number of the ASCS instance.
"ascsUri": "A String", # Optional. Resource URI of the recognized ASCS host of the application.
"ersInstanceNumber": "A String", # Optional. Instance number of the ERS instance.
"kernelVersion": "A String", # Optional. Kernel version for Netweaver running in the system.
"nfsUri": "A String", # Optional. Resource URI of the recognized shared NFS of the application. May be empty if the application server has only a single node.
},
"databaseProperties": { # A set of properties describing an SAP Database layer. # Optional. The component is a SAP database.
"databaseSid": "A String", # Optional. SID of the system database.
"databaseType": "A String", # Required. Type of the database. HANA, DB2, etc.
"databaseVersion": "A String", # Optional. The version of the database software running in the system.
"instanceNumber": "A String", # Optional. Instance number of the SAP instance.
"landscapeId": "A String", # Optional. Landscape ID from the HANA nameserver.
"primaryInstanceUri": "A String", # Required. URI of the recognized primary instance of the database.
"sharedNfsUri": "A String", # Optional. URI of the recognized shared NFS of the database. May be empty if the database has only a single node.
},
"haHosts": [ # Optional. A list of host URIs that are part of the HA configuration if present. An empty list indicates the component is not configured for HA.
"A String",
],
"hostProject": "A String", # Required. Pantheon Project in which the resources reside.
"region": "A String", # Optional. The region this component's resources are primarily located in.
"replicationSites": [ # Optional. A list of replication sites used in Disaster Recovery (DR) configurations.
{ # A replication site used in Disaster Recovery (DR) configurations.
"component": # Object with schema name: SapDiscoveryComponent # Optional. The system component for the site.
"sourceSite": "A String", # Optional. The name of the source site from which this one replicates.
},
],
"resources": [ # Optional. The resources in a component.
{ # Message describing a resource.
"instanceProperties": { # A set of properties only present for an instance type resource # Optional. A set of properties only applying to instance type resources.
"appInstances": [ # Optional. App server instances on the host
{ # Fields to describe an SAP application server instance.
"name": "A String", # Optional. Instance name of the SAP application instance.
"number": "A String", # Optional. Instance number of the SAP application instance.
},
],
"clusterInstances": [ # Optional. A list of instance URIs that are part of a cluster with this one.
"A String",
],
"diskMounts": [ # Optional. Disk mounts on the instance.
{ # Disk mount on the instance.
"diskNames": [ # Optional. Names of the disks providing this mount point.
"A String",
],
"mountPoint": "A String", # Optional. Filesystem mount point.
"name": "A String", # Optional. Name of the disk.
},
],
"instanceNumber": "A String", # Optional. The VM's instance number.
"instanceRole": "A String", # Optional. Bitmask of instance role, a resource may have multiple roles at once.
"isDrSite": True or False, # Optional. Instance is part of a DR site.
"osKernelVersion": { # KernelVersion encapsulates the kernel version data for the system. # Optional. The kernel version of the instance.
"distroKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the distro-specific kernel version, the portion of the string following the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"osKernel": { # Version is reported as Major.Minor.Build.Patch. # Optional. Captures the OS-specific kernel version, the portion of the string up to the first dash.
"build": 42, # Optional. The build version number.
"major": 42, # Optional. The major version number.
"minor": 42, # Optional. The minor version number.
"patch": 42, # Optional. The patch version number.
"remainder": "A String", # Optional. A catch-all for any unparsed version components. This is in case the number of points in the version string exceeds the expected count of 4.
},
"rawString": "A String", # Optional. Raw string of the kernel version.
},
"virtualHostname": "A String", # Optional. A virtual hostname of the instance if it has one.
},
"relatedResources": [ # Optional. A list of resource URIs related to this resource.
"A String",
],
"resourceKind": "A String", # Required. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"resourceType": "A String", # Required. The type of this resource.
"resourceUri": "A String", # Required. URI of the resource, includes project, location, and name.
"updateTime": "A String", # Required. Unix timestamp of when this resource last had its discovery data updated.
},
],
"sid": "A String", # Optional. The SAP identifier, used by the SAP software and helps differentiate systems for customers.
"topologyType": "A String", # Optional. The detected topology of the component.
},
"metadata": { # Message describing SAP discovery system metadata # Optional. The metadata for SAP system discovery data.
"customerRegion": "A String", # Optional. Customer region string for customer's use. Does not represent GCP region.
"definedSystem": "A String", # Optional. Customer defined, something like "E-commerce pre prod"
"environmentType": "A String", # Optional. Should be "prod", "QA", "dev", "staging", etc.
"sapProduct": "A String", # Optional. This SAP product name
},
"projectNumber": "A String", # Optional. The GCP project number that this SapSystem belongs to.
"systemId": "A String", # Output only. A combination of database SID, database instance URI and tenant DB name to make a unique identifier per-system.
"updateTime": "A String", # Required. Unix timestamp this system has been updated last.
"useDrReconciliation": True or False, # Optional. Whether to use DR reconciliation or not.
"workloadProperties": { # A set of properties describing an SAP workload. # Optional. The properties of the workload.
"productVersions": [ # Optional. List of SAP Products and their versions running on the system.
{ # A product name and version.
"name": "A String", # Optional. Name of the product.
"version": "A String", # Optional. Version of the product.
},
],
"softwareComponentVersions": [ # Optional. A list of SAP software components and their versions running on the system.
{ # A SAP software component name, version, and type.
"extVersion": "A String", # Optional. The component's minor version.
"name": "A String", # Optional. Name of the component.
"type": "A String", # Optional. The component's type.
"version": "A String", # Optional. The component's major version.
},
],
},
},
"sapValidation": { # A presentation of SAP workload insight. The schema of SAP workloads validation related data. # The insights data for the SAP workload validation.
"projectId": "A String", # Required. The project_id of the cloud project that the Insight data comes from.
"validationDetails": [ # Optional. A list of SAP validation metrics data.
{ # Message describing the SAP validation metrics.
"details": { # Optional. The pairs of metrics data: field name & field value.
"a_key": "A String",
},
"isPresent": True or False, # Optional. Was there a SAP system detected for this validation type.
"sapValidationType": "A String", # Optional. The SAP system that the validation data is from.
},
],
"zone": "A String", # Optional. The zone of the instance that the Insight data comes from.
},
"sentTime": "A String", # Output only. [Output only] Create time stamp
"sqlserverValidation": { # A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data. # The insights data for the sqlserver workload validation.
"agentVersion": "A String", # Optional. The agent version collected this data point
"instance": "A String", # Required. The instance_name of the instance that the Insight data comes from. According to https://linter.aip.dev/122/name-suffix: field names should not use the _name suffix unless the field would be ambiguous without it.
"projectId": "A String", # Required. The project_id of the cloud project that the Insight data comes from.
"validationDetails": [ # Optional. A list of SqlServer validation metrics data.
{ # Message describing the Sqlserver validation metrics.
"details": [ # Required. Details wraps map that represents collected data names and values.
{ # Message containing collected data names and values.
"fields": { # Required. Collected data is in format.
"a_key": "A String",
},
},
],
"type": "A String", # Optional. The Sqlserver system that the validation data is from.
},
],
},
"torsoValidation": { # The schema of torso workload validation data. # The insights data for workload validation of torso workloads.
"agentVersion": "A String", # Required. agent_version lists the version of the agent that collected this data.
"instanceName": "A String", # Required. instance_name lists the human readable name of the instance that the data comes from.
"projectId": "A String", # Required. project_id lists the human readable cloud project that the data comes from.
"validationDetails": { # Required. validation_details contains the pairs of validation data: field name & field value.
"a_key": "A String",
},
"workloadType": "A String", # Required. workload_type specifies the type of torso workload.
},
},
"requestId": "A String", # 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 the 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).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for write insights request.
}</pre>
</div>
</body></html>
|
