Class ApiHubCollectClient (0.28.0)

GitHub RepositoryProduct Reference

Service Description: This service exposes methods used for collecting various types of data from different first party and third party sources and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = apiHubCollectClient.getLocation(request);
 }

Note: close() needs to be called on the ApiHubCollectClient 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

CollectApiData

Collect API data from a source and push it to Hub's collect layer.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • collectApiDataAsync(CollectApiDataRequest request)

Methods that return long-running operations have "Async" method variants that return OperationFuture, which is used to track polling of the service.

  • collectApiDataAsync(LocationName location, CollectionType collectionType, ApiData apiData)

  • collectApiDataAsync(String location, CollectionType collectionType, ApiData apiData)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • collectApiDataOperationCallable()

  • collectApiDataCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

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 ApiHubCollectSettings 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
 ApiHubCollectSettings apiHubCollectSettings =
     ApiHubCollectSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create(apiHubCollectSettings);

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
 ApiHubCollectSettings apiHubCollectSettings =
     ApiHubCollectSettings.newBuilder().setEndpoint(myEndpoint).build();
 ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create(apiHubCollectSettings);

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

Inheritance

java.lang.Object > ApiHubCollectClient

Static Methods

create()

public static final ApiHubCollectClient create()

Constructs an instance of ApiHubCollectClient with default settings.

Returns
Type Description
ApiHubCollectClient
Exceptions
Type Description
IOException

create(ApiHubCollectSettings settings)

public static final ApiHubCollectClient create(ApiHubCollectSettings settings)

Constructs an instance of ApiHubCollectClient, 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 ApiHubCollectSettings
Returns
Type Description
ApiHubCollectClient
Exceptions
Type Description
IOException

create(ApiHubCollectStub stub)

public static final ApiHubCollectClient create(ApiHubCollectStub stub)

Constructs an instance of ApiHubCollectClient, using the given stub for making calls. This is for advanced usage - prefer using create(ApiHubCollectSettings).

Parameter
Name Description
stub ApiHubCollectStub
Returns
Type Description
ApiHubCollectClient

Constructors

ApiHubCollectClient(ApiHubCollectSettings settings)

protected ApiHubCollectClient(ApiHubCollectSettings settings)

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

ApiHubCollectClient(ApiHubCollectStub stub)

protected ApiHubCollectClient(ApiHubCollectStub stub)
Parameter
Name Description
stub ApiHubCollectStub

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

collectApiDataAsync(CollectApiDataRequest request)

public final OperationFuture<CollectApiDataResponse,OperationMetadata> collectApiDataAsync(CollectApiDataRequest request)

Collect API data from a source and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   CollectApiDataRequest request =
       CollectApiDataRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCollectionType(CollectionType.forNumber(0))
           .setPluginInstance(
               PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
                   .toString())
           .setActionId("actionId-1656172047")
           .setApiData(ApiData.newBuilder().build())
           .build();
   CollectApiDataResponse response = apiHubCollectClient.collectApiDataAsync(request).get();
 }
Parameter
Name Description
request CollectApiDataRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
OperationFuture<CollectApiDataResponse,OperationMetadata>

collectApiDataAsync(LocationName location, CollectionType collectionType, ApiData apiData)

public final OperationFuture<CollectApiDataResponse,OperationMetadata> collectApiDataAsync(LocationName location, CollectionType collectionType, ApiData apiData)

Collect API data from a source and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   LocationName location = LocationName.of("[PROJECT]", "[LOCATION]");
   CollectionType collectionType = CollectionType.forNumber(0);
   ApiData apiData = ApiData.newBuilder().build();
   CollectApiDataResponse response =
       apiHubCollectClient.collectApiDataAsync(location, collectionType, apiData).get();
 }
Parameters
Name Description
location LocationName

Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}
collectionType CollectionType

Required. The type of collection. Applies to all entries in api_data.
apiData ApiData

