GitHub Repository | Product Reference | RPC Documentation |
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().
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.
|
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.
|
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.
|
AcquireLease |
AcquireLease acquires a lease. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
RenewLease |
RenewLease renews a lease. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
ReleaseLease |
RleaseLease releases a lease. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return 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 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.
Static Methods
create()
public static final StreamingServiceClient create()
Constructs an instance of StreamingServiceClient with default settings.
Returns | |
---|---|
Type | Description |
StreamingServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(StreamingServiceSettings settings)
public static final StreamingServiceClient create(StreamingServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
StreamingServiceSettings |
Returns | |
---|---|
Type | Description |
StreamingServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(StreamingServiceStub stub)
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).
Parameter | |
---|---|
Name | Description |
stub |
StreamingServiceStub |
Returns | |
---|---|
Type | Description |
StreamingServiceClient |
Constructors
StreamingServiceClient(StreamingServiceSettings settings)
protected StreamingServiceClient(StreamingServiceSettings settings)
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.
Parameter | |
---|---|
Name | Description |
settings |
StreamingServiceSettings |
StreamingServiceClient(StreamingServiceStub stub)
protected StreamingServiceClient(StreamingServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub |
StreamingServiceStub |
Methods
acquireLease(AcquireLeaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
AcquireLeaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Lease |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<AcquireLeaseRequest,Lease> |
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()
getSettings()
public final StreamingServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
StreamingServiceSettings |
getStub()
public StreamingServiceStub getStub()
Returns | |
---|---|
Type | Description |
StreamingServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
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.
}
}
Returns | |
---|---|
Type | Description |
BidiStreamingCallable<ReceiveEventsRequest,ReceiveEventsResponse> |
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.
}
}
Returns | |
---|---|
Type | Description |
BidiStreamingCallable<ReceivePacketsRequest,ReceivePacketsResponse> |
releaseLease(ReleaseLeaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
ReleaseLeaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
ReleaseLeaseResponse |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ReleaseLeaseRequest,ReleaseLeaseResponse> |
renewLease(RenewLeaseRequest request)
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);
}
Parameter | |
---|---|
Name | Description |
request |
RenewLeaseRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
Lease |
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();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<RenewLeaseRequest,Lease> |
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.
}
}
Returns | |
---|---|
Type | Description |
BidiStreamingCallable<SendPacketsRequest,SendPacketsResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()