• 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_v1alpha1.html">Service Broker API</a> . <a href="servicebroker_v1alpha1.projects.html">projects</a> . <a href="servicebroker_v1alpha1.projects.brokers.html">brokers</a> . <a href="servicebroker_v1alpha1.projects.brokers.v2.html">v2</a> . <a href="servicebroker_v1alpha1.projects.brokers.v2.catalog.html">catalog</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
79<p class="firstline">Lists all the Services registered with this broker for consumption for</p>
80<p class="toc_element">
81  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
86  <pre>Lists all the Services registered with this broker for consumption for
87given service registry broker, which contains an set of services.
88Note, that Service producer API is separate from Broker API.
89
90Args:
91  parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required)
92  pageToken: string, Specifies a page token to use. Set `pageToken` to a `nextPageToken`
93returned by a previous list request to get the next page of results.
94  x__xgafv: string, V1 error format.
95    Allowed values
96      1 - v1 error format
97      2 - v2 error format
98  pageSize: integer, Specifies the number of results to return per page. If there are fewer
99elements than the specified number, returns all elements.
100Optional. If unset or 0, all the results will be returned.
101
102Returns:
103  An object of the form:
104
105    { # Response message for the `ListCatalog()` method.
106    "services": [ # The services available for the requested GCP project.
107      { # The resource model mostly follows the Open Service Broker API, as
108          # described here:
109          # https://github.com/openservicebrokerapi/servicebroker/blob/master/_spec.md
110          # Though due to Google Specifics it has additional optional fields.
111        "name": "A String", # User friendly service name.
112            # Name must match [a-z0-9]+ regexp.
113            # The name must be globally unique within GCP project.
114            # Note, which is different from ("This must be globally unique within a
115            # platform marketplace").
116            # Required.
117        "binding_retrievable": True or False, # Whether the service provides an endpoint to get service bindings.
118        "tags": [ # Tags provide a flexible mechanism to expose a classification, attribute, or
119            # base technology of a service.
120          "A String",
121        ],
122        "plans": [ # A list of plans for this service.
123            # At least one plan is required.
124          { # Plan message describes a Service Plan.
125            "name": "A String", # User friendly name of the plan.
126                # The name must be globally unique within GCP project.
127                # Note, which is different from ("This must be globally unique within a
128                # platform marketplace").
129            "description": "A String", # Textual description of the plan. Optional.
130            "free": True or False, # Whether the service is free.
131            "bindable": True or False, # Specifies whether instances of the service can be bound to applications.
132                # If not specified, `Service.bindable` will be presumed.
133            "schemas": { # Schema definitions for service instances and bindings for the plan.
134              "a_key": "", # Properties of the object.
135            },
136            "id": "A String", # ID is a globally unique identifier used to uniquely identify the plan.
137                # User must make no presumption about the format of this field.
138            "metadata": { # A list of metadata for a service offering.
139                # Metadata is an arbitrary JSON object.
140              "a_key": "", # Properties of the object.
141            },
142          },
143        ],
144        "description": "A String", # Textual description of the service. Required.
145        "dashboard_client": { # Message containing information required to activate Dashboard SSO feature. # Information to activate Dashboard SSO feature.
146          "secret": "A String", # A secret for the dashboard client.
147          "redirect_uri": "A String", # A URI for the service dashboard.
148              # Validated by the OAuth token server when the dashboard requests a token.
149          "id": "A String", # The id of the Oauth client that the dashboard will use.
150        },
151        "plan_updateable": True or False, # Whether the service supports upgrade/downgrade for some plans.
152        "bindable": True or False, # Specifies whether instances of the service can be bound to applications.
153            # Required.
154        "instance_retrievable": True or False, # Whether the service provides an endpoint to get service instances.
155        "id": "A String", # ID is a globally unique identifier used to uniquely identify the service.
156            # ID is an opaque string.
157        "metadata": { # A list of metadata for a service offering.
158            # Metadata is an arbitrary JSON object.
159          "a_key": "", # Properties of the object.
160        },
161      },
162    ],
163    "nextPageToken": "A String", # This token allows you to get the next page of results for list requests.
164        # If the number of results is larger than `pageSize`, use the `nextPageToken`
165        # as a value for the query parameter `pageToken` in the next list request.
166        # Subsequent list requests will have their own `nextPageToken` to continue
167        # paging through the results
168    "description": "A String", # Used to communicate description of the response. Usually for non-standard
169        # error codes.
170        # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors
171  }</pre>
172</div>
173
174<div class="method">
175    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176  <pre>Retrieves the next page of results.
177
178Args:
179  previous_request: The request for the previous page. (required)
180  previous_response: The response from the request for the previous page. (required)
181
182Returns:
183  A request object that you can call 'execute()' on to request the next
184  page. Returns None if there are no more items in the collection.
185    </pre>
186</div>
187
188</body></html>