@BetaApi @Generated(value="by gapic-generator-java") public class TenantServiceClient extends Object implements BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
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.newBuilder()
.setTransportChannelProvider(
TenantServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
.build();
TenantServiceClient tenantServiceClient = TenantServiceClient.create(tenantServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Modifier and Type | Class and Description |
---|---|
static class |
TenantServiceClient.ListTenantsFixedSizeCollection |
static class |
TenantServiceClient.ListTenantsPage |
static class |
TenantServiceClient.ListTenantsPagedResponse |
Modifier | Constructor and Description |
---|---|
protected |
TenantServiceClient(TenantServiceSettings settings)
Constructs an instance of TenantServiceClient, using the given settings.
|
protected |
TenantServiceClient(TenantServiceStub stub) |
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.
|
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.
|
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.
|
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.
|
UnaryCallable<ListTenantsRequest,ListTenantsResponse> |
listTenantsCallable()
Lists all tenants associated with the project.
|
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.
|
UnaryCallable<UpdateTenantRequest,Tenant> |
updateTenantCallable()
Updates specified tenant.
|
protected TenantServiceClient(TenantServiceSettings settings) throws IOException
IOException
protected TenantServiceClient(TenantServiceStub stub)
public static final TenantServiceClient create() throws IOException
IOException
public static final TenantServiceClient create(TenantServiceSettings settings) throws IOException
IOException
public static final TenantServiceClient create(TenantServiceStub stub)
public final TenantServiceSettings getSettings()
public TenantServiceStub getStub()
public final Tenant createTenant(ProjectName parent, Tenant 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()) {
ProjectName parent = ProjectName.of("[PROJECT]");
Tenant tenant = Tenant.newBuilder().build();
Tenant response = tenantServiceClient.createTenant(parent, tenant);
}
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.ApiException
- if the remote call failspublic final Tenant createTenant(String parent, Tenant 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 parent = ProjectName.of("[PROJECT]").toString();
Tenant tenant = Tenant.newBuilder().build();
Tenant response = tenantServiceClient.createTenant(parent, tenant);
}
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.ApiException
- if the remote call failspublic final Tenant createTenant(CreateTenantRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<CreateTenantRequest,Tenant> createTenantCallable()
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();
}
public final Tenant getTenant(TenantName name)
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);
}
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".
ApiException
- if the remote call failspublic final Tenant getTenant(String name)
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);
}
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".
ApiException
- if the remote call failspublic final Tenant getTenant(GetTenantRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<GetTenantRequest,Tenant> getTenantCallable()
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();
}
public final Tenant updateTenant(Tenant 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);
}
tenant
- Required. The tenant resource to replace the current resource in the system.ApiException
- if the remote call failspublic final Tenant updateTenant(UpdateTenantRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<UpdateTenantRequest,Tenant> updateTenantCallable()
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();
}
public final void deleteTenant(TenantName name)
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);
}
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".
ApiException
- if the remote call failspublic final void deleteTenant(String name)
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);
}
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".
ApiException
- if the remote call failspublic final void deleteTenant(DeleteTenantRequest request)
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);
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<DeleteTenantRequest,Empty> deleteTenantCallable()
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();
}
public final TenantServiceClient.ListTenantsPagedResponse listTenants(ProjectName parent)
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);
}
}
parent
- Required. Resource name of the project under which the tenant is created.
The format is "projects/{project_id}", for example, "projects/foo".
ApiException
- if the remote call failspublic final TenantServiceClient.ListTenantsPagedResponse listTenants(String parent)
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);
}
}
parent
- Required. Resource name of the project under which the tenant is created.
The format is "projects/{project_id}", for example, "projects/foo".
ApiException
- if the remote call failspublic final TenantServiceClient.ListTenantsPagedResponse listTenants(ListTenantsRequest request)
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);
}
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call failspublic final UnaryCallable<ListTenantsRequest,TenantServiceClient.ListTenantsPagedResponse> listTenantsPagedCallable()
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);
}
}
public final UnaryCallable<ListTenantsRequest,ListTenantsResponse> listTenantsCallable()
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;
}
}
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2022 Google LLC. All rights reserved.