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.service_instances.html">service_instances</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="servicebroker_v1alpha1.projects.brokers.v2.service_instances.service_bindings.html">service_bindings()</a></code> 79</p> 80<p class="firstline">Returns the service_bindings Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#create">create(parent, instance_id, body, acceptsIncomplete=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Provisions a service instance.</p> 85<p class="toc_element"> 86 <code><a href="#delete">delete(parent, instanceId, acceptsIncomplete=None, planId=None, serviceId=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Deprovisions a service instance.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets the given service instance from the system.</p> 91<p class="toc_element"> 92 <code><a href="#getLast_operation">getLast_operation(parent, instanceId, planId=None, serviceId=None, x__xgafv=None, operation=None)</a></code></p> 93<p class="firstline">Returns the state of the last operation for the service instance.</p> 94<p class="toc_element"> 95 <code><a href="#patch">patch(parent, instance_id, body, acceptsIncomplete=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Updates an existing service instance.</p> 97<h3>Method Details</h3> 98<div class="method"> 99 <code class="details" id="create">create(parent, instance_id, body, acceptsIncomplete=None, x__xgafv=None)</code> 100 <pre>Provisions a service instance. 101If `request.accepts_incomplete` is false and Broker cannot execute request 102synchronously HTTP 422 error will be returned along with 103FAILED_PRECONDITION status. 104If `request.accepts_incomplete` is true and the Broker decides to execute 105resource asynchronously then HTTP 202 response code will be returned and a 106valid polling operation in the response will be included. 107If Broker executes the request synchronously and it succeeds HTTP 201 108response will be furnished. 109If identical instance exists, then HTTP 200 response will be returned. 110If an instance with identical ID but mismatching parameters exists, then 111HTTP 409 status code will be returned. 112 113Args: 114 parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required) 115 instance_id: string, The id of the service instance. Must be unique within GCP project. 116Maximum length is 64, GUID recommended. 117Required. (required) 118 body: object, The request body. (required) 119 The object takes the form of: 120 121{ # Message describing inputs to Provision and Update Service instance requests. 122 "space_guid": "A String", # The identifier for the project space within the platform organization. 123 # Required. 124 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous 125 # fields. 126 "a_key": "", # Properties of the object. 127 }, 128 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details. 129 # Maximum length is 64, GUID recommended. 130 # Required. 131 "parameters": { # Configuration options for the service instance. 132 # Parameters is JSON object serialized to string. 133 "a_key": "", # Properties of the object. 134 }, 135 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 136 # provisioned. 137 # Required. 138 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 139 # Maximum length is 64, GUID recommended. 140 # Required. 141 "deploymentName": "A String", # Output only. 142 # Name of the Deployment Manager deployment used for provisioning of this 143 # service instance. 144 "context": { # Platform specific contextual information under which the service instance 145 # is to be provisioned. This replaces organization_guid and space_guid. 146 # But can also contain anything. 147 # Currently only used for logging context information. 148 "a_key": "", # Properties of the object. 149 }, 150 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 151 # contained in the list from a `ListServices()` call. 152 # Maximum length is 64, GUID recommended. 153 # Required. 154 "resourceName": "A String", # Output only. 155 # The resource name of the instance, e.g. 156 # projects/project_id/brokers/broker_id/service_instances/instance_id 157 "createTime": "A String", # Output only. 158 # Timestamp for when the instance was created. 159} 160 161 acceptsIncomplete: boolean, Value indicating that API client supports asynchronous operations. If 162Broker cannot execute the request synchronously HTTP 422 code will be 163returned to HTTP clients along with FAILED_PRECONDITION error. 164If true and broker will execute request asynchronously 202 HTTP code will 165be returned. 166This broker always requires this to be true as all mutator operations are 167asynchronous. 168 x__xgafv: string, V1 error format. 169 Allowed values 170 1 - v1 error format 171 2 - v2 error format 172 173Returns: 174 An object of the form: 175 176 { # Response for the `CreateServiceInstance()` method. 177 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 178 # can be polled to check the completion status of said operation. 179 # This broker always will return a non-empty operation on success. 180 "description": "A String", # Used to communicate description of the response. Usually for non-standard 181 # error codes. 182 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 183 }</pre> 184</div> 185 186<div class="method"> 187 <code class="details" id="delete">delete(parent, instanceId, acceptsIncomplete=None, planId=None, serviceId=None, x__xgafv=None)</code> 188 <pre>Deprovisions a service instance. 189For synchronous/asynchronous request details see CreateServiceInstance 190method. 191If service instance does not exist HTTP 410 status will be returned. 192 193Args: 194 parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required) 195 instanceId: string, The instance id to deprovision. (required) 196 acceptsIncomplete: boolean, See CreateServiceInstanceRequest for details. 197 planId: string, The plan id of the service instance. 198 serviceId: string, The service id of the service instance. 199 x__xgafv: string, V1 error format. 200 Allowed values 201 1 - v1 error format 202 2 - v2 error format 203 204Returns: 205 An object of the form: 206 207 { # Response for the `DeleteServiceInstance()` method. 208 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 209 # can be polled to check the completion status of said operation. 210 "description": "A String", # Used to communicate description of the response. Usually for non-standard 211 # error codes. 212 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 213 }</pre> 214</div> 215 216<div class="method"> 217 <code class="details" id="get">get(name, x__xgafv=None)</code> 218 <pre>Gets the given service instance from the system. 219This API is an extension and not part of the OSB spec. 220Hence the path is a standard Google API URL. 221 222Args: 223 name: string, The resource name of the instance to return. (required) 224 x__xgafv: string, V1 error format. 225 Allowed values 226 1 - v1 error format 227 2 - v2 error format 228 229Returns: 230 An object of the form: 231 232 { # Message describing inputs to Provision and Update Service instance requests. 233 "space_guid": "A String", # The identifier for the project space within the platform organization. 234 # Required. 235 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous 236 # fields. 237 "a_key": "", # Properties of the object. 238 }, 239 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details. 240 # Maximum length is 64, GUID recommended. 241 # Required. 242 "parameters": { # Configuration options for the service instance. 243 # Parameters is JSON object serialized to string. 244 "a_key": "", # Properties of the object. 245 }, 246 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 247 # provisioned. 248 # Required. 249 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 250 # Maximum length is 64, GUID recommended. 251 # Required. 252 "deploymentName": "A String", # Output only. 253 # Name of the Deployment Manager deployment used for provisioning of this 254 # service instance. 255 "context": { # Platform specific contextual information under which the service instance 256 # is to be provisioned. This replaces organization_guid and space_guid. 257 # But can also contain anything. 258 # Currently only used for logging context information. 259 "a_key": "", # Properties of the object. 260 }, 261 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 262 # contained in the list from a `ListServices()` call. 263 # Maximum length is 64, GUID recommended. 264 # Required. 265 "resourceName": "A String", # Output only. 266 # The resource name of the instance, e.g. 267 # projects/project_id/brokers/broker_id/service_instances/instance_id 268 "createTime": "A String", # Output only. 269 # Timestamp for when the instance was created. 270 }</pre> 271</div> 272 273<div class="method"> 274 <code class="details" id="getLast_operation">getLast_operation(parent, instanceId, planId=None, serviceId=None, x__xgafv=None, operation=None)</code> 275 <pre>Returns the state of the last operation for the service instance. 276Only last (or current) operation can be polled. 277 278Args: 279 parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required) 280 instanceId: string, The instance id for which to return the last operation status. (required) 281 planId: string, Plan id. 282 serviceId: string, Service id. 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 operation: string, If `operation` was returned during mutation operation, this field must be 288populated with the provided value. 289 290Returns: 291 An object of the form: 292 293 { # Describes a long running operation, which conforms to OpenService API. 294 "state": "A String", # The state of the operation. 295 # Valid values are: "in progress", "succeeded", and "failed". 296 "description": "A String", # Optional description of the Operation state. 297 }</pre> 298</div> 299 300<div class="method"> 301 <code class="details" id="patch">patch(parent, instance_id, body, acceptsIncomplete=None, x__xgafv=None)</code> 302 <pre>Updates an existing service instance. 303See CreateServiceInstance for possible response codes. 304 305Args: 306 parent: string, Parent must match `projects/[PROJECT_ID]/brokers/[BROKER_ID]`. (required) 307 instance_id: string, The id of the service instance. Must be unique within GCP project. 308Maximum length is 64, GUID recommended. 309Required. (required) 310 body: object, The request body. (required) 311 The object takes the form of: 312 313{ # Message describing inputs to Provision and Update Service instance requests. 314 "space_guid": "A String", # The identifier for the project space within the platform organization. 315 # Required. 316 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous 317 # fields. 318 "a_key": "", # Properties of the object. 319 }, 320 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details. 321 # Maximum length is 64, GUID recommended. 322 # Required. 323 "parameters": { # Configuration options for the service instance. 324 # Parameters is JSON object serialized to string. 325 "a_key": "", # Properties of the object. 326 }, 327 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 328 # provisioned. 329 # Required. 330 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 331 # Maximum length is 64, GUID recommended. 332 # Required. 333 "deploymentName": "A String", # Output only. 334 # Name of the Deployment Manager deployment used for provisioning of this 335 # service instance. 336 "context": { # Platform specific contextual information under which the service instance 337 # is to be provisioned. This replaces organization_guid and space_guid. 338 # But can also contain anything. 339 # Currently only used for logging context information. 340 "a_key": "", # Properties of the object. 341 }, 342 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 343 # contained in the list from a `ListServices()` call. 344 # Maximum length is 64, GUID recommended. 345 # Required. 346 "resourceName": "A String", # Output only. 347 # The resource name of the instance, e.g. 348 # projects/project_id/brokers/broker_id/service_instances/instance_id 349 "createTime": "A String", # Output only. 350 # Timestamp for when the instance was created. 351} 352 353 acceptsIncomplete: boolean, See CreateServiceInstanceRequest for details. 354 x__xgafv: string, V1 error format. 355 Allowed values 356 1 - v1 error format 357 2 - v2 error format 358 359Returns: 360 An object of the form: 361 362 { # Response for the `UpdateServiceInstance()` method. 363 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 364 # can be polled to check the completion status of said operation. 365 "description": "A String", # Used to communicate description of the response. Usually for non-standard 366 # error codes. 367 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 368 }</pre> 369</div> 370 371</body></html>