Class CompanyServiceClient (0.5.0)

Service Description: Provides methods for handling Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyName.of("[NETWORK_CODE]", "[COMPANY]");
   Company response = companyServiceClient.getCompany(name);
 }

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().

Methods
Method	Description	Method Variants
GetCompany	API to retrieve a `Company` object.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getCompany(GetCompanyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getCompany(CompanyName name) getCompany(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getCompanyCallable()
ListCompanies	API to retrieve a list of `Company` objects.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listCompanies(ListCompaniesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listCompanies(NetworkName parent) listCompanies(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listCompaniesPagedCallable() listCompaniesCallable()

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:


 // 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
 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 CompanyServiceClient companyServiceClient = CompanyServiceClient.create(companyServiceSettings);

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
 CompanyServiceSettings companyServiceSettings =
     CompanyServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 CompanyServiceClient companyServiceClient = CompanyServiceClient.create(companyServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > CompanyServiceClient

Static Methods

create()

public static final CompanyServiceClient create()

Constructs an instance of CompanyServiceClient with default settings.

Returns
Type	Description
`CompanyServiceClient`

Exceptions
Type	Description
`IOException`

create(CompanyServiceSettings settings)

public static final CompanyServiceClient create(CompanyServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`CompanyServiceSettings`

Returns
Type	Description
`CompanyServiceClient`

Exceptions
Type	Description
`IOException`

create(CompanyServiceStub stub)

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 using create(CompanyServiceSettings).

Parameter
Name	Description
`stub`	`CompanyServiceStub`

Returns
Type	Description
`CompanyServiceClient`

Constructors

CompanyServiceClient(CompanyServiceSettings settings)

protected CompanyServiceClient(CompanyServiceSettings settings)

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.

Parameter
Name	Description
`settings`	`CompanyServiceSettings`

CompanyServiceClient(CompanyServiceStub stub)

protected CompanyServiceClient(CompanyServiceStub stub)

Parameter
Name	Description
`stub`	`CompanyServiceStub`

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
`duration`	`long`
`unit`	`TimeUnit`

Returns
Type	Description
`boolean`

Exceptions
Type	Description
`InterruptedException`

close()

public final void close()

getCompany(CompanyName name)

public final Company getCompany(CompanyName name)

API to retrieve a Company object.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   CompanyName name = CompanyName.of("[NETWORK_CODE]", "[COMPANY]");
   Company response = companyServiceClient.getCompany(name);
 }

Parameter
Name	Description
`name`	`CompanyName` Required. The resource name of the Company. Format: `networks/{network_code}/companies/{company_id}`

Returns
Type	Description
`Company`

getCompany(GetCompanyRequest request)

public final Company getCompany(GetCompanyRequest request)

API to retrieve a Company object.

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

Parameter
Name	Description
`request`	`GetCompanyRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`Company`

getCompany(String name)

public final Company getCompany(String name)

API to retrieve a Company object.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   String name = CompanyName.of("[NETWORK_CODE]", "[COMPANY]").toString();
   Company response = companyServiceClient.getCompany(name);
 }

Parameter
Name	Description
`name`	`String` Required. The resource name of the Company. Format: `networks/{network_code}/companies/{company_id}`

Returns
Type	Description
`Company`

getCompanyCallable()

public final UnaryCallable<GetCompanyRequest,Company> getCompanyCallable()

API to retrieve a Company object.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   GetCompanyRequest request =
       GetCompanyRequest.newBuilder()
           .setName(CompanyName.of("[NETWORK_CODE]", "[COMPANY]").toString())
           .build();
   ApiFuture<Company> future = companyServiceClient.getCompanyCallable().futureCall(request);
   // Do something.
   Company response = future.get();
 }

Returns
Type	Description
`UnaryCallable<GetCompanyRequest,Company>`

getSettings()

public final CompanyServiceSettings getSettings()

Returns
Type	Description
`CompanyServiceSettings`

getStub()

public CompanyServiceStub getStub()

Returns
Type	Description
`CompanyServiceStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

listCompanies(ListCompaniesRequest request)

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(ListCompaniesRequest request)

API to retrieve a list of Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   ListCompaniesRequest request =
       ListCompaniesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   for (Company element : companyServiceClient.listCompanies(request).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`request`	`ListCompaniesRequest` The request object containing all of the parameters for the API call.

Returns
Type	Description
`CompanyServiceClient.ListCompaniesPagedResponse`

listCompanies(NetworkName parent)

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(NetworkName parent)

API to retrieve a list of Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   NetworkName parent = NetworkName.of("[NETWORK_CODE]");
   for (Company element : companyServiceClient.listCompanies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`NetworkName` Required. The parent, which owns this collection of Companies. Format: `networks/{network_code}`

Returns
Type	Description
`CompanyServiceClient.ListCompaniesPagedResponse`

listCompanies(String parent)

public final CompanyServiceClient.ListCompaniesPagedResponse listCompanies(String parent)

API to retrieve a list of Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   String parent = NetworkName.of("[NETWORK_CODE]").toString();
   for (Company element : companyServiceClient.listCompanies(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }

Parameter
Name	Description
`parent`	`String` Required. The parent, which owns this collection of Companies. Format: `networks/{network_code}`

Returns
Type	Description
`CompanyServiceClient.ListCompaniesPagedResponse`

listCompaniesCallable()

public final UnaryCallable<ListCompaniesRequest,ListCompaniesResponse> listCompaniesCallable()

API to retrieve a list of Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   ListCompaniesRequest request =
       ListCompaniesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .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;
     }
   }
 }

Returns
Type	Description
`UnaryCallable<ListCompaniesRequest,ListCompaniesResponse>`

listCompaniesPagedCallable()

public final UnaryCallable<ListCompaniesRequest,CompanyServiceClient.ListCompaniesPagedResponse> listCompaniesPagedCallable()

API to retrieve a list of Company objects.

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 (CompanyServiceClient companyServiceClient = CompanyServiceClient.create()) {
   ListCompaniesRequest request =
       ListCompaniesRequest.newBuilder()
           .setParent(NetworkName.of("[NETWORK_CODE]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .setSkip(3532159)
           .build();
   ApiFuture<Company> future =
       companyServiceClient.listCompaniesPagedCallable().futureCall(request);
   // Do something.
   for (Company element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

Returns
Type	Description
`UnaryCallable<ListCompaniesRequest,ListCompaniesPagedResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()