Index
-
Publisher(interface) -
CloudEvent(message) -
CloudEvent.CloudEventAttributeValue(message) -
PublishChannelConnectionEventsRequest(message) -
PublishChannelConnectionEventsResponse(message) -
PublishEventsRequest(message) -
PublishEventsResponse(message) -
PublishRequest(message) -
PublishResponse(message)
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 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.
rpc Publish(
PublishRequest
) returns ( PublishResponse
)
Publish events to a message bus.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc PublishChannelConnectionEvents(
PublishChannelConnectionEventsRequest
) returns ( PublishChannelConnectionEventsResponse
)
Publish events to a ChannelConnection in a partner's project.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
rpc PublishEvents(
PublishEventsRequest
) returns ( PublishEventsResponse
)
Publish events to a subscriber's channel.
- Authorization scopes
-
Requires the following OAuth scope:
-
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
-
CloudEvent
CloudEvent represents a vendor-neutral specification for defining the format of event data.
id
string
Required. Identifies the event. Producers MUST ensure that source + id is unique for each distinct event.
source
string
Required. Identifies the context in which an event happened. URI-reference
spec_version
string
Required. The version of the CloudEvents specification which the event uses.
type
string
Required. This attribute contains a value describing the type of event related to the originating occurrence.
attributes
map<string,
CloudEventAttributeValue
>
Optional. Used for Optional & Extension Attributes
data
. The event payload. It should be encoded into a media format which is specified by the 'datacontenttype' attribute (e.g. application/json), and adheres to the dataschema format when those respective attributes are present. data
can be only one of the following:binary_data
bytes
Optional. Binary data.
text_data
string
Optional. Text data.
proto_data
Optional. Proto data.
NOTE: The protoData
field only functions as expected when the payload is specifically a CloudEvent
message type, and can't be used for arbitrary protocol buffer messages. For any other protocol buffer type, you must serialize your proto message into bytes, and use the binaryData
field instead.
CloudEventAttributeValue
The following abstract data types are available for use in attributes.
attr
. The value of the attribute. attr
can be only one of the following:ce_boolean
bool
Boolean value.
ce_integer
int32
Integer value.
ce_string
string
String value.
ce_bytes
bytes
Bytes value.
ce_uri
string
URI value.
ce_uri_ref
string
URI-reference value.
PublishChannelConnectionEventsRequest
The request message for the PublishChannelConnectionEvents method.
| Fields | |
|---|---|
channel_connection
|
The channel_connection that the events are published from. For example: |
events[]
|
The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the |
text_events[]
|
The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
for specification. If this field is set, then the |
PublishChannelConnectionEventsResponse
This type has no fields.
The response message for the PublishChannelConnectionEvents method.
PublishEventsRequest
The request message for the PublishEvents method.
| Fields | |
|---|---|
channel
|
The full name of the channel to publish to. For example: |
events[]
|
The CloudEvents v1.0 events to publish. No other types are allowed. If this field is set, then the |
text_events[]
|
The text representation of events to publish. CloudEvent v1.0 in JSON format is the only allowed type. Refer to https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
for specification. If this field is set, then the |
PublishEventsResponse
This type has no fields.
The response message for the PublishEvents method.
PublishRequest
The request message for the Publish method.
message_bus
string
Required. The full name of the message bus to publish events to. Format: projects/{project}/locations/{location}/messageBuses/{messageBus}
.
Union field format
.
format
can be only one of the following:
proto_message
The Protobuf format of the CloudEvent being published. Specification can be found here: https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/protobuf-format.md
json_message
string
The JSON format of the CloudEvent being published. Specification can be found here: https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/json-format.md
avro_message
bytes
The Avro format of the CloudEvent being published. Specification can be found here: https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/formats/avro-format.md
PublishResponse
This type has no fields.
The response message for the Publish method.
