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