Event

google.cloud.servicehealth.v1. Event

Represents an Event.

Constructor

new Event(propertiesopt)

Constructs a new Event.

Parameters:
Name Type Attributes Description
properties google.cloud.servicehealth.v1.IEvent <optional>

Properties to set

Implements:
  • IEvent

Members

category

Event category.

description

Event description.

detailedCategory

Event detailedCategory.

detailedState

Event detailedState.

endTime

Event endTime.

eventImpacts

Event eventImpacts.

name

Event name.

nextUpdateTime

Event nextUpdateTime.

parentEvent

Event parentEvent.

relevance

Event relevance.

startTime

Event startTime.

state

Event state.

title

Event title.

updateTime

Event updateTime.

updates

Event updates.

DetailedCategory

DetailedCategory enum.

Properties:
Name Type Description
DETAILED_CATEGORY_UNSPECIFIED number

DETAILED_CATEGORY_UNSPECIFIED value

CONFIRMED_INCIDENT number

CONFIRMED_INCIDENT value

EMERGING_INCIDENT number

EMERGING_INCIDENT value

DetailedState

DetailedState enum.

Properties:
Name Type Description
DETAILED_STATE_UNSPECIFIED number

DETAILED_STATE_UNSPECIFIED value

EMERGING number

EMERGING value

CONFIRMED number

CONFIRMED value

RESOLVED number

RESOLVED value

MERGED number

MERGED value

AUTO_CLOSED number

AUTO_CLOSED value

FALSE_POSITIVE number

FALSE_POSITIVE value

EventCategory

EventCategory enum.

Properties:
Name Type Description
EVENT_CATEGORY_UNSPECIFIED number

EVENT_CATEGORY_UNSPECIFIED value

INCIDENT number

INCIDENT value

Relevance

Relevance enum.

Properties:
Name Type Description
RELEVANCE_UNSPECIFIED number

RELEVANCE_UNSPECIFIED value

UNKNOWN number

UNKNOWN value

NOT_IMPACTED number

NOT_IMPACTED value

PARTIALLY_RELATED number

PARTIALLY_RELATED value

RELATED number

RELATED value

IMPACTED number

IMPACTED value

State

State enum.

Properties:
Name Type Description
STATE_UNSPECIFIED number

STATE_UNSPECIFIED value

ACTIVE number

ACTIVE value

CLOSED number

CLOSED value

Methods

toJSON() → {Object.<string, *>}

Converts this Event to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.servicehealth.v1.Event}

Creates a new Event instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.servicehealth.v1.IEvent <optional>

Properties to set

Returns:
Type Description
google.cloud.servicehealth.v1.Event

Event instance

(static) decode(reader, lengthopt) → {google.cloud.servicehealth.v1.Event}

Decodes an Event message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.servicehealth.v1.Event

Event

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.servicehealth.v1.Event}

Decodes an Event message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.servicehealth.v1.Event

Event

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified Event message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.servicehealth.v1.IEvent

Event message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

Encodes the specified Event message, length delimited. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.servicehealth.v1.IEvent

Event message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.servicehealth.v1.Event}

Creates an Event message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.servicehealth.v1.Event

Event

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for Event

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

Creates a plain object from an Event message. Also converts values to other types if specified.

Parameters:
Name Type Attributes Description
message google.cloud.servicehealth.v1.Event

Event

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an Event message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not