Package com.google.cloud.eventarc.v1 (1.6.0)

A client to Eventarc API

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

EventarcClient

Service Description: Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

Sample for EventarcClient:


 // 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 (EventarcClient eventarcClient = EventarcClient.create()) {
   TriggerName name = TriggerName.of("[PROJECT]", "[LOCATION]", "[TRIGGER]");
   Trigger response = eventarcClient.getTrigger(name);
 }

Classes

Channel

A representation of the Channel resource. A Channel is a resource on which event providers publish their events. The published events are delivered through the transport associated with the channel. Note that a channel is associated with exactly one event provider.

Protobuf type google.cloud.eventarc.v1.Channel

Channel.Builder

Protobuf type google.cloud.eventarc.v1.Channel

ChannelConnection

A representation of the ChannelConnection resource. A ChannelConnection is a resource which event providers create during the activation process to establish a connection between the provider and the subscriber channel.

Protobuf type google.cloud.eventarc.v1.ChannelConnection

ChannelConnection.Builder

Protobuf type google.cloud.eventarc.v1.ChannelConnection

ChannelConnectionName

ChannelConnectionName.Builder

Builder for projects/{project}/locations/{location}/channelConnections/{channel_connection}.

ChannelConnectionProto

ChannelName

ChannelName.Builder

Builder for projects/{project}/locations/{location}/channels/{channel}.

ChannelProto

CloudRun

Represents a Cloud Run destination.

Protobuf type google.cloud.eventarc.v1.CloudRun

CloudRun.Builder

Represents a Cloud Run destination.

Protobuf type google.cloud.eventarc.v1.CloudRun

CreateChannelConnectionRequest

The request message for the CreateChannelConnection method.

Protobuf type google.cloud.eventarc.v1.CreateChannelConnectionRequest

CreateChannelConnectionRequest.Builder

The request message for the CreateChannelConnection method.

Protobuf type google.cloud.eventarc.v1.CreateChannelConnectionRequest

CreateChannelRequest

The request message for the CreateChannel method.

Protobuf type google.cloud.eventarc.v1.CreateChannelRequest

CreateChannelRequest.Builder

The request message for the CreateChannel method.

Protobuf type google.cloud.eventarc.v1.CreateChannelRequest

CreateTriggerRequest

The request message for the CreateTrigger method.

Protobuf type google.cloud.eventarc.v1.CreateTriggerRequest

CreateTriggerRequest.Builder

The request message for the CreateTrigger method.

Protobuf type google.cloud.eventarc.v1.CreateTriggerRequest

DeleteChannelConnectionRequest

The request message for the DeleteChannelConnection method.

Protobuf type google.cloud.eventarc.v1.DeleteChannelConnectionRequest

DeleteChannelConnectionRequest.Builder

The request message for the DeleteChannelConnection method.

Protobuf type google.cloud.eventarc.v1.DeleteChannelConnectionRequest

DeleteChannelRequest

The request message for the DeleteChannel method.

Protobuf type google.cloud.eventarc.v1.DeleteChannelRequest

DeleteChannelRequest.Builder

The request message for the DeleteChannel method.

Protobuf type google.cloud.eventarc.v1.DeleteChannelRequest

DeleteTriggerRequest

The request message for the DeleteTrigger method.

Protobuf type google.cloud.eventarc.v1.DeleteTriggerRequest

DeleteTriggerRequest.Builder

The request message for the DeleteTrigger method.

Protobuf type google.cloud.eventarc.v1.DeleteTriggerRequest

Destination

Represents a target of an invocation over HTTP.

Protobuf type google.cloud.eventarc.v1.Destination

Destination.Builder

Represents a target of an invocation over HTTP.

Protobuf type google.cloud.eventarc.v1.Destination

DiscoveryProto

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

Protobuf type google.cloud.eventarc.v1.EventFilter

EventFilter.Builder

