Class: Google::Apis::ServiceconsumermanagementV1::ServiceConsumerManagementService
- Inherits:
-
Core::BaseService
- Object
- Core::BaseService
- Google::Apis::ServiceconsumermanagementV1::ServiceConsumerManagementService
- Defined in:
- generated/google/apis/serviceconsumermanagement_v1/service.rb
Overview
Service Consumer Management API
Manages the service consumers of a Service Infrastructure service.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
-
#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.
-
#apply_service_tenancy_unit_project_config(name, apply_tenant_project_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Apply configuration to an existing tenant project.
-
#attach_service_tenancy_unit_project(name, attach_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Attach an existing project to the tenancy unit as a new tenant resource.
-
#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.
-
#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.
-
#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Empty
Deletes a long-running operation.
-
#delete_service_tenancy_unit(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Delete a tenancy unit.
-
#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.
-
#initialize ⇒ ServiceConsumerManagementService
constructor
A new instance of ServiceConsumerManagementService.
-
#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.
-
#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.
-
#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.
-
#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.
Methods inherited from Core::BaseService
#batch, #batch_upload, #fetch_all, #http
Methods included from Core::Logging
Constructor Details
#initialize ⇒ ServiceConsumerManagementService
Returns a new instance of ServiceConsumerManagementService
45 46 47 48 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 45 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.
38 39 40 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 38 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.
43 44 45 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 43 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
290 291 292 293 294 295 296 297 298 299 300 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 290 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', ) 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 |
#apply_service_tenancy_unit_project_config(name, apply_tenant_project_config_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Apply configuration to an existing tenant project.
This project must exist in active state and have the original owner
account. Caller must have the permission to add a project to the given
tenancy unit. Configuration will be applied, but any existing settings on
the project will not be modified.
Specified policy bindings will be applied. Existing binding will not be
modified.
Specified services will be activated. No service will be deactivated.
New billing configuration will be applied if specified.
Omit billing configuration to keep the existing one.
Service account in the project will be created if previously non existing.
Specified folder will be ignored, moving tenant project to a different
folder is not supported.
Operation fails if any of the steps fail, but no rollback of already
applied configuration changes is attempted.
Operation
338 339 340 341 342 343 344 345 346 347 348 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 338 def apply_service_tenancy_unit_project_config(name, apply_tenant_project_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:applyProjectConfig', ) command.request_representation = Google::Apis::ServiceconsumermanagementV1::ApplyTenantProjectConfigRequest::Representation command.request_object = apply_tenant_project_config_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 |
#attach_service_tenancy_unit_project(name, attach_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Attach an existing project to the tenancy unit as a new tenant
resource. The project could be either the tenant project reserved by
calling AddTenantProject under tenancy unit for the producer project of
service, or from outside.
Caller will be checked against the permission as if calling
AddTenantProject on the same consumer.
To trigger the attachement, the targeted tenant project must be in a
folder. Please also make sure ServiceConsumerManagement service account is
the owner of that project. Note that these two requirements are already met
if the project is reserved through AddTenantProject.
Operation
381 382 383 384 385 386 387 388 389 390 391 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 381 def attach_service_tenancy_unit_project(name, attach_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:attachProject', ) command.request_representation = Google::Apis::ServiceconsumermanagementV1::AttachTenantProjectRequest::Representation command.request_object = attach_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 |
#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
.
80 81 82 83 84 85 86 87 88 89 90 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 80 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', ) 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.
419 420 421 422 423 424 425 426 427 428 429 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 419 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', ) 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
.
115 116 117 118 119 120 121 122 123 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 115 def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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 not in DELETED state.
Operation
453 454 455 456 457 458 459 460 461 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 453 def delete_service_tenancy_unit(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:delete, 'v1/{+name}', ) 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.
147 148 149 150 151 152 153 154 155 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 147 def get_operation(name, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1/{+name}', ) 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.
191 192 193 194 195 196 197 198 199 200 201 202 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 191 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}', ) 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.
499 500 501 502 503 504 505 506 507 508 509 510 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 499 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', ) 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.
After the project has been deleted, or if was already in DELETED state,
resource metadata is permanently removed from the tenancy unit.
Operation
540 541 542 543 544 545 546 547 548 549 550 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 540 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', ) 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.
251 252 253 254 255 256 257 258 259 260 261 262 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 251 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', ) 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 |