Class: Google::Apis::ServicebrokerV1alpha1::ServiceBrokerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/servicebroker_v1alpha1/service.rb

Overview

Service Broker API

The Google Cloud Platform Service Broker API provides Google hosted implementation of the Open Service Broker API (https://www.openservicebrokerapi.org/).

Examples:

require 'google/apis/servicebroker_v1alpha1'

Servicebroker = Google::Apis::ServicebrokerV1alpha1 # Alias the module
service = Servicebroker::ServiceBrokerService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ ServiceBrokerService

Returns a new instance of ServiceBrokerService



47
48
49
50
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 47

def initialize
  super('https://servicebroker.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_project_broker_v2_service_instance(parent, instance_id, google_cloud_servicebroker_v1alpha1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateServiceInstanceResponse

Provisions a service instance. If request.accepts_incomplete is false and Broker cannot execute request synchronously HTTP 422 error will be returned along with FAILED_PRECONDITION status. If request.accepts_incomplete is true and the Broker decides to execute resource asynchronously then HTTP 202 response code will be returned and a valid polling operation in the response will be included. If Broker executes the request synchronously and it succeeds HTTP 201 response will be furnished. If identical instance exists, then HTTP 200 response will be returned. If an instance with identical ID but mismatching parameters exists, then HTTP 409 status code will be returned.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.

  • google_cloud_servicebroker_v1alpha1__service_instance_object (Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance) (defaults to: nil)
  • accepts_incomplete (Boolean) —

    Value indicating that API client supports asynchronous operations. If Broker cannot execute the request synchronously HTTP 422 code will be returned to HTTP clients along with FAILED_PRECONDITION error. If true and broker will execute request asynchronously 202 HTTP code will be returned. This broker always requires this to be true as all mutator operations are asynchronous.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 250

def create_project_broker_v2_service_instance(parent, instance_id, google_cloud_servicebroker_v1alpha1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1alpha1/{+parent}/v2/service_instances/{+instance_id}', options)
  command.request_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance::Representation
  command.request_object = google_cloud_servicebroker_v1alpha1__service_instance_object
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateServiceInstanceResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instance_id'] = instance_id unless instance_id.nil?
  command.query['acceptsIncomplete'] = accepts_incomplete unless accepts_incomplete.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, google_cloud_servicebroker_v1alpha1__binding_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateBindingResponse

CreateBinding generates a service binding to an existing service instance. See ProviServiceInstance for async operation details.

Parameters:

  • parent (String) —

    The GCP container. Must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The service instance to which to bind.

  • binding_id (String) —

    The id of the binding. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.

  • google_cloud_servicebroker_v1alpha1__binding_object (Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Binding) (defaults to: nil)
  • accepts_incomplete (Boolean) —

    See CreateServiceInstanceRequest for details.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 459

def create_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, google_cloud_servicebroker_v1alpha1__binding_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+binding_id}', options)
  command.request_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Binding::Representation
  command.request_object = google_cloud_servicebroker_v1alpha1__binding_object
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1CreateBindingResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.params['binding_id'] = binding_id unless binding_id.nil?
  command.query['acceptsIncomplete'] = accepts_incomplete unless accepts_incomplete.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_broker_v2_service_instance(parent, instance_id, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteServiceInstanceResponse

Deprovisions a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If service instance does not exist HTTP 410 status will be returned.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The instance id to deprovision.

  • accepts_incomplete (Boolean) —

    See CreateServiceInstanceRequest for details.

  • plan_id (String) —

    The plan id of the service instance.

  • service_id (String) —

    The service id of the service instance.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 295

def delete_project_broker_v2_service_instance(parent, instance_id, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1alpha1/{+parent}/v2/service_instances/{+instanceId}', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteServiceInstanceResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.query['acceptsIncomplete'] = accepts_incomplete unless accepts_incomplete.nil?
  command.query['planId'] = plan_id unless plan_id.nil?
  command.query['serviceId'] = service_id unless service_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteBindingResponse

Unbinds from a service instance. For synchronous/asynchronous request details see CreateServiceInstance method. If binding does not exist HTTP 410 status will be returned.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The service instance id that deleted binding is bound to.

  • binding_id (String) —

    The id of the binding to delete.

  • accepts_incomplete (Boolean) —

    See CreateServiceInstanceRequest for details.

  • plan_id (String) —

    The plan id of the service instance.

  • service_id (String) —

    Additional query parameter hints. The service id of the service instance.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



508
509
510
511
512
513
514
515
516
517
518
519
520
521
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 508

def delete_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1alpha1/{+parent}/v2/service_instances/{instanceId}/service_bindings/{bindingId}', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1DeleteBindingResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.params['bindingId'] = binding_id unless binding_id.nil?
  command.query['acceptsIncomplete'] = accepts_incomplete unless accepts_incomplete.nil?
  command.query['planId'] = plan_id unless plan_id.nil?
  command.query['serviceId'] = service_id unless service_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_iam_policy(resource, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



635
636
637
638
639
640
641
642
643
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 635

def get_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_broker_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance

Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL.

Parameters:

  • name (String) —

    The resource name of the instance to return.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



74
75
76
77
78
79
80
81
82
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 74

def get_project_broker_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_broker_v2_service_instance(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance

Gets the given service instance from the system. This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL.

Parameters:

  • name (String) —

    The resource name of the instance to return.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



331
332
333
334
335
336
337
338
339
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 331

def get_project_broker_v2_service_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_broker_v2_service_instance_last_operation(parent, instance_id, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation

Returns the state of the last operation for the service instance. Only last (or current) operation can be polled.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The instance id for which to return the last operation status.

  • operation (String) —

    If operation was returned during mutation operation, this field must be populated with the provided value.

  • plan_id (String) —

    Plan id.

  • service_id (String) —

    Service id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 371

def get_project_broker_v2_service_instance_last_operation(parent, instance_id, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/v2/service_instances/{+instanceId}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.query['operation'] = operation unless operation.nil?
  command.query['planId'] = plan_id unless plan_id.nil?
  command.query['serviceId'] = service_id unless service_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1GetBindingResponse

GetBinding returns the binding information.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    Instance id to which the binding is bound.

  • binding_id (String) —

    The binding id.

  • plan_id (String) —

    Plan id.

  • service_id (String) —

    Service id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 551

def get_project_broker_v2_service_instance_service_binding(parent, instance_id, binding_id, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+bindingId}', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1GetBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1GetBindingResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.params['bindingId'] = binding_id unless binding_id.nil?
  command.query['planId'] = plan_id unless plan_id.nil?
  command.query['serviceId'] = service_id unless service_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_broker_v2_service_instance_service_binding_last_operation(parent, instance_id, binding_id, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation

Returns the state of the last operation for the binding. Only last (or current) operation can be polled.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The instance id that the binding is bound to.

  • binding_id (String) —

    The binding id for which to return the last operation

  • operation (String) —

    If operation was returned during mutation operation, this field must be populated with the provided value.

  • plan_id (String) —

    Plan id.

  • service_id (String) —

    Service id.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



597
598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 597

def get_project_broker_v2_service_instance_service_binding_last_operation(parent, instance_id, binding_id, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/v2/service_instances/{+instanceId}/service_bindings/{+bindingId}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1Operation
  command.params['parent'] = parent unless parent.nil?
  command.params['instanceId'] = instance_id unless instance_id.nil?
  command.params['bindingId'] = binding_id unless binding_id.nil?
  command.query['operation'] = operation unless operation.nil?
  command.query['planId'] = plan_id unless plan_id.nil?
  command.query['serviceId'] = service_id unless service_id.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_broker_instance_service_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListBindingsResponse

Lists all the bindings in the instance

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID].

  • page_size (Fixnum) —

    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.

  • page_token (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



112
113
114
115
116
117
118
119
120
121
122
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 112

def list_project_broker_instance_service_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/service_bindings', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListBindingsResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListBindingsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_broker_service_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListServiceInstancesResponse

Lists all the instances in the brokers This API is an extension and not part of the OSB spec. Hence the path is a standard Google API URL.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • page_size (Fixnum) —

    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.

  • page_token (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



153
154
155
156
157
158
159
160
161
162
163
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 153

def list_project_broker_service_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/service_instances', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListServiceInstancesResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListServiceInstancesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_broker_v2_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListCatalogResponse

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.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • page_size (Fixnum) —

    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.

  • page_token (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.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



194
195
196
197
198
199
200
201
202
203
204
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 194

def list_project_broker_v2_catalogs(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1alpha1/{+parent}/v2/catalog', options)
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListCatalogResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ListCatalogResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_broker_v2_service_instance(parent, instance_id, google_cloud_servicebroker_v1alpha1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1UpdateServiceInstanceResponse

Updates an existing service instance. See CreateServiceInstance for possible response codes.

Parameters:

  • parent (String) —

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID].

  • instance_id (String) —

    The id of the service instance. Must be unique within GCP project. Maximum length is 64, GUID recommended. Required.

  • google_cloud_servicebroker_v1alpha1__service_instance_object (Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance) (defaults to: nil)
  • accepts_incomplete (Boolean) —

    See CreateServiceInstanceRequest for details.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 413

def patch_project_broker_v2_service_instance(parent, instance_id, google_cloud_servicebroker_v1alpha1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1alpha1/{+parent}/v2/service_instances/{+instance_id}', options)
  command.request_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1ServiceInstance::Representation
  command.request_object = google_cloud_servicebroker_v1alpha1__service_instance_object
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1UpdateServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleCloudServicebrokerV1alpha1UpdateServiceInstanceResponse
  command.params['parent'] = parent unless parent.nil?
  command.params['instance_id'] = instance_id unless instance_id.nil?
  command.query['acceptsIncomplete'] = accepts_incomplete unless accepts_incomplete.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy

Sets the access control policy on the specified resource. Replaces any existing policy.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__set_iam_policy_request_object (Google::Apis::ServicebrokerV1alpha1::GoogleIamV1SetIamPolicyRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



668
669
670
671
672
673
674
675
676
677
678
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 668

def set_iam_policy(resource, google_iam_v1__set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1__set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1alpha1::GoogleIamV1TestIamPermissionsResponse

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

  • resource (String) —

    REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

  • google_iam_v1__test_iam_permissions_request_object (Google::Apis::ServicebrokerV1alpha1::GoogleIamV1TestIamPermissionsRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



707
708
709
710
711
712
713
714
715
716
717
 
# File 'generated/google/apis/servicebroker_v1alpha1/service.rb', line 707

def test_iam_permissions(resource, google_iam_v1__test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1alpha1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1__test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1alpha1::GoogleIamV1TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end