Required. The API data to be collected.
Returns
Type Description
OperationFuture<CollectApiDataResponse,OperationMetadata>

collectApiDataAsync(String location, CollectionType collectionType, ApiData apiData)

public final OperationFuture<CollectApiDataResponse,OperationMetadata> collectApiDataAsync(String location, CollectionType collectionType, ApiData apiData)

Collect API data from a source and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   String location = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   CollectionType collectionType = CollectionType.forNumber(0);
   ApiData apiData = ApiData.newBuilder().build();
   CollectApiDataResponse response =
       apiHubCollectClient.collectApiDataAsync(location, collectionType, apiData).get();
 }
Parameters
Name Description
location String

Required. The regional location of the API hub instance and its resources. Format: projects/{project}/locations/{location}
collectionType CollectionType

Required. The type of collection. Applies to all entries in api_data.
apiData ApiData

Required. The API data to be collected.
Returns
Type Description
OperationFuture<CollectApiDataResponse,OperationMetadata>

collectApiDataCallable()

public final UnaryCallable<CollectApiDataRequest,Operation> collectApiDataCallable()

Collect API data from a source and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   CollectApiDataRequest request =
       CollectApiDataRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCollectionType(CollectionType.forNumber(0))
           .setPluginInstance(
               PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
                   .toString())
           .setActionId("actionId-1656172047")
           .setApiData(ApiData.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       apiHubCollectClient.collectApiDataCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
Returns
Type Description
UnaryCallable<CollectApiDataRequest,Operation>

collectApiDataOperationCallable()

public final OperationCallable<CollectApiDataRequest,CollectApiDataResponse,OperationMetadata> collectApiDataOperationCallable()

Collect API data from a source and push it to Hub's collect layer.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   CollectApiDataRequest request =
       CollectApiDataRequest.newBuilder()
           .setLocation(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setCollectionType(CollectionType.forNumber(0))
           .setPluginInstance(
               PluginInstanceName.of("[PROJECT]", "[LOCATION]", "[PLUGIN]", "[INSTANCE]")
                   .toString())
           .setActionId("actionId-1656172047")
           .setApiData(ApiData.newBuilder().build())
           .build();
   OperationFuture<CollectApiDataResponse, OperationMetadata> future =
       apiHubCollectClient.collectApiDataOperationCallable().futureCall(request);
   // Do something.
   CollectApiDataResponse response = future.get();
 }
Returns
Type Description
OperationCallable<CollectApiDataRequest,CollectApiDataResponse,OperationMetadata>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
Type Description
OperationsClient

getLocation(GetLocationRequest request)

public final Location getLocation(GetLocationRequest request)

Gets information about a location.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = apiHubCollectClient.getLocation(request);
 }
Parameter
Name Description
request com.google.cloud.location.GetLocationRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
com.google.cloud.location.Location

getLocationCallable()

public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()

Gets information about a location.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = apiHubCollectClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getSettings()

public final ApiHubCollectSettings getSettings()
Returns
Type Description
ApiHubCollectSettings

getStub()

public ApiHubCollectStub getStub()
Returns
Type Description
ApiHubCollectStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listLocations(ListLocationsRequest request)

public final ApiHubCollectClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)

Lists information about the supported locations for this service.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : apiHubCollectClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request com.google.cloud.location.ListLocationsRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ApiHubCollectClient.ListLocationsPagedResponse

listLocationsCallable()

public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()

Lists information about the supported locations for this service.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = apiHubCollectClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse>

listLocationsPagedCallable()

public final UnaryCallable<ListLocationsRequest,ApiHubCollectClient.ListLocationsPagedResponse> listLocationsPagedCallable()

Lists information about the supported locations for this service.

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 (ApiHubCollectClient apiHubCollectClient = ApiHubCollectClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       apiHubCollectClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<com.google.cloud.location.ListLocationsRequest,ListLocationsPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()