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 \ V1Methods
__construct
Constructor.
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
↳ start_time
↳ end_time
↳ 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.
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.
var
string
$this
getTitle
Output only. Brief description for the event.
string
setTitle
Output only. Brief description for the event.
var
string
$this
getDescription
Output only. Free-form, human-readable description.
string
setDescription
Output only. Free-form, human-readable description.
var
string
$this
getCategory
Output only. The category of the event.
int
setCategory
Output only. The category of the event.
var
int
$this
getDetailedCategory
Output only. The detailed category of the event.
int
setDetailedCategory
Output only. The detailed category of the event.
var
int
$this
getState
Output only. The current state of the event.
int
setState
Output only. The current state of the event.
var
int
$this
getDetailedState
Output only. The current detailed state of the incident.
int
setDetailedState
Output only. The current detailed state of the incident.
var
int
$this
getEventImpacts
Output only. Represents the Google Cloud products and locations impacted by the event.
setEventImpacts
Output only. Represents the Google Cloud products and locations impacted by the event.
$this
getUpdates
Output only. Incident-only field. Event updates are correspondence from Google.
setUpdates
Output only. Incident-only field. Event updates are correspondence from Google.
$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.
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.
var
string
$this
getUpdateTime
Output only. The time the update was posted.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The time the update was posted.
$this
getStartTime
Output only. The start time of the event, if applicable.
hasStartTime
clearStartTime
setStartTime
Output only. The start time of the event, if applicable.
$this
getEndTime
Output only. The end time of the event, if applicable.
hasEndTime
clearEndTime
setEndTime
Output only. The end time of the event, if applicable.
$this
getNextUpdateTime
Output only. Incident-only field. The time when the next update can be expected.
hasNextUpdateTime
clearNextUpdateTime
setNextUpdateTime
Output only. Incident-only field. The time when the next update can be expected.
$this
