Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 4fd3d4c4bad3b5edccba7cc76bbde8e29e4c13f2 / . / docs / dyn / servicebroker_v1beta1.projects.brokers.html
blob: 93ebe35ebf703311ad57da38e26419a3b20e1601 [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></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="servicebroker_v1beta1.projects.brokers.instances.html">instances()</a></code>
79</p>
80<p class="firstline">Returns the instances Resource.</p>
81
82<p class="toc_element">
83 <code><a href="servicebroker_v1beta1.projects.brokers.v2.html">v2()</a></code>
84</p>
85<p class="firstline">Returns the v2 Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p>
89<p class="firstline">CreateBroker creates a Broker.</p>
90<p class="toc_element">
91 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
92<p class="firstline">DeleteBroker deletes a Broker.</p>
93<p class="toc_element">
94 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
95<p class="firstline">ListBrokers lists brokers.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<h3>Method Details</h3>
100<div class="method">
101 <code class="details" id="create">create(parent, body, x__xgafv=None)</code>
102 <pre>CreateBroker creates a Broker.
103
104Args:
105 parent: string, The project in which to create broker. (required)
106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # Broker represents a consumable collection of Service Registry catalogs
110 # exposed as an OSB Broker.
111 "url": "A String", # Output only.
112 # URL of the broker OSB-compliant endpoint, for example:
113 # https://servicebroker.googleapis.com/projects/<project>/brokers/<broker>
114 "createTime": "A String", # Output only.
115 # Timestamp for when the broker was created.
116 "name": "A String", # Name of the broker in the format:
117 # <projects>/<project-id>/brokers/<broker>.
118 # This allows for multiple brokers per project which can be used to
119 # enable having custom brokers per GKE cluster, for example.
120 "title": "A String", # User friendly title of the broker.
121 # Limited to 1024 characters. Requests with longer titles will be rejected.
122 }
123
124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
132 { # Broker represents a consumable collection of Service Registry catalogs
133 # exposed as an OSB Broker.
134 "url": "A String", # Output only.
135 # URL of the broker OSB-compliant endpoint, for example:
136 # https://servicebroker.googleapis.com/projects/<project>/brokers/<broker>
137 "createTime": "A String", # Output only.
138 # Timestamp for when the broker was created.
139 "name": "A String", # Name of the broker in the format:
140 # <projects>/<project-id>/brokers/<broker>.
141 # This allows for multiple brokers per project which can be used to
142 # enable having custom brokers per GKE cluster, for example.
143 "title": "A String", # User friendly title of the broker.
144 # Limited to 1024 characters. Requests with longer titles will be rejected.
145 }</pre>
146</div>
147
148<div class="method">
149 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
150 <pre>DeleteBroker deletes a Broker.
151
152Args:
153 name: string, The broker to delete. (required)
154 x__xgafv: string, V1 error format.
155 Allowed values
156 1 - v1 error format
157 2 - v2 error format
158
159Returns:
160 An object of the form:
161
162 { # A generic empty message that you can re-use to avoid defining duplicated
163 # empty messages in your APIs. A typical example is to use it as the request
164 # or the response type of an API method. For instance:
165 #
166 # service Foo {
167 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
168 # }
169 #
170 # The JSON representation for `Empty` is empty JSON object `{}`.
171 }</pre>
172</div>
173
174<div class="method">
175 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
176 <pre>ListBrokers lists brokers.
177
178Args:
179 parent: string, Parent must match `projects/[PROJECT_ID]/brokers`. (required)
180 pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
181returned by a previous list request to get the next page of results.
182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186 pageSize: integer, Specifies the number of results to return per page. If there are fewer
187elements than the specified number, returns all elements.
188Optional. Acceptable values are 0 to 200, inclusive. (Default: 100)
189
190Returns:
191 An object of the form:
192
193 { # The response for the `ListBrokers()` method.
194 "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
195 # If the number of results is larger than `pageSize`, use the `nextPageToken`
196 # as a value for the query parameter `pageToken` in the next list request.
197 # Subsequent list requests will have their own `nextPageToken` to continue
198 # paging through the results
199 "brokers": [ # The list of brokers in the container.
200 { # Broker represents a consumable collection of Service Registry catalogs
201 # exposed as an OSB Broker.
202 "url": "A String", # Output only.
203 # URL of the broker OSB-compliant endpoint, for example:
204 # https://servicebroker.googleapis.com/projects/<project>/brokers/<broker>
205 "createTime": "A String", # Output only.
206 # Timestamp for when the broker was created.
207 "name": "A String", # Name of the broker in the format:
208 # <projects>/<project-id>/brokers/<broker>.
209 # This allows for multiple brokers per project which can be used to
210 # enable having custom brokers per GKE cluster, for example.
211 "title": "A String", # User friendly title of the broker.
212 # Limited to 1024 characters. Requests with longer titles will be rejected.
213 },
214 ],
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
220 <pre>Retrieves the next page of results.
221
222Args:
223 previous_request: The request for the previous page. (required)
224 previous_response: The response from the request for the previous page. (required)
225
226Returns:
227 A request object that you can call 'execute()' on to request the next
228 page. Returns None if there are no more items in the collection.
229 </pre>
230</div>
231
232</body></html>