Filters events based on exact matches on the CloudEvents attributes.

Protobuf type google.cloud.eventarc.v1.EventFilter

EventType

A representation of the event type resource.

Protobuf type google.cloud.eventarc.v1.EventType

EventType.Builder

A representation of the event type resource.

Protobuf type google.cloud.eventarc.v1.EventType

EventarcClient

Service Description: Eventarc allows users to subscribe to various events that are provided by Google Cloud services and forward them to supported destinations.

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 (EventarcClient eventarcClient = EventarcClient.create()) {
   TriggerName name = TriggerName.of("[PROJECT]", "[LOCATION]", "[TRIGGER]");
   Trigger response = eventarcClient.getTrigger(name);
 }

Note: close() needs to be called on the EventarcClient 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 EventarcSettings 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
 EventarcSettings eventarcSettings =
     EventarcSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 EventarcClient eventarcClient = EventarcClient.create(eventarcSettings);

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
 EventarcSettings eventarcSettings =
     EventarcSettings.newBuilder().setEndpoint(myEndpoint).build();
 EventarcClient eventarcClient = EventarcClient.create(eventarcSettings);

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
 EventarcSettings eventarcSettings = EventarcSettings.newHttpJsonBuilder().build();
 EventarcClient eventarcClient = EventarcClient.create(eventarcSettings);

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

