Google Cloud Service Health V1 Client - Class OrganizationEvent (0.2.1)

Version latest

• 0.2.1 (latest)
• 0.2.0
• 0.1.8

Reference documentation and code samples for the Google Cloud Service Health V1 Client class OrganizationEvent.

Represents service health events that may affect Google Cloud products used across the organization. It is a read-only view and does not allow any modifications.

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

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 organization ID and location using the form organizations/{organization_id}/locations/{location}/organizationEvents/{event_id}. organization_id - see Getting your organization resource ID. location - The location to get the service health events from. event_id - Organization event ID to retrieve.
↳ 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> Output only. Represents the Google Cloud products and locations impacted by the event.
↳ updates	array<EventUpdate> Output only. Incident-only field. 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 the update was posted.
↳ 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. Incident-only field. 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 organization ID and location using the form organizations/{organization_id}/locations/{location}/organizationEvents/{event_id}.

organization_id - see Getting your organization resource ID.
location - The location to get the service health events from.
event_id - Organization event ID to retrieve.

Returns
Type	Description
string

setName

Output only. Identifier. Name of the event. Unique name of the event in this scope including organization ID and location using the form organizations/{organization_id}/locations/{location}/organizationEvents/{event_id}.

organization_id - see Getting your organization resource ID.
location - The location to get the service health events from.
event_id - Organization event ID to retrieve.

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

Output only. Represents the Google Cloud products and locations impacted by the event.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setEventImpacts

Output only. Represents the Google Cloud products and locations impacted by the event.

Parameter
Name	Description
var	array<EventImpact>

Returns
Type	Description
$this

getUpdates

Output only. Incident-only field. Event updates are correspondence from Google.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setUpdates

Output only. Incident-only field. 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 the update was posted.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the update was posted.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getStartTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEndTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getNextUpdateTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasNextUpdateTime

clearNextUpdateTime

setNextUpdateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this