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
|
<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="servicebroker_v1beta1.html">Service Broker API</a> . <a href="servicebroker_v1beta1.projects.html">projects</a> . <a href="servicebroker_v1beta1.projects.brokers.html">brokers</a> . <a href="servicebroker_v1beta1.projects.brokers.instances.html">instances</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="servicebroker_v1beta1.projects.brokers.instances.bindings.html">bindings()</a></code>
</p>
<p class="firstline">Returns the bindings Resource.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the given service instance from the system.</p>
<p class="toc_element">
<code><a href="#getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</a></code></p>
<p class="firstline">Returns the state of the last operation for the service instance.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
<p class="firstline">Lists all the instances in the brokers</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets the given service instance from the system.
The API call accepts both OSB style API and standard google style API
resource path.
i.e. both `projects/*/brokers/*/instances/*`
and `projects/*/brokers/*/v2/service_instances/*` are acceptable paths.
Args:
name: string, The resource name of the instance to return.
Name must match
`projects/[PROJECT_ID]/brokers/[BROKER_ID]/` +
`v2/service_instances/[INSTANCE_ID]`
or
`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Message describing inputs to Provision and Update Service instance requests.
"space_guid": "A String", # The identifier for the project space within the platform organization.
# Required.
"previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous
# fields.
"a_key": "", # Properties of the object.
},
"plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details.
# Maximum length is 64, GUID recommended.
# Required.
"description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with
# other methods.
"parameters": { # Configuration options for the service instance.
# Parameters is JSON object serialized to string.
"a_key": "", # Properties of the object.
},
"organization_guid": "A String", # The platform GUID for the organization under which the service is to be
# provisioned.
# Required.
"instance_id": "A String", # The id of the service instance. Must be unique within GCP project.
# Maximum length is 64, GUID recommended.
# Required.
"deploymentName": "A String", # Output only.
# String containing the Deployment Manager deployment name that was created
# for this instance,
"context": { # Platform specific contextual information under which the service instance
# is to be provisioned. This replaces organization_guid and space_guid.
# But can also contain anything.
# Currently only used for logging context information.
"a_key": "", # Properties of the object.
},
"service_id": "A String", # The id of the service. Must be a valid identifier of a service
# contained in the list from a `ListServices()` call.
# Maximum length is 64, GUID recommended.
# Required.
"resourceName": "A String", # Output only.
# The resource name of the instance, e.g.
# projects/project_id/brokers/broker_id/service_instances/instance_id
"createTime": "A String", # Output only.
# Timestamp for when the instance was created.
}</pre>
</div>
<div class="method">
<code class="details" id="getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</code>
<pre>Returns the state of the last operation for the service instance.
Only last (or current) operation can be polled.
Args:
name: string, Name must match
`projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+
`service_instances/[INSTANCE_ID]`. (required)
planId: string, Plan id.
serviceId: string, Service id.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
operation: string, If `operation` was returned during mutation operation, this field must be
populated with the provided value.
Returns:
An object of the form:
{ # Describes a long running operation, which conforms to OpenService API.
"state": "A String", # The state of the operation.
# Valid values are: "in progress", "succeeded", and "failed".
"description": "A String", # Optional description of the Operation state.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists all the instances in the brokers
This API is an extension and not part of the OSB spec.
Hence the path is a standard Google API URL.
Args:
parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required)
pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
returned by a previous list request to get the next page of results.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
pageSize: integer, Specifies the number of results to return per page. If there are fewer
elements than the specified number, returns all elements.
Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
Returns:
An object of the form:
{ # The response for the `ListServiceInstances()` method.
"nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
# If the number of results is larger than `pageSize`, use the `nextPageToken`
# as a value for the query parameter `pageToken` in the next list request.
# Subsequent list requests will have their own `nextPageToken` to continue
# paging through the results
"instances": [ # The list of instances in the broker.
{ # Message describing inputs to Provision and Update Service instance requests.
"space_guid": "A String", # The identifier for the project space within the platform organization.
# Required.
"previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous
# fields.
"a_key": "", # Properties of the object.
},
"plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details.
# Maximum length is 64, GUID recommended.
# Required.
"description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with
# other methods.
"parameters": { # Configuration options for the service instance.
# Parameters is JSON object serialized to string.
"a_key": "", # Properties of the object.
},
"organization_guid": "A String", # The platform GUID for the organization under which the service is to be
# provisioned.
# Required.
"instance_id": "A String", # The id of the service instance. Must be unique within GCP project.
# Maximum length is 64, GUID recommended.
# Required.
"deploymentName": "A String", # Output only.
# String containing the Deployment Manager deployment name that was created
# for this instance,
"context": { # Platform specific contextual information under which the service instance
# is to be provisioned. This replaces organization_guid and space_guid.
# But can also contain anything.
# Currently only used for logging context information.
"a_key": "", # Properties of the object.
},
"service_id": "A String", # The id of the service. Must be a valid identifier of a service
# contained in the list from a `ListServices()` call.
# Maximum length is 64, GUID recommended.
# Required.
"resourceName": "A String", # Output only.
# The resource name of the instance, e.g.
# projects/project_id/brokers/broker_id/service_instances/instance_id
"createTime": "A String", # Output only.
# Timestamp for when the instance was created.
},
],
"description": "A String", # Used to communicate description of the response. Usually for non-standard
# error codes.
# https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
|
