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
|
<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="cloudcontrolspartner_v1beta.html">Cloud Controls Partner API</a> . <a href="cloudcontrolspartner_v1beta.organizations.html">organizations</a> . <a href="cloudcontrolspartner_v1beta.organizations.locations.html">locations</a> . <a href="cloudcontrolspartner_v1beta.organizations.locations.customers.html">customers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudcontrolspartner_v1beta.organizations.locations.customers.workloads.html">workloads()</a></code>
</p>
<p class="firstline">Returns the workloads Resource.</p>
<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="#create">create(parent, body=None, customerId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new customer.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete details of a single customer</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 customer</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists customers of a partner identified by its Google Cloud organization ID</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>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update details of a single customer</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="create">create(parent, body=None, customerId=None, x__xgafv=None)</code>
<pre>Creates a new customer.
Args:
parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required)
body: object, The request body.
The object takes the form of:
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
}
customerId: string, Required. The customer id to use for the customer, which will become the final component of the customer's resource name. The specified value must be a valid Google cloud organization id.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete details of a single customer
Args:
name: string, Required. name of the resource to be deleted format: name=organizations/*/locations/*/customers/* (required)
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="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single customer
Args:
name: string, Required. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists customers of a partner identified by its Google Cloud organization ID
Args:
parent: string, Required. Parent resource Format: `organizations/{organization}/locations/{location}` (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, The maximum number of Customers to return. The service may return fewer than this value. If unspecified, at most 500 Customers will be returned.
pageToken: string, A page token, received from a previous `ListCustomers` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for list customer Customers requests
"customers": [ # List of customers
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
},
],
"nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</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>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update details of a single customer
Args:
name: string, Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` (required)
body: object, The request body.
The object takes the form of:
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
}
updateMask: string, Optional. The list of fields to update
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains metadata around a Cloud Controls Partner Customer
"customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
"completionTime": "A String", # The completion time of the onboarding step
"startTime": "A String", # The starting time of the onboarding step
"step": "A String", # The onboarding step
},
],
},
"displayName": "A String", # Required. Display name for the customer
"isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
"organizationDomain": "A String", # Output only. The customer organization domain, extracted from CRM Organization’s display_name field. e.g. "google.com"
}</pre>
</div>
</body></html>
|
