Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4e80caffe1cef696a1d2d06f42f644325d827fc8 / . / docs / dyn / servicebroker_v1beta1.projects.brokers.instances.html
blob: 2f1ae7a5d4ccc09be3c2ee7c918df321d87ac5f7 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="servicebroker_v1beta1.projects.brokers.instances.bindings.html">bindings()</a></code>
79</p>
80<p class="firstline">Returns the bindings Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
84<p class="firstline">Gets the given service instance from the system.</p>
85<p class="toc_element">
86 <code><a href="#getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</a></code></p>
87<p class="firstline">Returns the state of the last operation for the service instance.</p>
88<p class="toc_element">
89 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
90<p class="firstline">Lists all the instances in the brokers</p>
91<p class="toc_element">
92 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
93<p class="firstline">Retrieves the next page of results.</p>
94<h3>Method Details</h3>
95<div class="method">
96 <code class="details" id="get">get(name, x__xgafv=None)</code>
97 <pre>Gets the given service instance from the system.
98The API call accepts both OSB style API and standard google style API
99resource path.
100i.e. both `projects/*/brokers/*/instances/*`
101 and `projects/*/brokers/*/v2/service_instances/*` are acceptable paths.
102
103Args:
104 name: string, The resource name of the instance to return.
105Name must match
106`projects/[PROJECT_ID]/brokers/[BROKER_ID]/` +
107`v2/service_instances/[INSTANCE_ID]`
108or
109`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. (required)
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
118 { # Message describing inputs to Provision and Update Service instance requests.
119 "space_guid": "A String", # The identifier for the project space within the platform organization.
120 # Required.
121 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous
122 # fields.
123 "a_key": "", # Properties of the object.
124 },
125 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details.
126 # Maximum length is 64, GUID recommended.
127 # Required.
128 "description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with
129 # other methods.
130 "parameters": { # Configuration options for the service instance.
131 # Parameters is JSON object serialized to string.
132 "a_key": "", # Properties of the object.
133 },
134 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be
135 # provisioned.
136 # Required.
137 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project.
138 # Maximum length is 64, GUID recommended.
139 # Required.
140 "deploymentName": "A String", # Output only.
141 # String containing the Deployment Manager deployment name that was created
142 # for this instance,
143 "context": { # Platform specific contextual information under which the service instance
144 # is to be provisioned. This replaces organization_guid and space_guid.
145 # But can also contain anything.
146 # Currently only used for logging context information.
147 "a_key": "", # Properties of the object.
148 },
149 "service_id": "A String", # The id of the service. Must be a valid identifier of a service
150 # contained in the list from a `ListServices()` call.
151 # Maximum length is 64, GUID recommended.
152 # Required.
153 "resourceName": "A String", # Output only.
154 # The resource name of the instance, e.g.
155 # projects/project_id/brokers/broker_id/service_instances/instance_id
156 "createTime": "A String", # Output only.
157 # Timestamp for when the instance was created.
158 }</pre>
159</div>
160
161<div class="method">
162 <code class="details" id="getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</code>
163 <pre>Returns the state of the last operation for the service instance.
164Only last (or current) operation can be polled.
165
166Args:
167 name: string, Name must match
168`projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+
169 `service_instances/[INSTANCE_ID]`. (required)
170 planId: string, Plan id.
171 serviceId: string, Service id.
172 x__xgafv: string, V1 error format.
173 Allowed values
174 1 - v1 error format
175 2 - v2 error format
176 operation: string, If `operation` was returned during mutation operation, this field must be
177populated with the provided value.
178
179Returns:
180 An object of the form:
181
182 { # Describes a long running operation, which conforms to OpenService API.
183 "state": "A String", # The state of the operation.
184 # Valid values are: "in progress", "succeeded", and "failed".
185 "description": "A String", # Optional description of the Operation state.
186 }</pre>
187</div>
188
189<div class="method">
190 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
191 <pre>Lists all the instances in the brokers
192This API is an extension and not part of the OSB spec.
193Hence the path is a standard Google API URL.
194
195Args:
196 parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required)
197 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
198returned by a previous list request to get the next page of results.
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203 pageSize: integer, Specifies the number of results to return per page. If there are fewer
204elements than the specified number, returns all elements.
205Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
206
207Returns:
208 An object of the form:
209
210 { # The response for the `ListServiceInstances()` method.
211 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
212 # If the number of results is larger than `pageSize`, use the `nextPageToken`
213 # as a value for the query parameter `pageToken` in the next list request.
214 # Subsequent list requests will have their own `nextPageToken` to continue
215 # paging through the results
216 "instances": [ # The list of instances in the broker.
217 { # Message describing inputs to Provision and Update Service instance requests.
218 "space_guid": "A String", # The identifier for the project space within the platform organization.
219 # Required.
220 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous
221 # fields.
222 "a_key": "", # Properties of the object.
223 },
224 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details.
225 # Maximum length is 64, GUID recommended.
226 # Required.
227 "description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with
228 # other methods.
229 "parameters": { # Configuration options for the service instance.
230 # Parameters is JSON object serialized to string.
231 "a_key": "", # Properties of the object.
232 },
233 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be
234 # provisioned.
235 # Required.
236 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project.
237 # Maximum length is 64, GUID recommended.
238 # Required.
239 "deploymentName": "A String", # Output only.
240 # String containing the Deployment Manager deployment name that was created
241 # for this instance,
242 "context": { # Platform specific contextual information under which the service instance
243 # is to be provisioned. This replaces organization_guid and space_guid.
244 # But can also contain anything.
245 # Currently only used for logging context information.
246 "a_key": "", # Properties of the object.
247 },
248 "service_id": "A String", # The id of the service. Must be a valid identifier of a service
249 # contained in the list from a `ListServices()` call.
250 # Maximum length is 64, GUID recommended.
251 # Required.
252 "resourceName": "A String", # Output only.
253 # The resource name of the instance, e.g.
254 # projects/project_id/brokers/broker_id/service_instances/instance_id
255 "createTime": "A String", # Output only.
256 # Timestamp for when the instance was created.
257 },
258 ],
259 "description": "A String", # Used to communicate description of the response. Usually for non-standard
260 # error codes.
261 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
262 }</pre>
263</div>
264
265<div class="method">
266 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
267 <pre>Retrieves the next page of results.
268
269Args:
270 previous_request: The request for the previous page. (required)
271 previous_response: The response from the request for the previous page. (required)
272
273Returns:
274 A request object that you can call 'execute()' on to request the next
275 page. Returns None if there are no more items in the collection.
276 </pre>
277</div>
278
279</body></html>