Google Cloud Service Health V1 Client - Class Event (0.3.1)

Reference documentation and code samples for the Google Cloud Service Health V1 Client class 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.

Generated from protobuf message google.cloud.servicehealth.v1.Event

Namespace

Google \ Cloud \ ServiceHealth \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ 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/{project_id}/locations/{location}/events/{event_id} .

↳ title
string

Output only. Brief description for the event.

↳ description
string

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

↳ category
int

Output only. The category of the event.

↳ detailed_category
int

Output only. The detailed category of the event.

↳ state
int

Output only. The current state of the event.

↳ detailed_state
int

Output only. The current detailed state of the incident.

↳ event_impacts
array< EventImpact >

Google Cloud products and locations impacted by the event.

↳ relevance
int

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

↳ updates
array< EventUpdate >

Output only. Event updates are correspondence from Google.

↳ parent_event
string

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

↳ update_time
Google\Protobuf\Timestamp

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

↳ start_time
Google\Protobuf\Timestamp

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

↳ end_time
Google\Protobuf\Timestamp

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

↳ next_update_time
Google\Protobuf\Timestamp

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

getName

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

Returns
Type
Description
string

setName

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTitle

Output only. Brief description for the event.

Returns
Type
Description
string

setTitle

Output only. Brief description for the event.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

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

Returns
Type
Description
string

setDescription

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCategory

Output only. The category of the event.

Returns
Type
Description
int

setCategory

Output only. The category of the event.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getDetailedCategory

Output only. The detailed category of the event.

Returns
Type
Description
int

setDetailedCategory

Output only. The detailed category of the event.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getState

Output only. The current state of the event.

Returns
Type
Description
int

setState

Output only. The current state of the event.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getDetailedState

Output only. The current detailed state of the incident.

Returns
Type
Description
int

setDetailedState

Output only. The current detailed state of the incident.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getEventImpacts

Google Cloud products and locations impacted by the event.

Returns
Type
Description

setEventImpacts

Google Cloud products and locations impacted by the event.

Parameter
Name
Description
var
array< EventImpact >
Returns
Type
Description
$this

getRelevance

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

Returns
Type
Description
int

setRelevance

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

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getUpdates

Output only. Event updates are correspondence from Google.

Returns
Type
Description

setUpdates

Output only. Event updates are correspondence from Google.

Parameter
Name
Description
var
array< EventUpdate >
Returns
Type
Description
$this

getParentEvent

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

Returns
Type
Description
string

setParentEvent

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getUpdateTime

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

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getStartTime

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

Returns
Type
Description

hasStartTime

clearStartTime

setStartTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getEndTime

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

Returns
Type
Description

hasEndTime

clearEndTime

setEndTime

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

Parameter
Name
Description
Returns
Type
Description
$this

getNextUpdateTime

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

Returns
Type
Description

hasNextUpdateTime

clearNextUpdateTime

setNextUpdateTime

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

Parameter
Name
Description
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: