com.google.cloud.talent.v4beta1

Class CompanyServiceClient

java.lang.Object

com.google.cloud.talent.v4beta1.CompanyServiceClient

All Implemented Interfaces:

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

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

Service Description: A service that handles company 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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.createCompany(parent, company);
 }
 
 

Note: close() needs to be called on the companyServiceClient 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 CompanyServiceSettings to create(). For example:

To customize credentials:

 
 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompanyServiceClient companyServiceClient =
     CompanyServiceClient.create(companyServiceSettings);
 
 

To customize the endpoint:

 
 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompanyServiceClient companyServiceClient =
     CompanyServiceClient.create(companyServiceSettings);
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CompanyServiceClient.ListCompaniesFixedSizeCollection
static class	CompanyServiceClient.ListCompaniesPage
static class	CompanyServiceClient.ListCompaniesPagedResponse

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CompanyServiceClient(CompanyServiceSettings settings) Constructs an instance of CompanyServiceClient, using the given settings.
protected	CompanyServiceClient(CompanyServiceStub stub)

Method Summary

Modifier and Type	Method and Description
boolean	awaitTermination(long duration, TimeUnit unit)
void	close()
static CompanyServiceClient	create() Constructs an instance of CompanyServiceClient with default settings.
static CompanyServiceClient	create(CompanyServiceSettings settings) Constructs an instance of CompanyServiceClient, using the given settings.
static CompanyServiceClient	create(CompanyServiceStub stub) Constructs an instance of CompanyServiceClient, using the given stub for making calls.
Company	createCompany(CreateCompanyRequest request) Creates a new company entity.
Company	createCompany(String parent, Company company) Creates a new company entity.
Company	createCompany(TenantOrProjectName parent, Company company) Creates a new company entity.
com.google.api.gax.rpc.UnaryCallable<CreateCompanyRequest,Company>	createCompanyCallable() Creates a new company entity.
void	deleteCompany(CompanyName name) Deletes specified company.
void	deleteCompany(DeleteCompanyRequest request) Deletes specified company.
void	deleteCompany(String name) Deletes specified company.
com.google.api.gax.rpc.UnaryCallable<DeleteCompanyRequest,Empty>	deleteCompanyCallable() Deletes specified company.
Company	getCompany(CompanyName name) Retrieves specified company.
Company	getCompany(GetCompanyRequest request) Retrieves specified company.
Company	getCompany(String name) Retrieves specified company.
com.google.api.gax.rpc.UnaryCallable<GetCompanyRequest,Company>	getCompanyCallable() Retrieves specified company.
CompanyServiceSettings	getSettings()
CompanyServiceStub	getStub()
boolean	isShutdown()
boolean	isTerminated()
CompanyServiceClient.ListCompaniesPagedResponse	listCompanies(ListCompaniesRequest request) Lists all companies associated with the project.
CompanyServiceClient.ListCompaniesPagedResponse	listCompanies(String parent) Lists all companies associated with the project.
CompanyServiceClient.ListCompaniesPagedResponse	listCompanies(TenantOrProjectName parent) Lists all companies associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListCompaniesRequest,ListCompaniesResponse>	listCompaniesCallable() Lists all companies associated with the project.
com.google.api.gax.rpc.UnaryCallable<ListCompaniesRequest,CompanyServiceClient.ListCompaniesPagedResponse>	listCompaniesPagedCallable() Lists all companies associated with the project.
void	shutdown()
void	shutdownNow()
Company	updateCompany(Company company) Updates specified company.
Company	updateCompany(UpdateCompanyRequest request) Updates specified company.
com.google.api.gax.rpc.UnaryCallable<UpdateCompanyRequest,Company>	updateCompanyCallable() Updates specified company.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompanyServiceClient

protected CompanyServiceClient(CompanyServiceSettings settings)
                        throws IOException

Constructs an instance of CompanyServiceClient, 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

CompanyServiceClient

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

Method Detail

create

public static final CompanyServiceClient create()
                                         throws IOException

Constructs an instance of CompanyServiceClient with default settings.

Throws:

IOException

create

public static final CompanyServiceClient create(CompanyServiceSettings settings)
                                         throws IOException

Constructs an instance of CompanyServiceClient, 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 CompanyServiceClient create(CompanyServiceStub stub)

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

getSettings

public final CompanyServiceSettings getSettings()

getStub

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

createCompany

public final Company createCompany(TenantOrProjectName parent,
                                   Company company)

Creates a new company entity.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.createCompany(parent, company);
 }
 

Parameters:

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".

company - Required. The company to be created.

Throws:

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

createCompany

public final Company createCompany(String parent,
                                   Company company)

Creates a new company entity.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.createCompany(parent.toString(), company);
 }
 

Parameters:

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

The format is "projects/{project_id}/tenants/{tenant_id}", for example, "projects/foo/tenant/bar". If tenant id is unspecified, a default tenant is created, for example, "projects/foo".

company - Required. The company to be created.

Throws:

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

createCompany

public final Company createCompany(CreateCompanyRequest request)

Creates a new company entity.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   CreateCompanyRequest request = CreateCompanyRequest.newBuilder()
     .setParent(parent.toString())
     .setCompany(company)
     .build();
   Company response = companyServiceClient.createCompany(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

createCompanyCallable

public final com.google.api.gax.rpc.UnaryCallable<CreateCompanyRequest,Company> createCompanyCallable()

Creates a new company entity.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   Company company = Company.newBuilder().build();
   CreateCompanyRequest request = CreateCompanyRequest.newBuilder()
     .setParent(parent.toString())
     .setCompany(company)
     .build();
   ApiFuture<Company> future = companyServiceClient.createCompanyCallable().futureCall(request);
   // Do something
   Company response = future.get();
 }
 

