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
|
<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.v2.html">v2</a> . <a href="servicebroker_v1beta1.projects.brokers.v2.catalog.html">catalog</a></h1>
<h2>Instance Methods</h2>
<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 Services registered with this broker for consumption for</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="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
<pre>Lists all the Services registered with this broker for consumption for
given service registry broker, which contains an set of services.
Note, that Service producer API is separate from Broker API.
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. If unset or 0, all the results will be returned.
Returns:
An object of the form:
{ # Response message for the `ListCatalog()` method.
"services": [ # The services available for the requested GCP project.
{ # The resource model mostly follows the Open Service Broker API, as
# described here:
# https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md
# Though due to Google Specifics it has additional optional fields.
"plans": [ # A list of plans for this service.
# At least one plan is required.
{ # Plan message describes a Service Plan.
"description": "A String", # Textual description of the plan. Optional.
"free": True or False, # Whether the service is free.
"name": "A String", # User friendly name of the plan.
# The name must be globally unique within GCP project.
# Note, which is different from ("This must be globally unique within a
# platform marketplace").
"bindable": True or False, # Specifies whether instances of the service can be bound to applications.
# If not specified, `Service.bindable` will be presumed.
"schemas": { # Schema definitions for service instances and bindings for the plan.
"a_key": "", # Properties of the object.
},
"id": "A String", # ID is a globally unique identifier used to uniquely identify the plan.
# User must make no presumption about the format of this field.
"metadata": { # A list of metadata for a service offering.
# Metadata is an arbitrary JSON object.
"a_key": "", # Properties of the object.
},
},
],
"binding_retrievable": True or False, # Whether the service provides an endpoint to get service bindings.
"tags": [ # Tags provide a flexible mechanism to expose a classification, attribute, or
# base technology of a service.
"A String",
],
"metadata": { # A list of metadata for a service offering.
# Metadata is an arbitrary JSON object.
"a_key": "", # Properties of the object.
},
"dashboard_client": { # Message containing information required to activate Dashboard SSO feature. # Information to activate Dashboard SSO feature.
"secret": "A String", # A secret for the dashboard client.
"redirect_uri": "A String", # A URI for the service dashboard.
# Validated by the OAuth token server when the dashboard requests a token.
"id": "A String", # The id of the Oauth client that the dashboard will use.
},
"name": "A String", # User friendly service name.
# Name must match [a-z0-9]+ regexp.
# The name must be globally unique within GCP project.
# Note, which is different from ("This must be globally unique within a
# platform marketplace").
# Required.
"plan_updateable": True or False, # Whether the service supports upgrade/downgrade for some plans.
"bindings_retrievable": True or False, # Whether the service provides an endpoint to get service bindings.
"bindable": True or False, # Specifies whether instances of the service can be bound to applications.
# Required.
"instances_retrievable": True or False, # Whether the service provides an endpoint to get service instances.
"id": "A String", # ID is a globally unique identifier used to uniquely identify the service.
# ID is an opaque string.
"description": "A String", # Textual description of the service. Required.
},
],
"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
"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>
|
