Class TenantServiceClient
- All Implemented Interfaces:
BackgroundResource,AutoCloseable
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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
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().
| Method | Description | Method Variants |
|---|---|---|
CreateTenant |
Creates a new tenant entity. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
GetTenant |
Retrieves specified tenant. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
UpdateTenant |
Updates specified tenant. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
DeleteTenant |
Deletes specified tenant. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ListTenants |
Lists all tenants associated with the project. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
Callable method variants take no parameters and return 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:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TenantServiceSettings tenantServiceSettings =
TenantServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TenantServiceSettings tenantServiceSettings =
TenantServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
TenantServiceSettings tenantServiceSettings =
TenantServiceSettings.newHttpJsonBuilder().build();
TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classstatic classstatic class -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedprotectedTenantServiceClient(TenantServiceSettings settings) Constructs an instance of TenantServiceClient, using the given settings. -
Method Summary
Modifier and TypeMethodDescriptionbooleanawaitTermination(long duration, TimeUnit unit) final voidclose()static final TenantServiceClientcreate()Constructs an instance of TenantServiceClient with default settings.static final TenantServiceClientcreate(TenantServiceStub stub) Constructs an instance of TenantServiceClient, using the given stub for making calls.static final TenantServiceClientcreate(TenantServiceSettings settings) Constructs an instance of TenantServiceClient, using the given settings.final TenantcreateTenant(CreateTenantRequest request) Creates a new tenant entity.final TenantcreateTenant(ProjectName parent, Tenant tenant) Creates a new tenant entity.final TenantcreateTenant(String parent, Tenant tenant) Creates a new tenant entity.Creates a new tenant entity.final voiddeleteTenant(DeleteTenantRequest request) Deletes specified tenant.final voiddeleteTenant(TenantName name) Deletes specified tenant.final voiddeleteTenant(String name) Deletes specified tenant.final UnaryCallable<DeleteTenantRequest,com.google.protobuf.Empty> Deletes specified tenant.final TenantServiceSettingsgetStub()final TenantgetTenant(GetTenantRequest request) Retrieves specified tenant.final TenantgetTenant(TenantName name) Retrieves specified tenant.final TenantRetrieves specified tenant.final UnaryCallable<GetTenantRequest,Tenant> Retrieves specified tenant.booleanbooleanlistTenants(ListTenantsRequest request) Lists all tenants associated with the project.listTenants(ProjectName parent) Lists all tenants associated with the project.listTenants(String parent) Lists all tenants associated with the project.Lists all tenants associated with the project.Lists all tenants associated with the project.voidshutdown()voidfinal TenantupdateTenant(Tenant tenant) Updates specified tenant.final TenantupdateTenant(UpdateTenantRequest request) Updates specified tenant.Updates specified tenant.
-
Constructor Details
-
TenantServiceClient
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
-
-
Method Details
-
create
Constructs an instance of TenantServiceClient with default settings.- Throws:
IOException
-
create
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
Constructs an instance of TenantServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(TenantServiceSettings). -
getSettings
-
getStub
-
createTenant
Creates a new tenant entity.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
ApiException- if the remote call fails
-
createTenant
Creates a new tenant entity.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { String parent = ProjectName.of("[PROJECT]").toString(); 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:
ApiException- if the remote call fails
-
createTenant
Creates a new tenant entity.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { CreateTenantRequest request = CreateTenantRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setTenant(Tenant.newBuilder().build()) .build(); Tenant response = tenantServiceClient.createTenant(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
createTenantCallable
Creates a new tenant entity.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { CreateTenantRequest request = CreateTenantRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setTenant(Tenant.newBuilder().build()) .build(); ApiFuture<Tenant> future = tenantServiceClient.createTenantCallable().futureCall(request); // Do something. Tenant response = future.get(); } -
getTenant
Retrieves specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
ApiException- if the remote call fails
-
getTenant
Retrieves specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { String name = TenantName.of("[PROJECT]", "[TENANT]").toString(); 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:
ApiException- if the remote call fails
-
getTenant
Retrieves specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { GetTenantRequest request = GetTenantRequest.newBuilder() .setName(TenantName.of("[PROJECT]", "[TENANT]").toString()) .build(); Tenant response = tenantServiceClient.getTenant(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
getTenantCallable
Retrieves specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { GetTenantRequest request = GetTenantRequest.newBuilder() .setName(TenantName.of("[PROJECT]", "[TENANT]").toString()) .build(); ApiFuture<Tenant> future = tenantServiceClient.getTenantCallable().futureCall(request); // Do something. Tenant response = future.get(); } -
updateTenant
Updates specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
ApiException- if the remote call fails
-
updateTenant
Updates specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { UpdateTenantRequest request = UpdateTenantRequest.newBuilder() .setTenant(Tenant.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); Tenant response = tenantServiceClient.updateTenant(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
updateTenantCallable
Updates specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { UpdateTenantRequest request = UpdateTenantRequest.newBuilder() .setTenant(Tenant.newBuilder().build()) .setUpdateMask(FieldMask.newBuilder().build()) .build(); ApiFuture<Tenant> future = tenantServiceClient.updateTenantCallable().futureCall(request); // Do something. Tenant response = future.get(); } -
deleteTenant
Deletes specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
ApiException- if the remote call fails
-
deleteTenant
Deletes specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { String name = TenantName.of("[PROJECT]", "[TENANT]").toString(); 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:
ApiException- if the remote call fails
-
deleteTenant
Deletes specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { DeleteTenantRequest request = DeleteTenantRequest.newBuilder() .setName(TenantName.of("[PROJECT]", "[TENANT]").toString()) .build(); tenantServiceClient.deleteTenant(request); }- Parameters:
request- The request object containing all of the parameters for the API call.- Throws:
ApiException- if the remote call fails
-
deleteTenantCallable
Deletes specified tenant.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { DeleteTenantRequest request = DeleteTenantRequest.newBuilder() .setName(TenantName.of("[PROJECT]", "[TENANT]").toString()) .build(); ApiFuture<Empty> future = tenantServiceClient.deleteTenantCallable().futureCall(request); // Do something. future.get(); } -
listTenants
Lists all tenants associated with the project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 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:
ApiException- if the remote call fails
-
listTenants
Lists all tenants associated with the project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { String parent = ProjectName.of("[PROJECT]").toString(); 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:
ApiException- if the remote call fails
-
listTenants
Lists all tenants associated with the project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { ListTenantsRequest request = ListTenantsRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageToken("pageToken873572522") .setPageSize(883849137) .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:
ApiException- if the remote call fails
-
listTenantsPagedCallable
public final UnaryCallable<ListTenantsRequest,TenantServiceClient.ListTenantsPagedResponse> listTenantsPagedCallable()Lists all tenants associated with the project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { ListTenantsRequest request = ListTenantsRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageToken("pageToken873572522") .setPageSize(883849137) .build(); ApiFuture<Tenant> future = tenantServiceClient.listTenantsPagedCallable().futureCall(request); // Do something. for (Tenant element : future.get().iterateAll()) { // doThingsWith(element); } } -
listTenantsCallable
Lists all tenants associated with the project.Sample code:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library try (TenantServiceClient tenantServiceClient = TenantServiceClient.create()) { ListTenantsRequest request = ListTenantsRequest.newBuilder() .setParent(ProjectName.of("[PROJECT]").toString()) .setPageToken("pageToken873572522") .setPageSize(883849137) .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:
closein interfaceAutoCloseable
-
shutdown
public void shutdown()- Specified by:
shutdownin interfaceBackgroundResource
-
isShutdown
public boolean isShutdown()- Specified by:
isShutdownin interfaceBackgroundResource
-
isTerminated
public boolean isTerminated()- Specified by:
isTerminatedin interfaceBackgroundResource
-
shutdownNow
public void shutdownNow()- Specified by:
shutdownNowin interfaceBackgroundResource
-
awaitTermination
- Specified by:
awaitTerminationin interfaceBackgroundResource- Throws:
InterruptedException
-