getCompany

public final Company getCompany(CompanyName name)

Retrieves specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   Company response = companyServiceClient.getCompany(name);
 }
 

Parameters:

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

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar".

Throws:

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

getCompany

public final Company getCompany(String name)

Retrieves specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   Company response = companyServiceClient.getCompany(name.toString());
 }
 

Parameters:

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

The format is "projects/{project_id}/tenants/{tenant_id}/companies/{company_id}", for example, "projects/api-test-project/tenants/foo/companies/bar".

If tenant id is unspecified, the default tenant is used, for example, "projects/api-test-project/companies/bar".

Throws:

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

getCompany

public final Company getCompany(GetCompanyRequest request)

Retrieves specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   GetCompanyRequest request = GetCompanyRequest.newBuilder()
     .setName(name.toString())
     .build();
   Company response = companyServiceClient.getCompany(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

getCompanyCallable

public final com.google.api.gax.rpc.UnaryCallable<GetCompanyRequest,Company> getCompanyCallable()

Retrieves specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   GetCompanyRequest request = GetCompanyRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Company> future = companyServiceClient.getCompanyCallable().futureCall(request);
   // Do something
   Company response = future.get();
 }
 

updateCompany

public final Company updateCompany(Company company)

Updates specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   Company company = Company.newBuilder().build();
   Company response = companyServiceClient.updateCompany(company);
 }
 

Parameters:

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

Throws:

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

updateCompany

public final Company updateCompany(UpdateCompanyRequest request)

Updates specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   Company company = Company.newBuilder().build();
   UpdateCompanyRequest request = UpdateCompanyRequest.newBuilder()
     .setCompany(company)
     .build();
   Company response = companyServiceClient.updateCompany(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

updateCompanyCallable

public final com.google.api.gax.rpc.UnaryCallable<UpdateCompanyRequest,Company> updateCompanyCallable()

Updates specified company.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   Company company = Company.newBuilder().build();
   UpdateCompanyRequest request = UpdateCompanyRequest.newBuilder()
     .setCompany(company)
     .build();
   ApiFuture<Company> future = companyServiceClient.updateCompanyCallable().futureCall(request);
   // Do something
   Company response = future.get();
 }
 

deleteCompany

public final void deleteCompany(CompanyName name)

Deletes specified company. Prerequisite: The company has no jobs associated with it.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   companyServiceClient.deleteCompany(name);
 }
 

Parameters:

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

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

If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar".

Throws:

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

deleteCompany

public final void deleteCompany(String name)

Deletes specified company. Prerequisite: The company has no jobs associated with it.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   companyServiceClient.deleteCompany(name.toString());
 }
 

Parameters:

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

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

If tenant id is unspecified, the default tenant is used, for example, "projects/foo/companies/bar".

Throws:

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

deleteCompany

public final void deleteCompany(DeleteCompanyRequest request)

Deletes specified company. Prerequisite: The company has no jobs associated with it.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   DeleteCompanyRequest request = DeleteCompanyRequest.newBuilder()
     .setName(name.toString())
     .build();
   companyServiceClient.deleteCompany(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

deleteCompanyCallable

public final com.google.api.gax.rpc.UnaryCallable<DeleteCompanyRequest,Empty> deleteCompanyCallable()

Deletes specified company. Prerequisite: The company has no jobs associated with it.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyWithTenantName.of("[PROJECT]", "[TENANT]", "[COMPANY]");
   DeleteCompanyRequest request = DeleteCompanyRequest.newBuilder()
     .setName(name.toString())
     .build();
   ApiFuture<Void> future = companyServiceClient.deleteCompanyCallable().futureCall(request);
   // Do something
   future.get();
 }
 

listCompanies

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(TenantOrProjectName parent)

Lists all companies associated with the project.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   for (Company element : companyServiceClient.listCompanies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

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

If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".

Throws:

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

listCompanies

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(String parent)

Lists all companies associated with the project.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   for (Company element : companyServiceClient.listCompanies(parent.toString()).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameters:

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

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

If tenant id is unspecified, the default tenant will be used, for example, "projects/foo".

Throws:

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

listCompanies

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(ListCompaniesRequest request)

Lists all companies associated with the project.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ListCompaniesRequest request = ListCompaniesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   for (Company element : companyServiceClient.listCompanies(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

listCompaniesPagedCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCompaniesRequest,CompanyServiceClient.ListCompaniesPagedResponse> listCompaniesPagedCallable()

Lists all companies associated with the project.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ListCompaniesRequest request = ListCompaniesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   ApiFuture<ListCompaniesPagedResponse> future = companyServiceClient.listCompaniesPagedCallable().futureCall(request);
   // Do something
   for (Company element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

listCompaniesCallable

public final com.google.api.gax.rpc.UnaryCallable<ListCompaniesRequest,ListCompaniesResponse> listCompaniesCallable()

Lists all companies associated with the project.

Sample code:

 try (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   TenantOrProjectName parent = TenantName.of("[PROJECT]", "[TENANT]");
   ListCompaniesRequest request = ListCompaniesRequest.newBuilder()
     .setParent(parent.toString())
     .build();
   while (true) {
     ListCompaniesResponse response = companyServiceClient.listCompaniesCallable().call(request);
     for (Company element : response.getCompaniesList()) {
       // 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