com.google.api.services.serviceconsumermanagement.v1

Class ServiceConsumerManagement.Services.TenancyUnits

java.lang.Object

com.google.api.services.serviceconsumermanagement.v1.ServiceConsumerManagement.Services.TenancyUnits

Enclosing class:

ServiceConsumerManagement.Services

public class ServiceConsumerManagement.Services.TenancyUnits
extends Object

The "tenancyUnits" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ServiceConsumerManagement.Services.TenancyUnits.AddProject
class	ServiceConsumerManagement.Services.TenancyUnits.ApplyProjectConfig
class	ServiceConsumerManagement.Services.TenancyUnits.AttachProject
class	ServiceConsumerManagement.Services.TenancyUnits.Create
class	ServiceConsumerManagement.Services.TenancyUnits.Delete
class	ServiceConsumerManagement.Services.TenancyUnits.DeleteProject
class	ServiceConsumerManagement.Services.TenancyUnits.List
class	ServiceConsumerManagement.Services.TenancyUnits.RemoveProject
class	ServiceConsumerManagement.Services.TenancyUnits.UndeleteProject

Constructor Summary

Constructors

Constructor and Description
TenancyUnits()

Method Summary

Modifier and Type	Method and Description
ServiceConsumerManagement.Services.TenancyUnits.AddProject	addProject(String parent, AddTenantProjectRequest content) Add a new tenant project to the tenancy unit.
ServiceConsumerManagement.Services.TenancyUnits.ApplyProjectConfig	applyProjectConfig(String name, ApplyTenantProjectConfigRequest content) Apply a configuration to an existing tenant project.
ServiceConsumerManagement.Services.TenancyUnits.AttachProject	attachProject(String name, AttachTenantProjectRequest content) Attach an existing project to the tenancy unit as a new tenant resource.
ServiceConsumerManagement.Services.TenancyUnits.Create	create(String parent, CreateTenancyUnitRequest content) Creates a tenancy unit with no tenant resources.
ServiceConsumerManagement.Services.TenancyUnits.Delete	delete(String name) Delete a tenancy unit.
ServiceConsumerManagement.Services.TenancyUnits.DeleteProject	deleteProject(String name, DeleteTenantProjectRequest content) Deletes the specified project resource identified by a tenant resource tag.
ServiceConsumerManagement.Services.TenancyUnits.List	list(String parent) Find the tenancy unit for a managed service and service consumer.
ServiceConsumerManagement.Services.TenancyUnits.RemoveProject	removeProject(String name, RemoveTenantProjectRequest content) Removes the specified project resource identified by a tenant resource tag.
ServiceConsumerManagement.Services.TenancyUnits.UndeleteProject	undeleteProject(String name, UndeleteTenantProjectRequest content) Attempts to undelete a previously deleted tenant project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TenancyUnits

public TenancyUnits()

Method Detail

addProject

public ServiceConsumerManagement.Services.TenancyUnits.AddProject addProject(String parent,
                                                                             AddTenantProjectRequest content)
                                                                      throws IOException

Add a new tenant project to the tenancy unit. There can be a maximum of 1024 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. Create a request for the method "tenancyUnits.addProject". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the AddTenantProjectRequest

Returns:

the request

Throws:

IOException

applyProjectConfig

public ServiceConsumerManagement.Services.TenancyUnits.ApplyProjectConfig applyProjectConfig(String name,
                                                                                             ApplyTenantProjectConfigRequest content)
                                                                                      throws IOException

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. Create a request for the method "tenancyUnits.applyProjectConfig". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the ApplyTenantProjectConfigRequest

Returns:

the request

Throws:

IOException

attachProject

public ServiceConsumerManagement.Services.TenancyUnits.AttachProject attachProject(String name,
                                                                                   AttachTenantProjectRequest content)
                                                                            throws IOException

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. Create a request for the method "tenancyUnits.attachProject". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the tenancy unit that the project will be attached to. Such as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.

content - the AttachTenantProjectRequest

Returns:

the request

Throws:

IOException

create

public ServiceConsumerManagement.Services.TenancyUnits.Create create(String parent,
                                                                     CreateTenancyUnitRequest content)
                                                              throws IOException

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 ListTenancyUnits has to be used to get a complete TenancyUnit with all fields populated. Create a request for the method "tenancyUnits.create". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - 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 managed service, such as 'service.googleapis.com'. Enables service binding using the new tenancy unit.

content - the CreateTenancyUnitRequest

Returns:

the request

Throws:

IOException

delete

public ServiceConsumerManagement.Services.TenancyUnits.Delete delete(String name)
                                                              throws IOException

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. Create a request for the method "tenancyUnits.delete". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Name of the tenancy unit to be deleted.

Returns:

the request

Throws:

IOException

deleteProject

public ServiceConsumerManagement.Services.TenancyUnits.DeleteProject deleteProject(String name,
                                                                                   DeleteTenantProjectRequest content)
                                                                            throws IOException

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. Create a request for the method "tenancyUnits.deleteProject". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the DeleteTenantProjectRequest

Returns:

the request

Throws:

IOException

list

public ServiceConsumerManagement.Services.TenancyUnits.List list(String parent)
                                                          throws IOException

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. Create a request for the method "tenancyUnits.list". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. Managed service and service 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, such as 'service.googleapis.com'.

Returns:

the request

Throws:

IOException

removeProject

public ServiceConsumerManagement.Services.TenancyUnits.RemoveProject removeProject(String name,
                                                                                   RemoveTenantProjectRequest content)
                                                                            throws IOException

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. Create a request for the method "tenancyUnits.removeProject". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the RemoveTenantProjectRequest

Returns:

the request

Throws:

IOException

undeleteProject

public ServiceConsumerManagement.Services.TenancyUnits.UndeleteProject undeleteProject(String name,
                                                                                       UndeleteTenantProjectRequest content)
                                                                                throws IOException

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. Create a request for the method "tenancyUnits.undeleteProject". This request holds the parameters needed by the serviceconsumermanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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

content - the UndeleteTenantProjectRequest

Returns:

the request

Throws:

IOException