Package com.google.cloud.visionai.v1

Class StreamingServiceClient

java.lang.Object
com.google.cloud.visionai.v1.StreamingServiceClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class StreamingServiceClient extends Object implements BackgroundResource
Service Description: Streaming service for receiving and sending packets.

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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   AcquireLeaseRequest request =
       AcquireLeaseRequest.newBuilder()
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .setTerm(Duration.newBuilder().build())
           .setLeaseType(LeaseType.forNumber(0))
           .build();
   Lease response = streamingServiceClient.acquireLease(request);
 }

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

SendPackets

Send packets to the series.

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

  • sendPacketsCallable()

ReceivePackets

Receive packets from the series.

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

  • receivePacketsCallable()

ReceiveEvents

Receive events given the stream name.

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

  • receiveEventsCallable()

AcquireLease

AcquireLease acquires a lease.

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

  • acquireLease(AcquireLeaseRequest request)

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

  • acquireLeaseCallable()

RenewLease

RenewLease renews a lease.

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

  • renewLease(RenewLeaseRequest request)

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

  • renewLeaseCallable()

ReleaseLease

RleaseLease releases a lease.

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

  • releaseLease(ReleaseLeaseRequest request)

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

  • releaseLeaseCallable()

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 StreamingServiceSettings 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
 StreamingServiceSettings streamingServiceSettings =
     StreamingServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 StreamingServiceClient streamingServiceClient =
     StreamingServiceClient.create(streamingServiceSettings);

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
 StreamingServiceSettings streamingServiceSettings =
     StreamingServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 StreamingServiceClient streamingServiceClient =
     StreamingServiceClient.create(streamingServiceSettings);

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
 StreamingServiceSettings streamingServiceSettings =
     StreamingServiceSettings.newHttpJsonBuilder().build();
 StreamingServiceClient streamingServiceClient =
     StreamingServiceClient.create(streamingServiceSettings);

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

  • Constructor Details

    • StreamingServiceClient

      protected StreamingServiceClient(StreamingServiceSettings settings) throws IOException
      Constructs an instance of StreamingServiceClient, 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

    • StreamingServiceClient

      protected StreamingServiceClient(StreamingServiceStub stub)

  • Method Details

    • create

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

    • create

      public static final StreamingServiceClient create(StreamingServiceSettings settings) throws IOException
      Constructs an instance of StreamingServiceClient, 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 StreamingServiceClient create(StreamingServiceStub stub)
      Constructs an instance of StreamingServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(StreamingServiceSettings).

    • getSettings

      public final StreamingServiceSettings getSettings()

    • getStub

      public StreamingServiceStub getStub()

    • sendPacketsCallable

      public final BidiStreamingCallable<SendPacketsRequest,SendPacketsResponse> sendPacketsCallable()
      Send packets to the series.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   BidiStream<SendPacketsRequest, SendPacketsResponse> bidiStream =
       streamingServiceClient.sendPacketsCallable().call();
   SendPacketsRequest request = SendPacketsRequest.newBuilder().build();
   bidiStream.send(request);
   for (SendPacketsResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

    • receivePacketsCallable

      public final BidiStreamingCallable<ReceivePacketsRequest,ReceivePacketsResponse> receivePacketsCallable()
      Receive packets from the series.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   BidiStream<ReceivePacketsRequest, ReceivePacketsResponse> bidiStream =
       streamingServiceClient.receivePacketsCallable().call();
   ReceivePacketsRequest request = ReceivePacketsRequest.newBuilder().build();
   bidiStream.send(request);
   for (ReceivePacketsResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

    • receiveEventsCallable

      public final BidiStreamingCallable<ReceiveEventsRequest,ReceiveEventsResponse> receiveEventsCallable()
      Receive events given the stream 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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   BidiStream<ReceiveEventsRequest, ReceiveEventsResponse> bidiStream =
       streamingServiceClient.receiveEventsCallable().call();
   ReceiveEventsRequest request = ReceiveEventsRequest.newBuilder().build();
   bidiStream.send(request);
   for (ReceiveEventsResponse response : bidiStream) {
     // Do something when a response is received.
   }
 }

    • acquireLease

      public final Lease acquireLease(AcquireLeaseRequest request)
      AcquireLease acquires a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   AcquireLeaseRequest request =
       AcquireLeaseRequest.newBuilder()
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .setTerm(Duration.newBuilder().build())
           .setLeaseType(LeaseType.forNumber(0))
           .build();
   Lease response = streamingServiceClient.acquireLease(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • acquireLeaseCallable

      public final UnaryCallable<AcquireLeaseRequest,Lease> acquireLeaseCallable()
      AcquireLease acquires a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   AcquireLeaseRequest request =
       AcquireLeaseRequest.newBuilder()
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .setTerm(Duration.newBuilder().build())
           .setLeaseType(LeaseType.forNumber(0))
           .build();
   ApiFuture<Lease> future = streamingServiceClient.acquireLeaseCallable().futureCall(request);
   // Do something.
   Lease response = future.get();
 }

    • renewLease

      public final Lease renewLease(RenewLeaseRequest request)
      RenewLease renews a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   RenewLeaseRequest request =
       RenewLeaseRequest.newBuilder()
           .setId("id3355")
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .setTerm(Duration.newBuilder().build())
           .build();
   Lease response = streamingServiceClient.renewLease(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • renewLeaseCallable

      public final UnaryCallable<RenewLeaseRequest,Lease> renewLeaseCallable()
      RenewLease renews a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   RenewLeaseRequest request =
       RenewLeaseRequest.newBuilder()
           .setId("id3355")
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .setTerm(Duration.newBuilder().build())
           .build();
   ApiFuture<Lease> future = streamingServiceClient.renewLeaseCallable().futureCall(request);
   // Do something.
   Lease response = future.get();
 }

    • releaseLease

      public final ReleaseLeaseResponse releaseLease(ReleaseLeaseRequest request)
      RleaseLease releases a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   ReleaseLeaseRequest request =
       ReleaseLeaseRequest.newBuilder()
           .setId("id3355")
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .build();
   ReleaseLeaseResponse response = streamingServiceClient.releaseLease(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • releaseLeaseCallable

      public final UnaryCallable<ReleaseLeaseRequest,ReleaseLeaseResponse> releaseLeaseCallable()
      RleaseLease releases a lease.

      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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   ReleaseLeaseRequest request =
       ReleaseLeaseRequest.newBuilder()
           .setId("id3355")
           .setSeries("series-905838985")
           .setOwner("owner106164915")
           .build();
   ApiFuture<ReleaseLeaseResponse> future =
       streamingServiceClient.releaseLeaseCallable().futureCall(request);
   // Do something.
   ReleaseLeaseResponse response = future.get();
 }

    • listLocations

      public final StreamingServiceClient.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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : streamingServiceClient.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,StreamingServiceClient.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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       streamingServiceClient.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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response =
         streamingServiceClient.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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = streamingServiceClient.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 (StreamingServiceClient streamingServiceClient = StreamingServiceClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = streamingServiceClient.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