Class: Google::Apis::ServiceconsumermanagementV1::ServiceConsumerManagementService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/serviceconsumermanagement_v1/service.rb

Overview

Service Consumer Management API

Provides management methods for configuring service producer resources on Google Cloud.

Examples:

require 'google/apis/serviceconsumermanagement_v1'

Serviceconsumermanagement = Google::Apis::ServiceconsumermanagementV1 # Alias the module
service = Serviceconsumermanagement::ServiceConsumerManagementService.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 ⇒ ServiceConsumerManagementService

Returns a new instance of ServiceConsumerManagementService



46
47
48
49
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 46

def initialize
  super('https://serviceconsumermanagement.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.



39
40
41
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#add_service_tenancy_unit_project(parent, add_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation

Add a new tenant project to the tenancy unit. There can be at most 512 tenant projects in a tenancy unit. If there are previously failed AddTenantProject calls, you might need to call RemoveTenantProject first to clean them before you can make another AddTenantProject with the same tag. Operation.

Parameters:

  • parent (String) —

    Name of the tenancy unit.

  • add_tenant_project_request_object (Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest) (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:



291
292
293
294
295
296
297
298
299
300
301
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 291

def add_service_tenancy_unit_project(parent, add_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}:addProject', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1::AddTenantProjectRequest::Representation
  command.request_object = add_tenant_project_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation
  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

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Empty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

  • name (String) —

    The name of the operation resource to be cancelled.

  • cancel_operation_request_object (Google::Apis::ServiceconsumermanagementV1::CancelOperationRequest) (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:



81
82
83
84
85
86
87
88
89
90
91
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 81

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Empty::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Empty
  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

#create_tenancy_unit(parent, create_tenancy_unit_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::TenancyUnit

Creates a tenancy unit with no tenant resources.

Parameters:

  • parent (String) —

    services/service/collection id/resource id collection id is the cloud resource collection type representing the service consumer, for example 'projects', or 'organizations'. resource id is the consumer numeric id, such as project number: '123456'. service the name of a service, for example 'service.googleapis.com'. Enabled service binding using the new tenancy unit.

  • create_tenancy_unit_request_object (Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest) (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:



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

def create_tenancy_unit(parent, create_tenancy_unit_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+parent}/tenancyUnits', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1::CreateTenancyUnitRequest::Representation
  command.request_object = create_tenancy_unit_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::TenancyUnit::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::TenancyUnit
  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

#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Empty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Parameters:

  • name (String) —

    The name of the operation resource to be deleted.

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



116
117
118
119
120
121
122
123
124
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 116

def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Empty::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Empty
  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_service_tenancy_unit(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation

Delete a tenancy unit. Before the tenancy unit is deleted, there should be no tenant resources in it. Operation.

Parameters:

  • name (String) —

    Name of the tenancy unit to be deleted.

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



363
364
365
366
367
368
369
370
371
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 363

def delete_service_tenancy_unit(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation
  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_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

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



148
149
150
151
152
153
154
155
156
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 148

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation
  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

#list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Parameters:

  • name (String) —

    The name of the operation's parent resource.

  • filter (String) —

    The standard list filter.

  • page_size (Fixnum) —

    The standard list page size.

  • page_token (String) —

    The standard list page token.

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



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

def list_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.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_service_tenancy_units(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse

Find the tenancy unit for a service and consumer. This method should not be used in producers' runtime path, for example finding the tenant project number when creating VMs. Producers should persist the tenant project information after the project is created.

Parameters:

  • parent (String) —

    Service and consumer. Required. services/service/collection id/resource id collection id is the cloud resource collection type representing the service consumer, for example 'projects', or 'organizations'. resource id is the consumer numeric id, such as project number: '123456'. service the name of a service, for example 'service.googleapis.com'.

  • filter (String) —

    Filter expression over tenancy resources field. Optional.

  • page_size (Fixnum) —

    The maximum number of results returned by this request.

  • page_token (String) —

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response.

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



409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 409

def list_service_tenancy_units(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}/tenancyUnits', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::ListTenancyUnitsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.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

#remove_service_tenancy_unit_project(name, remove_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation

Removes specified project resource identified by tenant resource tag. It will remove project lien with 'TenantManager' origin if that was added. It will then attempt to delete the project. If that operation fails, this method fails. Operation.

Parameters:

  • name (String) —

    Name of the tenancy unit. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.

  • remove_tenant_project_request_object (Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest) (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:



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

def remove_service_tenancy_unit_project(name, remove_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/{+name}:removeProject', options)
  command.request_representation = Google::Apis::ServiceconsumermanagementV1::RemoveTenantProjectRequest::Representation
  command.request_object = remove_tenant_project_request_object
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::Operation::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::Operation
  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

#search_services(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse

Search tenancy units for a service.

Parameters:

  • parent (String) —

    Service for which search is performed. services/service service the name of a service, for example 'service.googleapis.com'.

  • page_size (Fixnum) —

    The maximum number of results returned by this request. Currently, the default maximum is set to 1000. If page_size is not provided or the size provided is a number larger than 1000, it will be automatically set to 1000. Optional.

  • page_token (String) —

    The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of nextPageToken from the previous response. Optional.

  • query (String) —

    Set a query expression for querying tenancy units. Your expression must be in the format: field_name=literal_string. The field_name is the name of the field you want to compare. Supported fields are tenant_resources.tag and tenant_resources.resource. For example, to search tenancy units that contain at least one tenant resource with given tag 'xyz', use query tenant_resources.tag=xyz. To search tenancy units that contain at least one tenant resource with given resource name 'projects/123456', use query tenant_resources.resource=projects/123456. Multiple expressions can be joined with ANDs. Tenancy units must match all expressions to be included in the result set. For example, tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456 Optional.

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



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

def search_services(parent, page_size: nil, page_token: nil, query: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/{+parent}:search', options)
  command.response_representation = Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse::Representation
  command.response_class = Google::Apis::ServiceconsumermanagementV1::SearchTenancyUnitsResponse
  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['query'] = query unless query.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end