com.google.cloud.talent.v4beta1

Class TenantServiceClient

java.lang.Object

com.google.cloud.talent.v4beta1.TenantServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator")
 @BetaApi
public class TenantServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: A service that handles tenant management, including CRUD and enumeration.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 
 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.createTenant(parent, tenant);
 }
 
 

Note: close() needs to be called on the tenantServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of TenantServiceSettings to create(). For example:

To customize credentials:

 
 TenantServiceSettings tenantServiceSettings =
     TenantServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 TenantServiceClient tenantServiceClient =
     TenantServiceClient.create(tenantServiceSettings);
 
 

To customize the endpoint:

 
 TenantServiceSettings tenantServiceSettings =
     TenantServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 TenantServiceClient tenantServiceClient =
     TenantServiceClient.create(tenantServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TenantServiceClient.ListTenantsFixedSizeCollection
static class	TenantServiceClient.ListTenantsPage
static class	TenantServiceClient.ListTenantsPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TenantServiceClient(TenantServiceSettings settings) Constructs an instance of TenantServiceClient, using the given settings.
protected	TenantServiceClient(TenantServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static TenantServiceClient	create() Constructs an instance of TenantServiceClient with default settings.
static TenantServiceClient	create(TenantServiceSettings settings) Constructs an instance of TenantServiceClient, using the given settings.
static TenantServiceClient	create(TenantServiceStub stub) Constructs an instance of TenantServiceClient, using the given stub for making calls.
Tenant	createTenant(CreateTenantRequest request) Creates a new tenant entity.
Tenant	createTenant(ProjectName parent, Tenant tenant) Creates a new tenant entity.
Tenant	createTenant(String parent, Tenant tenant) Creates a new tenant entity.
com.google.api.gax.rpc.UnaryCallable<CreateTenantRequest,Tenant>	createTenantCallable() Creates a new tenant entity.
void	deleteTenant(DeleteTenantRequest request) Deletes specified tenant.
void	deleteTenant(String name) Deletes specified tenant.
void	deleteTenant(TenantName name) Deletes specified tenant.
com.google.api.gax.rpc.UnaryCallable<DeleteTenantRequest,Empty>	deleteTenantCallable() Deletes specified tenant.
TenantServiceSettings	getSettings()
TenantServiceStub	getStub()
Tenant	getTenant(GetTenantRequest request) Retrieves specified tenant.
Tenant	getTenant(String name) Retrieves specified tenant.
Tenant	getTenant(TenantName name) Retrieves specified tenant.
com.google.api.gax.rpc.UnaryCallable<GetTenantRequest,Tenant>	getTenantCallable() Retrieves specified tenant.
boolean	isShutdown()
boolean	isTerminated()
TenantServiceClient.ListTenantsPagedResponse	listTenants(ListTenantsRequest request) Lists all tenants associated with the project.
TenantServiceClient.ListTenantsPagedResponse	listTenants(ProjectName parent) Lists all tenants associated with the project.
TenantServiceClient.ListTenantsPagedResponse	listTenants(String parent) Lists all tenants associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListTenantsRequest,ListTenantsResponse>	listTenantsCallable() Lists all tenants associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListTenantsRequest,TenantServiceClient.ListTenantsPagedResponse>	listTenantsPagedCallable() Lists all tenants associated with the project.
void	shutdown()
void	shutdownNow()
Tenant	updateTenant(Tenant tenant) Updates specified tenant.
Tenant	updateTenant(UpdateTenantRequest request) Updates specified tenant.
com.google.api.gax.rpc.UnaryCallable<UpdateTenantRequest,Tenant>	updateTenantCallable() Updates specified tenant.

Methods inherited from class java.lang.Object

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

Constructor Detail

TenantServiceClient

protected TenantServiceClient(TenantServiceSettings settings)
                       throws IOException

Constructs an instance of TenantServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

TenantServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected TenantServiceClient(TenantServiceStub stub)

Method Detail

create

public static final TenantServiceClient create()
                                        throws IOException

Constructs an instance of TenantServiceClient with default settings.

Throws:

IOException

create

public static final TenantServiceClient create(TenantServiceSettings settings)
                                        throws IOException

Constructs an instance of TenantServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final TenantServiceClient create(TenantServiceStub stub)

Constructs an instance of TenantServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use TenantServiceSettings}.

getSettings

public final TenantServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public TenantServiceStub getStub()

createTenant

public final Tenant createTenant(ProjectName parent,
                                 Tenant tenant)

Creates a new tenant entity.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.createTenant(parent, tenant);
 }
 

Parameters:

parent - Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".

tenant - Required. The tenant to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTenant

public final Tenant createTenant(String parent,
                                 Tenant tenant)

Creates a new tenant entity.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.createTenant(parent.toString(), tenant);
 }
 

Parameters:

parent - Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".

tenant - Required. The tenant to be created.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTenant

public final Tenant createTenant(CreateTenantRequest request)

Creates a new tenant entity.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   CreateTenantRequest request = CreateTenantRequest.newBuilder()
     .setParent(parent.toString())
     .setTenant(tenant)
     .build();
   Tenant response = tenantServiceClient.createTenant(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

createTenantCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateTenantRequest,Tenant> createTenantCallable()

Creates a new tenant entity.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Tenant tenant = Tenant.newBuilder().build();
   CreateTenantRequest request = CreateTenantRequest.newBuilder()
     .setParent(parent.toString())
     .setTenant(tenant)
     .build();
   ApiFuture<Tenant> future = tenantServiceClient.createTenantCallable().futureCall(request);
   // Do something
   Tenant response = future.get();
 }
 

