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.v2.html">v2</a> . <a href="servicebroker_v1beta1.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_v1beta1.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(name, 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(name, 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(name, 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 "description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with 132 # other methods. 133 "parameters": { # Configuration options for the service instance. 134 # Parameters is JSON object serialized to string. 135 "a_key": "", # Properties of the object. 136 }, 137 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 138 # provisioned. 139 # Required. 140 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 141 # Maximum length is 64, GUID recommended. 142 # Required. 143 "deploymentName": "A String", # Output only. 144 # String containing the Deployment Manager deployment name that was created 145 # for this instance, 146 "context": { # Platform specific contextual information under which the service instance 147 # is to be provisioned. This replaces organization_guid and space_guid. 148 # But can also contain anything. 149 # Currently only used for logging context information. 150 "a_key": "", # Properties of the object. 151 }, 152 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 153 # contained in the list from a `ListServices()` call. 154 # Maximum length is 64, GUID recommended. 155 # Required. 156 "resourceName": "A String", # Output only. 157 # The resource name of the instance, e.g. 158 # projects/project_id/brokers/broker_id/service_instances/instance_id 159 "createTime": "A String", # Output only. 160 # Timestamp for when the instance was created. 161} 162 163 acceptsIncomplete: boolean, Value indicating that API client supports asynchronous operations. If 164Broker cannot execute the request synchronously HTTP 422 code will be 165returned to HTTP clients along with FAILED_PRECONDITION error. 166If true and broker will execute request asynchronously 202 HTTP code will 167be returned. 168This broker always requires this to be true as all mutator operations are 169asynchronous. 170 x__xgafv: string, V1 error format. 171 Allowed values 172 1 - v1 error format 173 2 - v2 error format 174 175Returns: 176 An object of the form: 177 178 { # Response for the `CreateServiceInstance()` method. 179 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 180 # can be polled to check the completion status of said operation. 181 # This broker always will return a non-empty operation on success. 182 "description": "A String", # Used to communicate description of the response. Usually for non-standard 183 # error codes. 184 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 185 }</pre> 186</div> 187 188<div class="method"> 189 <code class="details" id="delete">delete(name, acceptsIncomplete=None, planId=None, serviceId=None, x__xgafv=None)</code> 190 <pre>Deprovisions a service instance. 191For synchronous/asynchronous request details see CreateServiceInstance 192method. 193If service instance does not exist HTTP 410 status will be returned. 194 195Args: 196 name: string, Name must match 197`projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + 198`v2/service_instances/[INSTANCE_ID]` 199or 200`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. (required) 201 acceptsIncomplete: boolean, See CreateServiceInstanceRequest for details. 202 planId: string, The plan id of the service instance. 203 serviceId: string, The service id of the service instance. 204 x__xgafv: string, V1 error format. 205 Allowed values 206 1 - v1 error format 207 2 - v2 error format 208 209Returns: 210 An object of the form: 211 212 { # Response for the `DeleteServiceInstance()` method. 213 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 214 # can be polled to check the completion status of said operation. 215 "description": "A String", # Used to communicate description of the response. Usually for non-standard 216 # error codes. 217 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 218 }</pre> 219</div> 220 221<div class="method"> 222 <code class="details" id="get">get(name, x__xgafv=None)</code> 223 <pre>Gets the given service instance from the system. 224The API call accepts both OSB style API and standard google style API 225resource path. 226i.e. both `projects/*/brokers/*/instances/*` 227 and `projects/*/brokers/*/v2/service_instances/*` are acceptable paths. 228 229Args: 230 name: string, The resource name of the instance to return. 231Name must match 232`projects/[PROJECT_ID]/brokers/[BROKER_ID]/` + 233`v2/service_instances/[INSTANCE_ID]` 234or 235`projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID]`. (required) 236 x__xgafv: string, V1 error format. 237 Allowed values 238 1 - v1 error format 239 2 - v2 error format 240 241Returns: 242 An object of the form: 243 244 { # Message describing inputs to Provision and Update Service instance requests. 245 "space_guid": "A String", # The identifier for the project space within the platform organization. 246 # Required. 247 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous 248 # fields. 249 "a_key": "", # Properties of the object. 250 }, 251 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details. 252 # Maximum length is 64, GUID recommended. 253 # Required. 254 "description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with 255 # other methods. 256 "parameters": { # Configuration options for the service instance. 257 # Parameters is JSON object serialized to string. 258 "a_key": "", # Properties of the object. 259 }, 260 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 261 # provisioned. 262 # Required. 263 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 264 # Maximum length is 64, GUID recommended. 265 # Required. 266 "deploymentName": "A String", # Output only. 267 # String containing the Deployment Manager deployment name that was created 268 # for this instance, 269 "context": { # Platform specific contextual information under which the service instance 270 # is to be provisioned. This replaces organization_guid and space_guid. 271 # But can also contain anything. 272 # Currently only used for logging context information. 273 "a_key": "", # Properties of the object. 274 }, 275 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 276 # contained in the list from a `ListServices()` call. 277 # Maximum length is 64, GUID recommended. 278 # Required. 279 "resourceName": "A String", # Output only. 280 # The resource name of the instance, e.g. 281 # projects/project_id/brokers/broker_id/service_instances/instance_id 282 "createTime": "A String", # Output only. 283 # Timestamp for when the instance was created. 284 }</pre> 285</div> 286 287<div class="method"> 288 <code class="details" id="getLast_operation">getLast_operation(name, planId=None, serviceId=None, x__xgafv=None, operation=None)</code> 289 <pre>Returns the state of the last operation for the service instance. 290Only last (or current) operation can be polled. 291 292Args: 293 name: string, Name must match 294`projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/`+ 295 `service_instances/[INSTANCE_ID]`. (required) 296 planId: string, Plan id. 297 serviceId: string, Service id. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 operation: string, If `operation` was returned during mutation operation, this field must be 303populated with the provided value. 304 305Returns: 306 An object of the form: 307 308 { # Describes a long running operation, which conforms to OpenService API. 309 "state": "A String", # The state of the operation. 310 # Valid values are: "in progress", "succeeded", and "failed". 311 "description": "A String", # Optional description of the Operation state. 312 }</pre> 313</div> 314 315<div class="method"> 316 <code class="details" id="patch">patch(name, body, acceptsIncomplete=None, x__xgafv=None)</code> 317 <pre>Updates an existing service instance. 318See CreateServiceInstance for possible response codes. 319 320Args: 321 name: string, Name must match 322`projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]`. (required) 323 body: object, The request body. (required) 324 The object takes the form of: 325 326{ # Message describing inputs to Provision and Update Service instance requests. 327 "space_guid": "A String", # The identifier for the project space within the platform organization. 328 # Required. 329 "previous_values": { # Used only in UpdateServiceInstance request to optionally specify previous 330 # fields. 331 "a_key": "", # Properties of the object. 332 }, 333 "plan_id": "A String", # The ID of the plan. See `Service` and `Plan` resources for details. 334 # Maximum length is 64, GUID recommended. 335 # Required. 336 "description": "A String", # To return errors when GetInstance call is done via HTTP to be unified with 337 # other methods. 338 "parameters": { # Configuration options for the service instance. 339 # Parameters is JSON object serialized to string. 340 "a_key": "", # Properties of the object. 341 }, 342 "organization_guid": "A String", # The platform GUID for the organization under which the service is to be 343 # provisioned. 344 # Required. 345 "instance_id": "A String", # The id of the service instance. Must be unique within GCP project. 346 # Maximum length is 64, GUID recommended. 347 # Required. 348 "deploymentName": "A String", # Output only. 349 # String containing the Deployment Manager deployment name that was created 350 # for this instance, 351 "context": { # Platform specific contextual information under which the service instance 352 # is to be provisioned. This replaces organization_guid and space_guid. 353 # But can also contain anything. 354 # Currently only used for logging context information. 355 "a_key": "", # Properties of the object. 356 }, 357 "service_id": "A String", # The id of the service. Must be a valid identifier of a service 358 # contained in the list from a `ListServices()` call. 359 # Maximum length is 64, GUID recommended. 360 # Required. 361 "resourceName": "A String", # Output only. 362 # The resource name of the instance, e.g. 363 # projects/project_id/brokers/broker_id/service_instances/instance_id 364 "createTime": "A String", # Output only. 365 # Timestamp for when the instance was created. 366} 367 368 acceptsIncomplete: boolean, See CreateServiceInstanceRequest for details. 369 x__xgafv: string, V1 error format. 370 Allowed values 371 1 - v1 error format 372 2 - v2 error format 373 374Returns: 375 An object of the form: 376 377 { # Response for the `UpdateServiceInstance()` method. 378 "operation": "A String", # If broker executes operation asynchronously, this is the operation ID that 379 # can be polled to check the completion status of said operation. 380 "description": "A String", # Used to communicate description of the response. Usually for non-standard 381 # error codes. 382 # https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md#service-broker-errors 383 }</pre> 384</div> 385 386</body></html>