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
|
<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.workloadProfiles.html">workloadProfiles</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 details of a single workload.</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 workloads</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 details of a single workload.
Args:
name: string, Required. Name of the resource (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # workload resource
"application": { # The database layer # Optional. The application layer
"applicationType": "A String", # the application layer
"databaseType": "A String", # Optional. the database layer
"instances": [ # Optional. instances in a layer
{ # a vm instance
"name": "A String", # Output only. name of the VM
"region": "A String", # Output only. The location of the VM
"status": "A String", # Output only. The state of the VM
},
],
"sid": "A String", # Output only. system identification of a layer
},
"ascs": { # The database layer # Optional. The ascs layer
"applicationType": "A String", # the application layer
"databaseType": "A String", # Optional. the database layer
"instances": [ # Optional. instances in a layer
{ # a vm instance
"name": "A String", # Output only. name of the VM
"region": "A String", # Output only. The location of the VM
"status": "A String", # Output only. The state of the VM
},
],
"sid": "A String", # Output only. system identification of a layer
},
"database": { # The database layer # Optional. The database layer
"applicationType": "A String", # the application layer
"databaseType": "A String", # Optional. the database layer
"instances": [ # Optional. instances in a layer
{ # a vm instance
"name": "A String", # Output only. name of the VM
"region": "A String", # Output only. The location of the VM
"status": "A String", # Output only. The state of the VM
},
],
"sid": "A String", # Output only. system identification of a layer
},
"labels": { # Optional. such as name, description, version. More example can be found in deployment
"a_key": "A String",
},
"name": "A String", # Identifier. name of resource names have the form 'projects/{project_id}/workloads/{workload_id}'
"refreshedTime": "A String", # Required. time when the workload data was refreshed
"sapWorkload": { # The body of sap workload # The sap workload content
"application": { # The component of sap workload # Output only. the acsc componment
"haHosts": [ # 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",
],
"resources": [ # Output only. resources in the component
{ # The resource on GCP
"kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"name": "A String", # Output only. resource name
},
],
"sid": "A String", # Output only. sid is the sap component identificator
"topologyType": "A String", # The detected topology of the component.
},
"database": { # The component of sap workload # Output only. the database componment
"haHosts": [ # 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",
],
"resources": [ # Output only. resources in the component
{ # The resource on GCP
"kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"name": "A String", # Output only. resource name
},
],
"sid": "A String", # Output only. sid is the sap component identificator
"topologyType": "A String", # The detected topology of the component.
},
"metadata": { # Output only. The metadata for SAP workload.
"a_key": "A String",
},
},
"sqlserverWorkload": { # The body of sqlserver workload # The sqlserver workload content
"ags": [ # Output only. The availability groups for sqlserver
{ # The availability groups for sqlserver
"databases": [ # Output only. The databases
"A String",
],
"name": "A String", # Output only. The availability group name
"primaryServer": "A String", # Output only. The primary server
"secondaryServers": [ # Output only. The secondary servers
"A String",
],
},
],
"cluster": { # The cluster for sqlserver # Output only. The cluster for sqlserver
"nodes": [ # Output only. The nodes
"A String",
],
"witnessServer": "A String", # Output only. The witness server
},
"databases": [ # Output only. The databases for sqlserver
{ # The database for sqlserver
"backupFile": "A String", # Output only. The backup file
"backupSchedule": "A String", # Output only. The backup schedule
"hostVm": "A String", # Output only. The host VM
"name": "A String", # Output only. The database name
},
],
"loadBalancerServer": { # The load balancer for sqlserver # Output only. The load balancer for sqlserver
"ip": "A String", # Output only. The IP address
"vm": "A String", # Output only. The VM name
},
},
"state": "A String", # Output only. [output only] the current state if a a workload
"threeTierWorkload": { # The body of three tier workload # The 3 tier web app workload content
"apiLayer": { # The API layer server # Output only. The API layer for three tier workload
"name": "A String", # Output only. The api layer name
"osVersion": "A String", # Output only. OS information
"resources": [ # Output only. resources in the component
{ # The resource on GCP
"kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"name": "A String", # Output only. resource name
},
],
},
"backend": { # The backend server # Output only. The backend for three tier workload
"backupFile": "A String", # Output only. The backup file
"backupSchedule": "A String", # Output only. The backup schedule
"name": "A String", # Output only. The backend name
"osVersion": "A String", # Output only. OS information
"resources": [ # Output only. resources in the component
{ # The resource on GCP
"kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"name": "A String", # Output only. resource name
},
],
},
"endpoint": "A String", # Output only. the workload endpoint
"frontend": { # The front end server # Output only. The frontend for three tier workload
"name": "A String", # Output only. The frontend name
"osVersion": "A String", # Output only. OS information
"resources": [ # Output only. resources in the component
{ # The resource on GCP
"kind": "A String", # Output only. ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc.
"name": "A String", # Output only. resource name
},
],
},
},
"workloadType": "A String", # Required. The type of the workload
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List workloads
Args:
parent: string, Required. Parent value for ListWorkloadRequest (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 workloadResponse returns a response with the list of workload overview
"nextPageToken": "A String", # Output only. A token identifying a page of results the server should return
"unreachable": [ # Locations that could not be reached.
"A String",
],
"workloadOverviews": [ # Output only. The list of Workload Overview
{ # a workload profile overview
"sapWorkloadOverview": { # The overview of sap workload # The sap workload overview
"appSid": "A String", # Output only. The application SID
"dbSid": "A String", # Output only. The database SID
"sapSystemId": "A String", # Output only. The UUID for a SAP workload
},
"sqlserverWorkloadOverview": { # The overview of sqlserver workload # The sqlserver workload overview
"availabilityGroup": [ # Output only. The availability groups
"A String",
],
"sqlserverSystemId": "A String", # Output only. The UUID for a Sqlserver workload
},
"threeTierWorkloadOverview": { # The overview of three tier workload # The three tier workload overview
"threeTierSystemId": "A String", # Output only. The UUID for a three tier 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 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
