- Resource: Trigger
- EventFilter
- Destination
- CloudRun
- GKE
- HttpEndpoint
- NetworkConfig
- Transport
- Pubsub
- StateCondition
- Code
- Methods
Resource: Trigger
A representation of the trigger resource.
JSON representation |
---|
{ "name": string, "uid": string, "createTime": string, "updateTime": string, "eventFilters": [ { object ( |
Fields | |
---|---|
name |
Required. The resource name of the trigger. Must be unique within the location of the project and must be in |
uid |
Output only. Server-assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. |
create |
Output only. The creation time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
update |
Output only. The last-modified time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
event |
Required. Unordered list. The list of filters that applies to event attributes. Only events that match all the provided filters are sent to the destination. |
service |
Optional. The IAM service account email associated with the trigger. The service account represents the identity of the trigger. The |
destination |
Required. Destination specifies where the events should be sent to. |
transport |
Optional. To deliver messages, Eventarc might use other Google Cloud products as a transport intermediary. This field contains a reference to that transport intermediary. This information can be used for debugging purposes. |
labels |
Optional. User labels attached to the triggers that can be used to group resources. An object containing a list of |
channel |
Optional. The name of the channel associated with the trigger in |
conditions |
Output only. The reason(s) why a trigger is in FAILED state. An object containing a list of |
event |
Optional. EventDataContentType specifies the type of payload in MIME format that is expected from the CloudEvent data field. This is set to |
satisfies |
Output only. Whether or not this Trigger satisfies the requirements of physical zone separation |
etag |
Output only. This checksum is computed by the server based on the value of other fields, and might be sent only on create requests to ensure that the client has an up-to-date value before proceeding. |
EventFilter
Filters events based on exact matches on the CloudEvents attributes.
JSON representation |
---|
{ "attribute": string, "value": string, "operator": string } |
Fields | |
---|---|
attribute |
Required. The name of a CloudEvents attribute. Currently, only a subset of attributes are supported for filtering. You can retrieve a specific provider's supported event types. All triggers MUST provide a filter for the 'type' attribute. |
value |
Required. The value for the attribute. |
operator |
Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The allowed values are |
Destination
Represents a target of an invocation over HTTP.
JSON representation |
---|
{ "networkConfig": { object ( |
Fields | |
---|---|
network |
Optional. Network config is used to configure how Eventarc resolves and connect to a destination. This should only be used with HttpEndpoint destination type. |
Union field
|
|
cloud |
Cloud Run fully-managed resource that receives the events. The resource should be in the same project as the trigger. |
cloud |
The Cloud Function resource name. Cloud Functions V1 and V2 are supported. Format: This is a read-only field. Creating Cloud Functions V1/V2 triggers is only supported via the Cloud Functions product. An error will be returned if the user sets this value. |
gke |
A GKE service capable of receiving events. The service should be running in the same project as the trigger. |
workflow |
The resource name of the Workflow whose Executions are triggered by the events. The Workflow resource should be deployed in the same project as the trigger. Format: |
http |
An HTTP endpoint destination described by an URI. |
CloudRun
Represents a Cloud Run destination.
JSON representation |
---|
{ "service": string, "path": string, "region": string } |
Fields | |
---|---|
service |
Required. The name of the Cloud Run service being addressed. See https://cloud.google.com/run/docs/reference/rest/v1/namespaces.services. Only services located in the same project as the trigger object can be addressed. |
path |
Optional. The relative path on the Cloud Run service the events should be sent to. The value must conform to the definition of a URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". |
region |
Required. The region the Cloud Run service is deployed in. |
GKE
Represents a GKE destination.
JSON representation |
---|
{ "cluster": string, "location": string, "namespace": string, "service": string, "path": string } |
Fields | |
---|---|
cluster |
Required. The name of the cluster the GKE service is running in. The cluster must be running in the same project as the trigger being created. |
location |
Required. The name of the Google Compute Engine in which the cluster resides, which can either be compute zone (for example, us-central1-a) for the zonal clusters or region (for example, us-central1) for regional clusters. |
namespace |
Required. The namespace the GKE service is running in. |
service |
Required. Name of the GKE service. |
path |
Optional. The relative path on the GKE service the events should be sent to. The value must conform to the definition of a URI path segment (section 3.3 of RFC2396). Examples: "/route", "route", "route/subroute". |
HttpEndpoint
Represents a HTTP endpoint destination.
JSON representation |
---|
{ "uri": string } |
Fields | |
---|---|
uri |
Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: |
NetworkConfig
Network Configuration that can be inherited by other protos.
JSON representation |
---|
{ "networkAttachment": string } |
Fields | |
---|---|
network |
Required. Name of the NetworkAttachment that allows access to the customer's VPC. Format: |
Transport
Represents the transport intermediaries created for the trigger to deliver events.
JSON representation |
---|
{ // Union field |
Fields | |
---|---|
Union field
|
|
pubsub |
The Pub/Sub topic and subscription used by Eventarc as a transport intermediary. |
Pubsub
Represents a Pub/Sub transport.
JSON representation |
---|
{ "topic": string, "subscription": string } |
Fields | |
---|---|
topic |
Optional. The name of the Pub/Sub topic created and managed by Eventarc as a transport for the event delivery. Format: You can set an existing topic for triggers of the type |
subscription |
Output only. The name of the Pub/Sub subscription created and managed by Eventarc as a transport for the event delivery. Format: |
StateCondition
A condition that is part of the trigger state computation.
JSON representation |
---|
{
"code": enum ( |
Fields | |
---|---|
code |
The canonical code of the condition. |
message |
Human-readable message. |
Code
The canonical error codes for gRPC APIs.
Sometimes multiple error codes may apply. Services should return the most specific error code that applies. For example, prefer OUT_OF_RANGE
over FAILED_PRECONDITION
if both codes apply. Similarly prefer NOT_FOUND
or ALREADY_EXISTS
over FAILED_PRECONDITION
.
Enums | |
---|---|
OK |
Not an error; returned on success. HTTP Mapping: 200 OK |
CANCELLED |
The operation was cancelled, typically by the caller. HTTP Mapping: 499 Client Closed Request |
UNKNOWN |
Unknown error. For example, this error may be returned when a HTTP Mapping: 500 Internal Server Error |
INVALID_ARGUMENT |
The client specified an invalid argument. Note that this differs from HTTP Mapping: 400 Bad Request |
DEADLINE_EXCEEDED |
The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. HTTP Mapping: 504 Gateway Timeout |
NOT_FOUND |
Some requested entity (e.g., file or directory) was not found. Note to server developers: if a request is denied for an entire class of users, such as gradual feature rollout or undocumented allowlist, HTTP Mapping: 404 Not Found |
ALREADY_EXISTS |
The entity that a client attempted to create (e.g., file or directory) already exists. HTTP Mapping: 409 Conflict |
PERMISSION_DENIED |
The caller does not have permission to execute the specified operation. HTTP Mapping: 403 Forbidden |
UNAUTHENTICATED |
The request does not have valid authentication credentials for the operation. HTTP Mapping: 401 Unauthorized |
RESOURCE_EXHAUSTED |
Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. HTTP Mapping: 429 Too Many Requests |
FAILED_PRECONDITION |
The operation was rejected because the system is not in a state required for the operation's execution. For example, the directory to be deleted is non-empty, an rmdir operation is applied to a non-directory, etc. Service implementors can use the following guidelines to decide between HTTP Mapping: 400 Bad Request |
ABORTED |
The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort. See the guidelines above for deciding between HTTP Mapping: 409 Conflict |
OUT_OF_RANGE |
The operation was attempted past the valid range. E.g., seeking or reading past end-of-file. Unlike There is a fair bit of overlap between HTTP Mapping: 400 Bad Request |
UNIMPLEMENTED |
The operation is not implemented or is not supported/enabled in this service. HTTP Mapping: 501 Not Implemented |
INTERNAL |
Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors. HTTP Mapping: 500 Internal Server Error |
UNAVAILABLE |
The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations. See the guidelines above for deciding between HTTP Mapping: 503 Service Unavailable |
DATA_LOSS |
Unrecoverable data loss or corruption. HTTP Mapping: 500 Internal Server Error |
Methods |
|
---|---|
|
Create a new trigger in a particular project and location. |
|
Delete a single trigger. |
|
Get a single trigger. |
|
Gets the access control policy for a resource. |
|
List triggers. |
|
Update a single trigger. |
|
Sets the access control policy on the specified resource. |
|
Returns permissions that a caller has on the specified resource. |