The default service address (eventarc.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 getTrigger 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
 EventarcSettings.Builder eventarcSettingsBuilder = EventarcSettings.newBuilder();
 eventarcSettingsBuilder
     .getTriggerSettings()
     .setRetrySettings(
         eventarcSettingsBuilder.getTriggerSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 EventarcSettings eventarcSettings = eventarcSettingsBuilder.build();

EventarcSettings.Builder

Builder for EventarcSettings.

FilteringAttribute

A representation of the FilteringAttribute resource. Filtering attributes are per event type.

Protobuf type google.cloud.eventarc.v1.FilteringAttribute

FilteringAttribute.Builder

A representation of the FilteringAttribute resource. Filtering attributes are per event type.

Protobuf type google.cloud.eventarc.v1.FilteringAttribute

GKE

Represents a GKE destination.

Protobuf type google.cloud.eventarc.v1.GKE

GKE.Builder

Represents a GKE destination.

Protobuf type google.cloud.eventarc.v1.GKE

GetChannelConnectionRequest

The request message for the GetChannelConnection method.

Protobuf type google.cloud.eventarc.v1.GetChannelConnectionRequest

GetChannelConnectionRequest.Builder

The request message for the GetChannelConnection method.

Protobuf type google.cloud.eventarc.v1.GetChannelConnectionRequest

GetChannelRequest

The request message for the GetChannel method.

Protobuf type google.cloud.eventarc.v1.GetChannelRequest

GetChannelRequest.Builder

The request message for the GetChannel method.

Protobuf type google.cloud.eventarc.v1.GetChannelRequest

GetProviderRequest

The request message for the GetProvider method.

Protobuf type google.cloud.eventarc.v1.GetProviderRequest

GetProviderRequest.Builder

The request message for the GetProvider method.

Protobuf type google.cloud.eventarc.v1.GetProviderRequest

GetTriggerRequest

The request message for the GetTrigger method.

Protobuf type google.cloud.eventarc.v1.GetTriggerRequest

GetTriggerRequest.Builder

The request message for the GetTrigger method.

Protobuf type google.cloud.eventarc.v1.GetTriggerRequest

ListChannelConnectionsRequest

The request message for the ListChannelConnections method.

Protobuf type google.cloud.eventarc.v1.ListChannelConnectionsRequest

ListChannelConnectionsRequest.Builder

The request message for the ListChannelConnections method.

Protobuf type google.cloud.eventarc.v1.ListChannelConnectionsRequest

ListChannelConnectionsResponse

The response message for the ListChannelConnections method.

Protobuf type google.cloud.eventarc.v1.ListChannelConnectionsResponse

ListChannelConnectionsResponse.Builder

The response message for the ListChannelConnections method.

Protobuf type google.cloud.eventarc.v1.ListChannelConnectionsResponse

ListChannelsRequest

The request message for the ListChannels method.

Protobuf type google.cloud.eventarc.v1.ListChannelsRequest

ListChannelsRequest.Builder

The request message for the ListChannels method.

Protobuf type google.cloud.eventarc.v1.ListChannelsRequest

ListChannelsResponse

The response message for the ListChannels method.

Protobuf type google.cloud.eventarc.v1.ListChannelsResponse

ListChannelsResponse.Builder

The response message for the ListChannels method.

Protobuf type google.cloud.eventarc.v1.ListChannelsResponse

ListProvidersRequest

The request message for the ListProviders method.

Protobuf type google.cloud.eventarc.v1.ListProvidersRequest

ListProvidersRequest.Builder

The request message for the ListProviders method.

Protobuf type google.cloud.eventarc.v1.ListProvidersRequest

ListProvidersResponse

The response message for the ListProviders method.

Protobuf type google.cloud.eventarc.v1.ListProvidersResponse

ListProvidersResponse.Builder

The response message for the ListProviders method.

Protobuf type google.cloud.eventarc.v1.ListProvidersResponse

ListTriggersRequest

The request message for the ListTriggers method.

Protobuf type google.cloud.eventarc.v1.ListTriggersRequest

ListTriggersRequest.Builder

The request message for the ListTriggers method.

Protobuf type google.cloud.eventarc.v1.ListTriggersRequest

ListTriggersResponse

The response message for the ListTriggers method.

Protobuf type google.cloud.eventarc.v1.ListTriggersResponse

ListTriggersResponse.Builder

The response message for the ListTriggers method.

Protobuf type google.cloud.eventarc.v1.ListTriggersResponse

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.eventarc.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.eventarc.v1.OperationMetadata

Provider

A representation of the Provider resource.

Protobuf type google.cloud.eventarc.v1.Provider

Provider.Builder

A representation of the Provider resource.

Protobuf type google.cloud.eventarc.v1.Provider

ProviderName

ProviderName.Builder

Builder for projects/{project}/locations/{location}/providers/{provider}.

Pubsub

Represents a Pub/Sub transport.

Protobuf type google.cloud.eventarc.v1.Pubsub

Pubsub.Builder

Represents a Pub/Sub transport.

Protobuf type google.cloud.eventarc.v1.Pubsub

Transport

Represents the transport intermediaries created for the trigger to deliver events.

Protobuf type google.cloud.eventarc.v1.Transport

Transport.Builder

Represents the transport intermediaries created for the trigger to deliver events.

Protobuf type google.cloud.eventarc.v1.Transport

Trigger

A representation of the trigger resource.

Protobuf type google.cloud.eventarc.v1.Trigger

Trigger.Builder

A representation of the trigger resource.

Protobuf type google.cloud.eventarc.v1.Trigger

TriggerName

TriggerName.Builder

Builder for projects/{project}/locations/{location}/triggers/{trigger}.

TriggerProto

UpdateChannelRequest

The request message for the UpdateChannel method.

Protobuf type google.cloud.eventarc.v1.UpdateChannelRequest

UpdateChannelRequest.Builder

The request message for the UpdateChannel method.

Protobuf type google.cloud.eventarc.v1.UpdateChannelRequest

UpdateTriggerRequest

The request message for the UpdateTrigger method.

Protobuf type google.cloud.eventarc.v1.UpdateTriggerRequest

UpdateTriggerRequest.Builder

The request message for the UpdateTrigger method.

Protobuf type google.cloud.eventarc.v1.UpdateTriggerRequest

Package com.google.cloud.eventarc.v1 (1.6.0)

EventarcClient

Classes

Interfaces

Enums