blob: 9535c033eec00fe92c2b70ce61e68682600af14d [file] [log] [blame]
<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.discoveredprofiles.html">discoveredprofiles</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List discovered workload profiles</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="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List discovered workload profiles
Args:
parent: string, Required. Parent value for ListDiscoveredProfilesRequest (required)
filter: string, Optional. Filtering results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # List discovered profile Response returns discovered profiles from agents
&quot;nextPageToken&quot;: &quot;A String&quot;, # Output only. A token identifying a page of results the server should return
&quot;unreachable&quot;: [ # Locations that could not be reached.
&quot;A String&quot;,
],
&quot;workloadProfiles&quot;: [ # Output only. The list of workload profiles
{ # workload resource
&quot;labels&quot;: { # Optional. such as name, description, version. More example can be found in deployment
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;name&quot;: &quot;A String&quot;, # Identifier. name of resource names have the form &#x27;projects/{project_id}/locations/{location}/workloadProfiles/{workload_id}&#x27;
&quot;refreshedTime&quot;: &quot;A String&quot;, # Required. time when the workload data was refreshed
&quot;sapWorkload&quot;: { # The body of sap workload # The sap workload content
&quot;application&quot;: { # The component of sap workload # Output only. the acsc componment
&quot;databaseProperties&quot;: { # Database Properties. # Output only. All instance properties.
&quot;backupProperties&quot;: { # Backup properties. # Output only. Backup properties.
&quot;latestBackupStatus&quot;: &quot;A String&quot;, # Output only. The state of the latest backup.
&quot;latestBackupTime&quot;: &quot;A String&quot;, # The time when the latest backup was performed.
},
&quot;databaseType&quot;: &quot;A String&quot;, # Output only. Type of the database. HANA, DB2, etc.
},
&quot;haHosts&quot;: [ # 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.
&quot;A String&quot;,
],
&quot;resources&quot;: [ # Output only. resources in the component
{ # The resource on GCP
&quot;instanceProperties&quot;: { # Instance Properties. # Output only. All instance properties.
&quot;instanceNumber&quot;: &quot;A String&quot;, # Optional. Instance number.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. Instance machine type.
&quot;roles&quot;: [ # Optional. Instance roles.
&quot;A String&quot;,
],
&quot;sapInstanceProperties&quot;: { # SAP instance properties. # Optional. SAP Instance properties.
&quot;agentStates&quot;: { # Agent status. # Optional. Sap Instance Agent status.
&quot;availableVersion&quot;: &quot;A String&quot;, # Optional. The available version of the agent in artifact registry.
&quot;hanaMonitoring&quot;: { # The state of the service. # Optional. HANA monitoring metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
&quot;installedVersion&quot;: &quot;A String&quot;, # Optional. The installed version of the agent on the host.
&quot;isFullyEnabled&quot;: True or False, # Optional. Whether the agent is fully enabled. If false, the agent is has some issues.
&quot;processMetrics&quot;: { # The state of the service. # Optional. The Process metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
&quot;systemDiscovery&quot;: { # The state of the service. # Optional. The System discovery metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
},
&quot;numbers&quot;: [ # Optional. SAP Instance numbers. They are from &#x27;00&#x27; to &#x27;99&#x27;.
&quot;A String&quot;,
],
},
&quot;status&quot;: &quot;A String&quot;, # Optional. Instance status.
&quot;upcomingMaintenanceEvent&quot;: { # Maintenance Event # Optional. the next maintenance event on VM
&quot;endTime&quot;: &quot;A String&quot;, # Optional. End time
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # Optional. Maintenance status
&quot;onHostMaintenance&quot;: &quot;A String&quot;, # Optional. Instance maintenance behavior. Could be &quot;MIGRATE&quot; or &quot;TERMINATE&quot;.
&quot;startTime&quot;: &quot;A String&quot;, # Optional. Start time
&quot;type&quot;: &quot;A String&quot;, # Optional. Type
},
},
&quot;kind&quot;: &quot;A String&quot;, # Output only.
&quot;name&quot;: &quot;A String&quot;, # Output only. resource name Example: compute.googleapis.com/projects/wlm-obs-dev/zones/us-central1-a/instances/sap-pri
},
],
&quot;sid&quot;: &quot;A String&quot;, # Output only. sid is the sap component identificator
&quot;topologyType&quot;: &quot;A String&quot;, # The detected topology of the component.
},
&quot;architecture&quot;: &quot;A String&quot;, # Output only. the architecture
&quot;database&quot;: { # The component of sap workload # Output only. the database componment
&quot;databaseProperties&quot;: { # Database Properties. # Output only. All instance properties.
&quot;backupProperties&quot;: { # Backup properties. # Output only. Backup properties.
&quot;latestBackupStatus&quot;: &quot;A String&quot;, # Output only. The state of the latest backup.
&quot;latestBackupTime&quot;: &quot;A String&quot;, # The time when the latest backup was performed.
},
&quot;databaseType&quot;: &quot;A String&quot;, # Output only. Type of the database. HANA, DB2, etc.
},
&quot;haHosts&quot;: [ # 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.
&quot;A String&quot;,
],
&quot;resources&quot;: [ # Output only. resources in the component
{ # The resource on GCP
&quot;instanceProperties&quot;: { # Instance Properties. # Output only. All instance properties.
&quot;instanceNumber&quot;: &quot;A String&quot;, # Optional. Instance number.
&quot;machineType&quot;: &quot;A String&quot;, # Optional. Instance machine type.
&quot;roles&quot;: [ # Optional. Instance roles.
&quot;A String&quot;,
],
&quot;sapInstanceProperties&quot;: { # SAP instance properties. # Optional. SAP Instance properties.
&quot;agentStates&quot;: { # Agent status. # Optional. Sap Instance Agent status.
&quot;availableVersion&quot;: &quot;A String&quot;, # Optional. The available version of the agent in artifact registry.
&quot;hanaMonitoring&quot;: { # The state of the service. # Optional. HANA monitoring metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
&quot;installedVersion&quot;: &quot;A String&quot;, # Optional. The installed version of the agent on the host.
&quot;isFullyEnabled&quot;: True or False, # Optional. Whether the agent is fully enabled. If false, the agent is has some issues.
&quot;processMetrics&quot;: { # The state of the service. # Optional. The Process metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
&quot;systemDiscovery&quot;: { # The state of the service. # Optional. The System discovery metrics of the agent.
&quot;iamPermissions&quot;: [ # Optional. Output only. The IAM permissions for the service.
{ # The IAM permission status.
&quot;granted&quot;: True or False, # Output only. Whether the permission is granted.
&quot;name&quot;: &quot;A String&quot;, # Output only. The name of the permission.
},
],
&quot;state&quot;: &quot;A String&quot;, # Output only. The overall state of the service.
},
},
&quot;numbers&quot;: [ # Optional. SAP Instance numbers. They are from &#x27;00&#x27; to &#x27;99&#x27;.
&quot;A String&quot;,
],
},
&quot;status&quot;: &quot;A String&quot;, # Optional. Instance status.
&quot;upcomingMaintenanceEvent&quot;: { # Maintenance Event # Optional. the next maintenance event on VM
&quot;endTime&quot;: &quot;A String&quot;, # Optional. End time
&quot;maintenanceStatus&quot;: &quot;A String&quot;, # Optional. Maintenance status
&quot;onHostMaintenance&quot;: &quot;A String&quot;, # Optional. Instance maintenance behavior. Could be &quot;MIGRATE&quot; or &quot;TERMINATE&quot;.
&quot;startTime&quot;: &quot;A String&quot;, # Optional. Start time
&quot;type&quot;: &quot;A String&quot;, # Optional. Type
},
},
&quot;kind&quot;: &quot;A String&quot;, # Output only.
&quot;name&quot;: &quot;A String&quot;, # Output only. resource name Example: compute.googleapis.com/projects/wlm-obs-dev/zones/us-central1-a/instances/sap-pri
},
],
&quot;sid&quot;: &quot;A String&quot;, # Output only. sid is the sap component identificator
&quot;topologyType&quot;: &quot;A String&quot;, # The detected topology of the component.
},
&quot;metadata&quot;: { # Output only. The metadata for SAP workload.
&quot;a_key&quot;: &quot;A String&quot;,
},
&quot;products&quot;: [ # Output only. the products on this workload.
{ # Product contains the details of a product.
&quot;name&quot;: &quot;A String&quot;, # Optional. Name of the product.
&quot;version&quot;: &quot;A String&quot;, # Optional. Version of the product.
},
],
},
&quot;workloadType&quot;: &quot;A String&quot;, # Required. The type of the workload
},
],
}</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 &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>