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 a 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.
-
#delete_service_tenancy_unit_project(name, delete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Deletes the specified project resource identified by a tenant resource tag.
-
#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 managed service and service 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 the specified project resource identified by a 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 managed service.
-
#undelete_service_tenancy_unit_project(name, undelete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Attempts to undelete a previously deleted tenant project.
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 a maximum of 512 tenant projects in a tenancy unit.
If there are previously failed AddTenantProject
calls, you might need to
call RemoveTenantProject
first to resolve them before you can make
another call to 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 a configuration to an existing tenant project.
This project must exist in an active state and have the original owner
account. The caller must have permission to add a project to the given
tenancy unit. The configuration is applied, but any existing settings on
the project aren't modified.
Specified policy bindings are applied. Existing bindings aren't modified.
Specified services are activated. No service is deactivated.
If specified, new billing configuration is applied.
Omit a billing configuration to keep the existing one.
A service account in the project is created if previously non existed.
Specified labels will be appended to tenant project, note that the value of
existing label key will be updated if the same label key is requested.
The specified folder is ignored, as moving a tenant project to a different
folder isn't supported.
The operation fails if any of the steps fail, but no rollback of already
applied configuration changes is attempted.
Operation
340 341 342 343 344 345 346 347 348 349 350 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 340 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 either be the tenant project reserved by
calling AddTenantProject
under a tenancy unit of a service producer's
project of a managed service, or from a separate project.
The caller is checked against a set of permissions as if calling
AddTenantProject
on the same service consumer.
To trigger the attachment, the targeted tenant project must be in a
folder. Make sure the ServiceConsumerManagement service account is
the owner of that project. These two requirements are already met
if the project is reserved by calling AddTenantProject
.
Operation
384 385 386 387 388 389 390 391 392 393 394 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 384 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. If tenancy unit already exists, it will be returned, however, in this case, returned TenancyUnit does not have tenant_resources field set and ListTenancyUnit has to be used to get a complete TenancyUnit with all fields populated.
426 427 428 429 430 431 432 433 434 435 436 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 426 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 you delete the tenancy unit, there should be
no tenant resources in it that aren't in a DELETED state.
Operation
460 461 462 463 464 465 466 467 468 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 460 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 |
#delete_service_tenancy_unit_project(name, delete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Deletes the specified project resource identified by a tenant resource tag.
The mothod removes a project lien with a 'TenantManager' origin if that was
added. It will then attempt to delete the project. If that operation fails,
this method also fails.
After the project has been deleted, the tenant resource state is set to
DELETED. To permanently remove resource metadata, call the
RemoveTenantProject
method.
New resources with the same tag can't be added if there are existing
resources in a DELETED state.
Operation
501 502 503 504 505 506 507 508 509 510 511 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 501 def delete_service_tenancy_unit_project(name, delete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:deleteProject', ) command.request_representation = Google::Apis::ServiceconsumermanagementV1::DeleteTenantProjectRequest::Representation command.request_object = delete_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 |
#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 managed service and service consumer. This method shouldn't be used in a service producer's runtime path, for example to find the tenant project number when creating VMs. Service producers must persist the tenant project's information after the project is created.
550 551 552 553 554 555 556 557 558 559 560 561 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 550 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 the specified project resource identified by a tenant resource tag.
The method removes the project lien with 'TenantManager' origin if that
was added. It then attempts to delete the project. If that operation
fails, this method also fails.
Calls to remove already removed or non-existent tenant project succeed.
After the project has been deleted, or if was already in a DELETED state,
resource metadata is permanently removed from the tenancy unit.
Operation
592 593 594 595 596 597 598 599 600 601 602 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 592 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 managed service.
250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 250 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 |
#undelete_service_tenancy_unit_project(name, undelete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ServiceconsumermanagementV1::Operation
Attempts to undelete a previously deleted tenant project. The project must
be in a DELETED state.
There are no guarantees that an undeleted project will be in
a fully restored and functional state. Call the ApplyTenantProjectConfig
method to update its configuration and then validate all managed service
resources.
Operation
632 633 634 635 636 637 638 639 640 641 642 |
# File 'generated/google/apis/serviceconsumermanagement_v1/service.rb', line 632 def undelete_service_tenancy_unit_project(name, undelete_tenant_project_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:post, 'v1/{+name}:undeleteProject', ) command.request_representation = Google::Apis::ServiceconsumermanagementV1::UndeleteTenantProjectRequest::Representation command.request_object = undelete_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 |