- Resource: EventSubscription
- EventSubscriptionStatus
- State
- EventSubscriptionDestination
- Type
- EndPoint
- Header
- JMS
- Type
- Methods
Resource: EventSubscription
represents the Connector's EventSubscription resource
JSON representation |
---|
{ "name": string, "createTime": string, "updateTime": string, "eventTypeId": string, "subscriber": string, "subscriberLink": string, "status": { object ( |
Fields | |
---|---|
name |
Required. Resource name of the EventSubscription. Format: projects/{project}/locations/{location}/connections/{connection}/eventSubscriptions/{eventSubscription} |
createTime |
Output only. Created time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. Updated time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
eventTypeId |
Optional. Event type id of the event of current EventSubscription. |
subscriber |
Optional. name of the Subscriber for the current EventSubscription. |
subscriberLink |
Optional. Link for Subscriber of the current EventSubscription. |
status |
Optional. Status indicates the status of the event subscription resource |
destinations |
Optional. The destination to hit when we receive an event |
Union field source . The source of the event source can be only one of the following: |
|
jms |
Optional. JMS is the source for the event listener. |
EventSubscriptionStatus
EventSubscription Status denotes the status of the EventSubscription resource.
JSON representation |
---|
{
"state": enum ( |
Fields | |
---|---|
state |
Output only. State of Event Subscription resource. |
description |
Output only. Description of the state. |
State
All the possible EventSubscription statuses.
Enums | |
---|---|
STATE_UNSPECIFIED |
Default state. |
CREATING |
EventSubscription creation is in progress. |
UPDATING |
EventSubscription is in Updating status. |
ACTIVE |
EventSubscription is in Active state and is ready to receive events. |
SUSPENDED |
EventSubscription is currently suspended. |
ERROR |
EventSubscription is in Error state. |
EventSubscriptionDestination
Message for EventSubscription Destination to act on receiving an event
JSON representation |
---|
{ "type": enum ( |
Fields | |
---|---|
type |
type of the destination |
serviceAccount |
Service account needed for runtime plane to trigger IP workflow. |
Union field
|
|
endpoint |
OPTION 1: Hit an endpoint when we receive an event. |
Type
Types of the Destination in EventSubscription
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default state. |
ENDPOINT |
Endpoint - Hit the value of endpoint when event is received |
EndPoint
Endpoint message includes details of the Destination endpoint.
JSON representation |
---|
{
"endpointUri": string,
"headers": [
{
object ( |
Fields | |
---|---|
endpointUri |
The URI of the Endpoint. |
headers[] |
List of Header to be added to the Endpoint. |
Header
Header details for a given header to be added to Endpoint.
JSON representation |
---|
{ "key": string, "value": string } |
Fields | |
---|---|
key |
Key of Header. |
value |
Value of Header. |
JMS
JMS message denotes the source of the event
JSON representation |
---|
{
"type": enum ( |
Fields | |
---|---|
type |
Optional. Type of the JMS Source. i.e. Queue or Topic |
name |
Optional. Name of the JMS source. i.e. queueName or topicName |
Type
Type of the JMS Source. i.e. Queue or Topic
Enums | |
---|---|
TYPE_UNSPECIFIED |
Default state. |
QUEUE |
JMS Queue. |
TOPIC |
JMS Topic. |
Methods |
|
---|---|
|
Creates a new EventSubscription in a given project,location and connection. |
|
Deletes a single EventSubscription. |
|
Gets details of a single EventSubscription. |
|
List EventSubscriptions in a given project,location and connection. |
|
Updates the parameters of a single EventSubscription. |
|
RetryEventSubscription retries the registration of Subscription. |