Package com.google.cloud.eventarc.publishing.v1 (0.27.0)

Version 0.27.0

• 0.53.0 (latest)
• 0.52.0
• 0.51.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0

A client to Eventarc Publishing API

The interfaces provided are listed below, along with usage samples.

PublisherClient

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.

Sample for PublisherClient:

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

Classes

PublishChannelConnectionEventsRequest

The request message for the PublishChannelConnectionEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsRequest

PublishChannelConnectionEventsRequest.Builder

The request message for the PublishChannelConnectionEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsRequest

PublishChannelConnectionEventsResponse

The response message for the PublishChannelConnectionEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsResponse

PublishChannelConnectionEventsResponse.Builder

The response message for the PublishChannelConnectionEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishChannelConnectionEventsResponse

PublishEventsRequest

The request message for the PublishEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishEventsRequest

PublishEventsRequest.Builder

The request message for the PublishEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishEventsRequest

PublishEventsResponse

The response message for the PublishEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishEventsResponse

PublishEventsResponse.Builder

The response message for the PublishEvents method.

Protobuf type google.cloud.eventarc.publishing.v1.PublishEventsResponse

PublisherClient

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:

1. 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.
2. 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.
3. 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.

PublisherGrpc

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.

PublisherGrpc.PublisherBlockingStub

A stub to allow clients to do synchronous rpc calls to service Publisher.

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.

PublisherGrpc.PublisherFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Publisher.

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.

PublisherGrpc.PublisherImplBase

Base class for the server implementation of the service Publisher.

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.

PublisherGrpc.PublisherStub

A stub to allow clients to do asynchronous rpc calls to service Publisher.

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.

PublisherProto

PublisherSettings

Settings class to configure an instance of PublisherClient.

The default instance has everything set to sensible defaults:

• The default service address (eventarcpublishing.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of publishChannelConnectionEvents to 30 seconds:

 // 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.Builder publisherSettingsBuilder = PublisherSettings.newBuilder();
 publisherSettingsBuilder
     .publishChannelConnectionEventsSettings()
     .setRetrySettings(
         publisherSettingsBuilder
             .publishChannelConnectionEventsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PublisherSettings publisherSettings = publisherSettingsBuilder.build();
 

PublisherSettings.Builder

Builder for PublisherSettings.

Interfaces

PublishChannelConnectionEventsRequestOrBuilder

PublishChannelConnectionEventsResponseOrBuilder

PublishEventsRequestOrBuilder

PublishEventsResponseOrBuilder

PublisherGrpc.AsyncService

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.