REST Resource: projects.locations.events

Resource: Event

Represents service health events that may affect Google Cloud products. Event resource is a read-only view and does not allow any modifications. All fields are output only.

JSON representation
{
  "name": string,
  "title": string,
  "description": string,
  "category": enum (EventCategory),
  "detailedCategory": enum (DetailedCategory),
  "state": enum (State),
  "detailedState": enum (DetailedState),
  "eventImpacts": [
    {
      object (EventImpact)
    }
  ],
  "relevance": enum (Relevance),
  "updates": [
    {
      object (EventUpdate)
    }
  ],
  "parentEvent": string,
  "updateTime": string,
  "startTime": string,
  "endTime": string,
  "nextUpdateTime": string
}
Fields
name

string

Output only. Identifier. Name of the event. Unique name of the event in this scope including project and location using the form projects/{projectId}/locations/{location}/events/{event_id}.

title

string

Output only. Brief description for the event.

description

string

Output only. Free-form, human-readable description.

category

enum (EventCategory)

Output only. The category of the event.

detailedCategory

enum (DetailedCategory)

Output only. The detailed category of the event.

state

enum (State)

Output only. The current state of the event.

detailedState

enum (DetailedState)

Output only. The current detailed state of the incident.

eventImpacts[]

object (EventImpact)

Google Cloud products and locations impacted by the event.

relevance

enum (Relevance)

Output only. Communicates why a given event is deemed relevant in the context of a given project.

updates[]

object (EventUpdate)

Output only. Event updates are correspondence from Google.

parentEvent

string

Output only. When detailedState=MERGED, parentEvent contains the name of the parent event. All further updates will be published to the parent event.

updateTime

string (Timestamp format)

Output only. The time when the event was last modified.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

startTime

string (Timestamp format)

Output only. The start time of the event, if applicable.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

endTime

string (Timestamp format)

Output only. The end time of the event, if applicable.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

nextUpdateTime

string (Timestamp format)

Output only. The time when the next update can be expected.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

EventCategory

The category of the event. This enum lists all possible categories of event.

Enums
EVENT_CATEGORY_UNSPECIFIED Unspecified category.
INCIDENT Event category for service outage or degradation.

DetailedCategory

The detailed category of an event. Contains all possible states for all event categories.

Enums
DETAILED_CATEGORY_UNSPECIFIED Unspecified detailed category.
CONFIRMED_INCIDENT Indicates an event with category INCIDENT has a confirmed impact to at least one Google Cloud product.
EMERGING_INCIDENT Indicates an event with category INCIDENT is under investigation to determine if it has a confirmed impact on any Google Cloud products.

State

The state of the event. This enum lists all possible states of event.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE Event is actively affecting a Google Cloud product and will continue to receive updates.
CLOSED Event is no longer affecting the Google Cloud product or has been merged with another event.

DetailedState

The detailed state of the incident. This enum lists all possible detailed states of an incident.

Enums
DETAILED_STATE_UNSPECIFIED Unspecified detail state.
EMERGING Google engineers are actively investigating the event to determine the impact.
CONFIRMED The incident is confirmed and impacting at least one Google Cloud product. Ongoing status updates will be provided until it is resolved.
RESOLVED The incident is no longer affecting any Google Cloud product, and there will be no further updates.
MERGED The incident was merged into a parent incident. All further updates will be published to the parent only. The parentEvent field contains the name of the parent.
AUTO_CLOSED

The incident was automatically closed because of the following reasons:

  • The impact of the incident could not be confirmed.
  • The incident was intermittent or resolved itself.

The incident does not have a resolution because no action or investigation happened. If it is intermittent, the incident may reopen.

FALSE_POSITIVE Upon investigation, Google engineers concluded that the incident is not affecting a Google Cloud product. This state can change if the incident is reviewed again.

Relevance

Communicates why a given incident is deemed relevant in the context of a given project. This enum lists all possible detailed states of relevance.

Enums
RELEVANCE_UNSPECIFIED Unspecified relevance.
UNKNOWN The relevance of the incident to the project is unknown.
NOT_IMPACTED The incident does not impact the project.
RELATED The incident has a direct connection with your project and impacts a Google Cloud product in a location your project uses.
IMPACTED The incident is verified to be impacting your project.

Methods

get

Retrieves a resource containing information about an event.

list

Lists events under a given project and location.