Class: Google::Apis::ServicebrokerV1beta1::ServiceBrokerService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/servicebroker_v1beta1/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_v1beta1'

Servicebroker = Google::Apis::ServicebrokerV1beta1 # 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

#initializeServiceBrokerService

Returns a new instance of ServiceBrokerService


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

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

Instance Attribute Details

#keyString

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_v1beta1/service.rb', line 40

def key
  @key
end

#quota_userString

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_v1beta1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#create_project_broker(parent, google_cloud_servicebroker_v1beta1__broker_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Broker

CreateBroker creates a Broker.

Parameters:

  • parent (String)

    The project in which to create broker.

  • google_cloud_servicebroker_v1beta1__broker_object (Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Broker) (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:


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

def create_project_broker(parent, google_cloud_servicebroker_v1beta1__broker_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+parent}/brokers', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Broker::Representation
  command.request_object = google_cloud_servicebroker_v1beta1__broker_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Broker::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Broker
  command.params['parent'] = parent unless parent.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(parent, instance_id, google_cloud_servicebroker_v1beta1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateServiceInstanceResponse

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_v1beta1__service_instance_object (Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance) (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:


448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 448

def create_project_broker_v2_service_instance(parent, instance_id, google_cloud_servicebroker_v1beta1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+parent}/v2/service_instances/{+instance_id}', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance::Representation
  command.request_object = google_cloud_servicebroker_v1beta1__service_instance_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateServiceInstanceResponse
  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, binding_id, google_cloud_servicebroker_v1beta1__binding_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateBindingResponse

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]/v2/service_instances/[INSTANCE_ID].

  • binding_id (String)

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

  • google_cloud_servicebroker_v1beta1__binding_object (Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Binding) (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:


658
659
660
661
662
663
664
665
666
667
668
669
670
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 658

def create_project_broker_v2_service_instance_service_binding(parent, binding_id, google_cloud_servicebroker_v1beta1__binding_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+parent}/service_bindings/{+binding_id}', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Binding::Representation
  command.request_object = google_cloud_servicebroker_v1beta1__binding_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1CreateBindingResponse
  command.params['parent'] = parent unless parent.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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleProtobufEmpty

DeleteBroker deletes a Broker.

Parameters:

  • name (String)

    The broker to delete.

  • 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:


105
106
107
108
109
110
111
112
113
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 105

def delete_project_broker(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleProtobufEmpty
  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

#delete_project_broker_v2_service_instance(name, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteServiceInstanceResponse

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:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/ + v2/service_instances/[INSTANCE_ID] or projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_ID].

  • 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:


495
496
497
498
499
500
501
502
503
504
505
506
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 495

def delete_project_broker_v2_service_instance(name, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteServiceInstanceResponse
  command.params['name'] = name unless name.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(name, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteBindingResponse

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:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/ v2/service_instances/[INSTANCE_ID]/service_bindings/[BINDING_ID] or projects/[PROJECT_ID]/brokers/[BROKER_ID]/ /instances/[INSTANCE_ID]/bindings/[BINDING_ID].

  • 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:


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

def delete_project_broker_v2_service_instance_service_binding(name, accepts_incomplete: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1DeleteBindingResponse
  command.params['name'] = name unless name.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::ServicebrokerV1beta1::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:


824
825
826
827
828
829
830
831
832
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 824

def get_iam_policy(resource, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::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::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance

Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both projects/*/brokers/*/instances/* and projects/*/brokers/*/v2/service_instances/* are acceptable paths.

Parameters:

  • name (String)

    The resource name of the instance to return. Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/ + v2/service_instances/[INSTANCE_ID] or projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_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:


183
184
185
186
187
188
189
190
191
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 183

def get_project_broker_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance
  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_instance_binding_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation

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

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/ service_binding/[BINDING_ID].

  • 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:


307
308
309
310
311
312
313
314
315
316
317
318
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 307

def get_project_broker_instance_binding_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation
  command.params['name'] = name unless name.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_instance_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation

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

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/+ service_instances/[INSTANCE_ID].

  • 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:


223
224
225
226
227
228
229
230
231
232
233
234
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 223

def get_project_broker_instance_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation
  command.params['name'] = name unless name.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(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance

Gets the given service instance from the system. The API call accepts both OSB style API and standard google style API resource path. i.e. both projects/*/brokers/*/instances/* and projects/*/brokers/*/v2/service_instances/* are acceptable paths.

Parameters:

  • name (String)

    The resource name of the instance to return. Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/ + v2/service_instances/[INSTANCE_ID] or projects/[PROJECT_ID]/brokers/[BROKER_ID]/instances/[INSTANCE_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:


537
538
539
540
541
542
543
544
545
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 537

def get_project_broker_v2_service_instance(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance
  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(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation

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

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/+ service_instances/[INSTANCE_ID].

  • 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:


577
578
579
580
581
582
583
584
585
586
587
588
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 577

def get_project_broker_v2_service_instance_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation
  command.params['name'] = name unless name.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(name, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1GetBindingResponse

GetBinding returns the binding information.

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/ service_bindings.

  • 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:


746
747
748
749
750
751
752
753
754
755
756
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 746

def get_project_broker_v2_service_instance_service_binding(name, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1GetBindingResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1GetBindingResponse
  command.params['name'] = name unless name.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(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation

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

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID]/ service_binding/[BINDING_ID].

  • 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:


788
789
790
791
792
793
794
795
796
797
798
799
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 788

def get_project_broker_v2_service_instance_service_binding_last_operation(name, operation: nil, plan_id: nil, service_id: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+name}/last_operation', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1Operation
  command.params['name'] = name unless name.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_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBindingsResponse

Lists all the bindings in the instance.

Parameters:

  • parent (String)

    Parent must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/ + v2/service_instances/[INSTANCE_ID] or 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. Acceptable values are 0 to 200, inclusive. (Default: 100)

  • 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:


351
352
353
354
355
356
357
358
359
360
361
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 351

def list_project_broker_instance_bindings(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/bindings', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBindingsResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBindingsResponse
  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_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListServiceInstancesResponse

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. Acceptable values are 0 to 200, inclusive. (Default: 100)

  • 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:


265
266
267
268
269
270
271
272
273
274
275
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 265

def list_project_broker_instances(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/instances', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListServiceInstancesResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListServiceInstancesResponse
  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::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListCatalogResponse

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:


392
393
394
395
396
397
398
399
400
401
402
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 392

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, 'v1beta1/{+parent}/v2/catalog', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListCatalogResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListCatalogResponse
  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_brokers(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBrokersResponse

ListBrokers lists brokers.

Parameters:

  • parent (String)

    Parent must match projects/[PROJECT_ID]/brokers.

  • 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. Acceptable values are 0 to 200, inclusive. (Default: 100)

  • 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:


142
143
144
145
146
147
148
149
150
151
152
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 142

def list_project_brokers(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+parent}/brokers', options)
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBrokersResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ListBrokersResponse
  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(name, google_cloud_servicebroker_v1beta1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1UpdateServiceInstanceResponse

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

Parameters:

  • name (String)

    Name must match projects/[PROJECT_ID]/brokers/[BROKER_ID]/v2/service_instances/[INSTANCE_ID].

  • google_cloud_servicebroker_v1beta1__service_instance_object (Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance) (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:


615
616
617
618
619
620
621
622
623
624
625
626
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 615

def patch_project_broker_v2_service_instance(name, google_cloud_servicebroker_v1beta1__service_instance_object = nil, accepts_incomplete: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1ServiceInstance::Representation
  command.request_object = google_cloud_servicebroker_v1beta1__service_instance_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1UpdateServiceInstanceResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::GoogleCloudServicebrokerV1beta1UpdateServiceInstanceResponse
  command.params['name'] = name unless name.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::ServicebrokerV1beta1::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::ServicebrokerV1beta1::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:


857
858
859
860
861
862
863
864
865
866
867
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 857

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, 'v1beta1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleIamV1SetIamPolicyRequest::Representation
  command.request_object = google_iam_v1__set_iam_policy_request_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleIamV1Policy::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::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::ServicebrokerV1beta1::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::ServicebrokerV1beta1::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:


896
897
898
899
900
901
902
903
904
905
906
# File 'generated/google/apis/servicebroker_v1beta1/service.rb', line 896

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, 'v1beta1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ServicebrokerV1beta1::GoogleIamV1TestIamPermissionsRequest::Representation
  command.request_object = google_iam_v1__test_iam_permissions_request_object
  command.response_representation = Google::Apis::ServicebrokerV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ServicebrokerV1beta1::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