Package com.google.cloud.eventarc.publishing.v1

Class PublisherClient

java.lang.Object
com.google.cloud.eventarc.publishing.v1.PublisherClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class PublisherClient extends Object 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 Google Cloud customer interested in receiving events.

Channel is a first-class Eventarc resource that is created and managed by the subscriber in their Google Cloud 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 Google Cloud 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.

Bus is a first-class Eventarc resource that is created and managed in a Google Cloud project. A Bus provides a discoverable endpoint for events and is a router that receives all events published by event providers and delivers them to zero or more subscribers.

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

Methods
Method Description Method Variants

PublishChannelConnectionEvents

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

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

  • publishChannelConnectionEvents(PublishChannelConnectionEventsRequest request)

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

  • publishChannelConnectionEventsCallable()

PublishEvents

Publish events to a subscriber's channel.

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

  • publishEvents(PublishEventsRequest request)

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

  • publishEventsCallable()

Publish

Publish events to a message bus.

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

  • publish(PublishRequest request)

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

  • publishCallable()

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.

  • Constructor Details

    • PublisherClient

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

    • PublisherClient

      protected PublisherClient(PublisherStub stub)

  • Method Details

    • create

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

    • create

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

    • create

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

    • getSettings

      public final PublisherSettings getSettings()

    • getStub

      public PublisherStub getStub()

    • publishChannelConnectionEvents

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

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

    • publishEvents

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

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

    • publish

      public final PublishResponse publish(PublishRequest request)
      Publish events to a message bus.

      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()) {
   PublishRequest request =
       PublishRequest.newBuilder().setMessageBus("messageBus-1690749703").build();
   PublishResponse response = publisherClient.publish(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • publishCallable

      public final UnaryCallable<PublishRequest,PublishResponse> publishCallable()
      Publish events to a message bus.

      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()) {
   PublishRequest request =
       PublishRequest.newBuilder().setMessageBus("messageBus-1690749703").build();
   ApiFuture<PublishResponse> future = publisherClient.publishCallable().futureCall(request);
   // Do something.
   PublishResponse 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