Class PublisherClient (0.23.0)

public class PublisherClient implements BackgroundResource

Service Description: Eventarc processes events generated by an event provider and delivers them to a subscriber.

An event provider is a software-as-a-service (SaaS) system or product that can generate and deliver events through Eventarc.

A third-party event provider is an event provider from outside of Google.

A partner is a third-party event provider that is integrated with Eventarc.

A subscriber is a GCP customer interested in receiving events.

Channel is a first-class Eventarc resource that is created and managed by the subscriber in their GCP project. A Channel represents a subscriber's intent to receive events from an event provider. A Channel is associated with exactly one event provider.

ChannelConnection is a first-class Eventarc resource that is created and managed by the partner in their GCP project. A ChannelConnection represents a connection between a partner and a subscriber's Channel. A ChannelConnection has a one-to-one mapping with a Channel.

Publisher allows an event provider to publish events to Eventarc.

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 (PublisherClient publisherClient = PublisherClient.create()) {
   PublishChannelConnectionEventsRequest request =
       PublishChannelConnectionEventsRequest.newBuilder()
           .setChannelConnection("channelConnection-1932021695")
           .addAllEvents(new ArrayList<Any>())
           .addAllTextEvents(new ArrayList<String>())
           .build();
   PublishChannelConnectionEventsResponse response =
       publisherClient.publishChannelConnectionEvents(request);
 }

Note: close() needs to be called on the PublisherClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns 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 PublisherSettings 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
 PublisherSettings publisherSettings =
     PublisherSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 PublisherClient publisherClient = PublisherClient.create(publisherSettings);

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
 PublisherSettings publisherSettings =
     PublisherSettings.newBuilder().setEndpoint(myEndpoint).build();
 PublisherClient publisherClient = PublisherClient.create(publisherSettings);

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
 PublisherSettings publisherSettings = PublisherSettings.newHttpJsonBuilder().build();
 PublisherClient publisherClient = PublisherClient.create(publisherSettings);

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

Inheritance

java.lang.Object > PublisherClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final PublisherClient create()

Constructs an instance of PublisherClient with default settings.

Returns
Type	Description
`PublisherClient`

Exceptions
Type	Description
`IOException`

create(PublisherSettings settings)

public static final PublisherClient create(PublisherSettings settings)

Constructs an instance of PublisherClient, 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`	`PublisherSettings`

Returns
Type	Description
`PublisherClient`

Exceptions
Type	Description
`IOException`

create(PublisherStub stub)

public static final PublisherClient create(PublisherStub stub)

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

Parameter
Name	Description
`stub`	`PublisherStub`

Returns
Type	Description
`PublisherClient`

Constructors

PublisherClient(PublisherSettings settings)

protected PublisherClient(PublisherSettings settings)

Constructs an instance of PublisherClient, 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`	`PublisherSettings`

PublisherClient(PublisherStub stub)

protected PublisherClient(PublisherStub stub)

Parameter
Name	Description
`stub`	`PublisherStub`

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

getSettings()

public final PublisherSettings getSettings()

Returns
Type	Description
`PublisherSettings`

getStub()

public PublisherStub getStub()

Returns
Type	Description
`PublisherStub`

isShutdown()

public boolean isShutdown()

Returns
Type	Description
`boolean`

isTerminated()

public boolean isTerminated()

Returns
Type	Description
`boolean`

publishChannelConnectionEvents(PublishChannelConnectionEventsRequest request)

public final PublishChannelConnectionEventsResponse publishChannelConnectionEvents(PublishChannelConnectionEventsRequest request)

Publish events to a ChannelConnection in a partner's project.

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 (PublisherClient publisherClient = PublisherClient.create()) {
   PublishChannelConnectionEventsRequest request =
       PublishChannelConnectionEventsRequest.newBuilder()
           .setChannelConnection("channelConnection-1932021695")
           .addAllEvents(new ArrayList<Any>())
           .addAllTextEvents(new ArrayList<String>())
           .build();
   PublishChannelConnectionEventsResponse response =
       publisherClient.publishChannelConnectionEvents(request);
 }

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

Returns
Type	Description
`PublishChannelConnectionEventsResponse`

publishChannelConnectionEventsCallable()

public final UnaryCallable<PublishChannelConnectionEventsRequest,PublishChannelConnectionEventsResponse> publishChannelConnectionEventsCallable()

Publish events to a ChannelConnection in a partner's project.

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 (PublisherClient publisherClient = PublisherClient.create()) {
   PublishChannelConnectionEventsRequest request =
       PublishChannelConnectionEventsRequest.newBuilder()
           .setChannelConnection("channelConnection-1932021695")
           .addAllEvents(new ArrayList<Any>())
           .addAllTextEvents(new ArrayList<String>())
           .build();
   ApiFuture<PublishChannelConnectionEventsResponse> future =
       publisherClient.publishChannelConnectionEventsCallable().futureCall(request);
   // Do something.
   PublishChannelConnectionEventsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<PublishChannelConnectionEventsRequest,PublishChannelConnectionEventsResponse>`

publishEvents(PublishEventsRequest request)

public final PublishEventsResponse publishEvents(PublishEventsRequest request)

Publish events to a subscriber's channel.

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 (PublisherClient publisherClient = PublisherClient.create()) {
   PublishEventsRequest request =
       PublishEventsRequest.newBuilder()
           .setChannel("channel738950403")
           .addAllEvents(new ArrayList<Any>())
           .addAllTextEvents(new ArrayList<String>())
           .build();
   PublishEventsResponse response = publisherClient.publishEvents(request);
 }

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

Returns
Type	Description
`PublishEventsResponse`

publishEventsCallable()

public final UnaryCallable<PublishEventsRequest,PublishEventsResponse> publishEventsCallable()

Publish events to a subscriber's channel.

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 (PublisherClient publisherClient = PublisherClient.create()) {
   PublishEventsRequest request =
       PublishEventsRequest.newBuilder()
           .setChannel("channel738950403")
           .addAllEvents(new ArrayList<Any>())
           .addAllTextEvents(new ArrayList<String>())
           .build();
   ApiFuture<PublishEventsResponse> future =
       publisherClient.publishEventsCallable().futureCall(request);
   // Do something.
   PublishEventsResponse response = future.get();
 }

Returns
Type	Description
`UnaryCallable<PublishEventsRequest,PublishEventsResponse>`

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()