Package com.google.cloud.apihub.v1

Class ApiHubCollectClient

java.lang.Object
com.google.cloud.apihub.v1.ApiHubCollectClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class ApiHubCollectClient extends Object implements BackgroundResource
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.

  • Constructor Details

    • ApiHubCollectClient

      protected ApiHubCollectClient(ApiHubCollectSettings settings) throws IOException
      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.
      Throws:
      IOException

    • ApiHubCollectClient

      protected ApiHubCollectClient(ApiHubCollectStub stub)

  • Method Details

    • create

      public static final ApiHubCollectClient create() throws IOException
      Constructs an instance of ApiHubCollectClient with default settings.
      Throws:
      IOException

    • create

      public static final ApiHubCollectClient create(ApiHubCollectSettings settings) throws IOException
      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.
      Throws:
      IOException

    • create

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

    • getSettings

      public final ApiHubCollectSettings getSettings()

    • getStub

      public ApiHubCollectStub getStub()

    • 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.

    • collectApiDataAsync

      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:
      location - Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}`
      collectionType - Required. The type of collection. Applies to all entries in [api_data][google.cloud.apihub.v1.CollectApiDataRequest.api_data].
      apiData - Required. The API data to be collected.
      Throws:
      ApiException - if the remote call fails

    • collectApiDataAsync

      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:
      location - Required. The regional location of the API hub instance and its resources. Format: `projects/{project}/locations/{location}`
      collectionType - Required. The type of collection. Applies to all entries in [api_data][google.cloud.apihub.v1.CollectApiDataRequest.api_data].
      apiData - Required. The API data to be collected.
      Throws:
      ApiException - if the remote call fails

    • collectApiDataAsync

      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();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • 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();
 }

    • listLocations

      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);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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);
   }
 }

    • 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;
     }
   }
 }

    • getLocation

      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);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • 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();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException