Event
consul4s.v1.api.Event
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class ConsulApi[F]class ConsulClient[F]
- Self type
-
ConsulApi[F]
Members list
Value members
Concrete methods
PUT /event/fire/:name This endpoint triggers a new user event.
PUT /event/fire/:name This endpoint triggers a new user event.
Value parameters
- dc
-
- Specifies the datacenter to query. This will default to the datacenter of the agent being queried. This is specified as part of the URL as a query parameter. Using this across datacenters is not recommended.
- name
-
- Specifies the name of the event to fire. This is specified as part of the URL. This name must not start with an underscore, since those are reserved for Consul internally.
- node
-
- Specifies a regular expression to filter by node name. This is specified as part of the URL as a query parameter.
- service
-
- Specifies a regular expression to filter by service name. This is specified as part of the URL as a query parameter.
- tag
-
- Specifies a regular expression to filter by tag. This is specified as part of the URL as a query parameter.
- token
-
- consul token
Attributes
- Returns
-
- event info
GET /event/list This endpoint returns the most recent events (up to 256) known by the agent.
GET /event/list This endpoint returns the most recent events (up to 256) known by the agent.
Value parameters
- name
-
- filter events by name
- node
-
- Specifies a regular expression to filter by node name. This is specified as part of the URL as a query parameter.
- service
-
- Specifies a regular expression to filter by service name. This is specified as part of the URL as a query parameter.
- tag
-
- Specifies a regular expression to filter by tag. This is specified as part of the URL as a query parameter.
- token
-
- consul token
Attributes
- Returns
-
- list of events
In this article