• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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> . <a href="servicebroker_v1beta1.projects.brokers.instances.bindings.html">bindings</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</a></code></p>
79<p class="firstline">Returns the state of the last operation for the binding.</p>
80<p class="toc_element">
81  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
82<p class="firstline">Lists all the bindings in the instance.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</code>
89  <pre>Returns the state of the last operation for the binding.
90Only last (or current) operation can be polled.
91
92Args:
93  name: string, Name must match
94`projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/service_binding/[BINDING_ID]`. (required)
95  planId: string, Plan id.
96  serviceId: string, Service id.
97  x__xgafv: string, V1 error format.
98    Allowed values
99      1 - v1 error format
100      2 - v2 error format
101  operation: string, If `operation` was returned during mutation operation, this field must be
102populated with the provided value.
103
104Returns:
105  An object of the form:
106
107    { # Describes a long running operation, which conforms to OpenService API.
108    "state": "A String", # The state of the operation.
109        # Valid values are: "in progress", "succeeded", and "failed".
110    "description": "A String", # Optional description of the Operation state.
111  }</pre>
112</div>
113
114<div class="method">
115    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
116  <pre>Lists all the bindings in the instance.
117
118Args:
119  parent: string, Parent must match
120`projects/[PROJECT_ID]/brokers/[BROKER_ID]/` +
121`v2/service_instances/[INSTANCE_ID]`
122or
123`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. (required)
124  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
125returned by a previous list request to get the next page of results.
126  x__xgafv: string, V1 error format.
127    Allowed values
128      1 - v1 error format
129      2 - v2 error format
130  pageSize: integer, Specifies the number of results to return per page. If there are fewer
131elements than the specified number, returns all elements.
132Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
133
134Returns:
135  An object of the form:
136
137    { # The response for the `ListBindings()` method.
138    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
139        # If the number of results is larger than `pageSize`, use the `nextPageToken`
140        # as a value for the query parameter `pageToken` in the next list request.
141        # Subsequent list requests will have their own `nextPageToken` to continue
142        # paging through the results
143    "bindings": [ # The list of bindings in the instance.
144      { # Describes the binding.
145        "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details.
146            # Maximum length is 64, GUID recommended.
147            # Required.
148        "parameters": { # Configuration options for the service binding.
149          "a_key": "", # Properties of the object.
150        },
151        "deploymentName": "A String", # Output only.
152            # String containing the Deployment Manager deployment name that was created
153            # for this binding,
154        "binding_id": "A String", # The id of the binding. Must be unique within GCP project.
155            # Maximum length is 64, GUID recommended.
156            # Required.
157        "resourceName": "A String", # Output only.
158            # The resource name of the binding, e.g.
159            # projects/project_id/brokers/broker_id/service_instances/instance_id/bindings/binding_id.
160        "bind_resource": { # A JSON object that contains data for platform resources associated with
161            # the binding to be created.
162          "a_key": "", # Properties of the object.
163        },
164        "createTime": "A String", # Output only.
165            # Timestamp for when the binding was created.
166        "service_id": "A String", # The id of the service. Must be a valid identifier of a service
167            # contained in the list from a `ListServices()` call.
168            # Maximum length is 64, GUID recommended.
169            # Required.
170      },
171    ],
172    "description": "A String", # Used to communicate description of the response. Usually for non-standard
173        # error codes.
174        # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
175  }</pre>
176</div>
177
178<div class="method">
179    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
180  <pre>Retrieves the next page of results.
181
182Args:
183  previous_request: The request for the previous page. (required)
184  previous_response: The response from the request for the previous page. (required)
185
186Returns:
187  A request object that you can call 'execute()' on to request the next
188  page. Returns None if there are no more items in the collection.
189    </pre>
190</div>
191
192</body></html>