getTenant

public final Tenant getTenant(TenantName name)

Retrieves specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   Tenant response = tenantServiceClient.getTenant(name);
 }
 

Parameters:

name - Required. The resource name of the tenant to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTenant

public final Tenant getTenant(String name)

Retrieves specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   Tenant response = tenantServiceClient.getTenant(name.toString());
 }
 

Parameters:

name - Required. The resource name of the tenant to be retrieved.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTenant

public final Tenant getTenant(GetTenantRequest request)

Retrieves specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   GetTenantRequest request = GetTenantRequest.newBuilder()
     .setName(name.toString())
     .build();
   Tenant response = tenantServiceClient.getTenant(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

getTenantCallable

public final com.google.api.gax.rpc.UnaryCallable<GetTenantRequest,Tenant> getTenantCallable()

Retrieves specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   GetTenantRequest request = GetTenantRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Tenant> future = tenantServiceClient.getTenantCallable().futureCall(request);
   // Do something
   Tenant response = future.get();
 }
 

updateTenant

public final Tenant updateTenant(Tenant tenant)

Updates specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   Tenant tenant = Tenant.newBuilder().build();
   Tenant response = tenantServiceClient.updateTenant(tenant);
 }
 

Parameters:

tenant - Required. The tenant resource to replace the current resource in the system.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTenant

public final Tenant updateTenant(UpdateTenantRequest request)

Updates specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   Tenant tenant = Tenant.newBuilder().build();
   UpdateTenantRequest request = UpdateTenantRequest.newBuilder()
     .setTenant(tenant)
     .build();
   Tenant response = tenantServiceClient.updateTenant(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

updateTenantCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateTenantRequest,Tenant> updateTenantCallable()

Updates specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   Tenant tenant = Tenant.newBuilder().build();
   UpdateTenantRequest request = UpdateTenantRequest.newBuilder()
     .setTenant(tenant)
     .build();
   ApiFuture<Tenant> future = tenantServiceClient.updateTenantCallable().futureCall(request);
   // Do something
   Tenant response = future.get();
 }
 

deleteTenant

public final void deleteTenant(TenantName name)

Deletes specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   tenantServiceClient.deleteTenant(name);
 }
 

Parameters:

name - Required. The resource name of the tenant to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTenant

public final void deleteTenant(String name)

Deletes specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   tenantServiceClient.deleteTenant(name.toString());
 }
 

Parameters:

name - Required. The resource name of the tenant to be deleted.

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenants/bar".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTenant

public final void deleteTenant(DeleteTenantRequest request)

Deletes specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   DeleteTenantRequest request = DeleteTenantRequest.newBuilder()
     .setName(name.toString())
     .build();
   tenantServiceClient.deleteTenant(request);
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

deleteTenantCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteTenantRequest,Empty> deleteTenantCallable()

Deletes specified tenant.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   TenantName name = TenantName.of("[PROJECT]", "[TENANT]");
   DeleteTenantRequest request = DeleteTenantRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = tenantServiceClient.deleteTenantCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listTenants

public final TenantServiceClient.ListTenantsPagedResponse listTenants(ProjectName parent)

Lists all tenants associated with the project.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Tenant element : tenantServiceClient.listTenants(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTenants

public final TenantServiceClient.ListTenantsPagedResponse listTenants(String parent)

Lists all tenants associated with the project.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Tenant element : tenantServiceClient.listTenants(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

parent - Required. Resource name of the project under which the tenant is created.

The format is "projects/{project_id}", for example, "projects/foo".

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTenants

public final TenantServiceClient.ListTenantsPagedResponse listTenants(ListTenantsRequest request)

Lists all tenants associated with the project.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListTenantsRequest request = ListTenantsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Tenant element : tenantServiceClient.listTenants(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

request - The request object containing all of the parameters for the API call.

Throws:

com.google.api.gax.rpc.ApiException - if the remote call fails

listTenantsPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTenantsRequest,TenantServiceClient.ListTenantsPagedResponse> listTenantsPagedCallable()

Lists all tenants associated with the project.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListTenantsRequest request = ListTenantsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListTenantsPagedResponse> future = tenantServiceClient.listTenantsPagedCallable().futureCall(request);
   // Do something
   for (Tenant element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listTenantsCallable

public final com.google.api.gax.rpc.UnaryCallable<ListTenantsRequest,ListTenantsResponse> listTenantsCallable()

Lists all tenants associated with the project.

Sample code:

 try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   ListTenantsRequest request = ListTenantsRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListTenantsResponse response = tenantServiceClient.listTenantsCallable().call(request);
     for (Tenant element : response.getTenantsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 

close

public final void close()

Specified by:

close in interface AutoCloseable

shutdown

public void shutdown()

Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown

public boolean isShutdown()

Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated

public boolean isTerminated()

Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow

public void shutdownNow()

Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:

awaitTermination in interface com.google.api.gax.core.BackgroundResource

Throws:

InterruptedException