Service Health V1 API - Class Google::Cloud::ServiceHealth::V1::OrganizationEvent (v1.0.2)

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#category

def category() -> ::Google::Cloud::ServiceHealth::V1::OrganizationEvent::EventCategory

Returns

(::Google::Cloud::ServiceHealth::V1::OrganizationEvent::EventCategory) — Output only. The category of the event.

#description

def description() -> ::String

Returns

(::String) — Output only. Free-form, human-readable description.

#detailed_category

def detailed_category() -> ::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedCategory

Returns

(::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedCategory) — Output only. The detailed category of the event.

#detailed_state

def detailed_state() -> ::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedState

Returns

(::Google::Cloud::ServiceHealth::V1::OrganizationEvent::DetailedState) — Output only. The current detailed state of the incident.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The end time of the event, if applicable.

#event_impacts

def event_impacts() -> ::Array<::Google::Cloud::ServiceHealth::V1::EventImpact>

Returns

(::Array<::Google::Cloud::ServiceHealth::V1::EventImpact>) — Output only. Represents the Google Cloud products and locations impacted by the event.

#name

def name() -> ::String

Returns

(::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.

#next_update_time

def next_update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Incident-only field. The time when the next update can be expected.

#parent_event

def parent_event() -> ::String

Returns

(::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.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The start time of the event, if applicable.

#state

def state() -> ::Google::Cloud::ServiceHealth::V1::OrganizationEvent::State

Returns

(::Google::Cloud::ServiceHealth::V1::OrganizationEvent::State) — Output only. The current state of the event.

#title

def title() -> ::String

Returns

(::String) — Output only. Brief description for the event.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The time the update was posted.

#updates

def updates() -> ::Array<::Google::Cloud::ServiceHealth::V1::EventUpdate>

Returns

(::Array<::Google::Cloud::ServiceHealth::V1::EventUpdate>) — Output only. Incident-only field. Event updates are correspondence from Google.