Class OrganizationEvent (0.20.0)

public final class OrganizationEvent extends GeneratedMessageV3 implements OrganizationEventOrBuilder

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.

Protobuf type google.cloud.servicehealth.v1.OrganizationEvent

Static Fields

CATEGORY_FIELD_NUMBER

public static final int CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DETAILED_CATEGORY_FIELD_NUMBER

public static final int DETAILED_CATEGORY_FIELD_NUMBER
Field Value
Type Description
int

DETAILED_STATE_FIELD_NUMBER

public static final int DETAILED_STATE_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

EVENT_IMPACTS_FIELD_NUMBER

public static final int EVENT_IMPACTS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NEXT_UPDATE_TIME_FIELD_NUMBER

public static final int NEXT_UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

PARENT_EVENT_FIELD_NUMBER

public static final int PARENT_EVENT_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

UPDATES_FIELD_NUMBER

public static final int UPDATES_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OrganizationEvent getDefaultInstance()
Returns
Type Description
OrganizationEvent

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OrganizationEvent.Builder newBuilder()
Returns
Type Description
OrganizationEvent.Builder

newBuilder(OrganizationEvent prototype)

public static OrganizationEvent.Builder newBuilder(OrganizationEvent prototype)
Parameter
Name Description
prototype OrganizationEvent
Returns
Type Description
OrganizationEvent.Builder

parseDelimitedFrom(InputStream input)

public static OrganizationEvent parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OrganizationEvent parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OrganizationEvent parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OrganizationEvent parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OrganizationEvent parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OrganizationEvent parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OrganizationEvent parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OrganizationEvent
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OrganizationEvent> parser()
Returns
Type Description
Parser<OrganizationEvent>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCategory()

public OrganizationEvent.EventCategory getCategory()

Output only. The category of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.EventCategory category = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationEvent.EventCategory

The category.

getCategoryValue()

public int getCategoryValue()

Output only. The category of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.EventCategory category = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for category.

getDefaultInstanceForType()

public OrganizationEvent getDefaultInstanceForType()
Returns
Type Description
OrganizationEvent

getDescription()

public String getDescription()

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

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

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

string description = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for description.

getDetailedCategory()

public OrganizationEvent.DetailedCategory getDetailedCategory()

Output only. The detailed category of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.DetailedCategory detailed_category = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationEvent.DetailedCategory

The detailedCategory.

getDetailedCategoryValue()

public int getDetailedCategoryValue()

Output only. The detailed category of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.DetailedCategory detailed_category = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for detailedCategory.

getDetailedState()

public OrganizationEvent.DetailedState getDetailedState()

Output only. The current detailed state of the incident.

.google.cloud.servicehealth.v1.OrganizationEvent.DetailedState detailed_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationEvent.DetailedState

The detailedState.

getDetailedStateValue()

public int getDetailedStateValue()

Output only. The current detailed state of the incident.

.google.cloud.servicehealth.v1.OrganizationEvent.DetailedState detailed_state = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for detailedState.

getEndTime()

public Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getEventImpacts(int index)

public EventImpact getEventImpacts(int index)

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

repeated .google.cloud.servicehealth.v1.EventImpact event_impacts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EventImpact

getEventImpactsCount()

public int getEventImpactsCount()

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

repeated .google.cloud.servicehealth.v1.EventImpact event_impacts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getEventImpactsList()

public List<EventImpact> getEventImpactsList()

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

repeated .google.cloud.servicehealth.v1.EventImpact event_impacts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EventImpact>

getEventImpactsOrBuilder(int index)

public EventImpactOrBuilder getEventImpactsOrBuilder(int index)

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

repeated .google.cloud.servicehealth.v1.EventImpact event_impacts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EventImpactOrBuilder

getEventImpactsOrBuilderList()

public List<? extends EventImpactOrBuilder> getEventImpactsOrBuilderList()

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

repeated .google.cloud.servicehealth.v1.EventImpact event_impacts = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.servicehealth.v1.EventImpactOrBuilder>

getName()

public String 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.<br> location - The location to get the service health events from.<br> event_id - Organization event ID to retrieve.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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.<br> location - The location to get the service health events from.<br> event_id - Organization event ID to retrieve.

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getNextUpdateTime()

public Timestamp getNextUpdateTime()

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

.google.protobuf.Timestamp next_update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The nextUpdateTime.

getNextUpdateTimeOrBuilder()

public TimestampOrBuilder getNextUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp next_update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getParentEvent()

public String 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 parent_event = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The parentEvent.

getParentEventBytes()

public ByteString getParentEventBytes()

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 parent_event = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for parentEvent.

getParserForType()

public Parser<OrganizationEvent> getParserForType()
Returns
Type Description
Parser<OrganizationEvent>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

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

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

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

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getState()

public OrganizationEvent.State getState()

Output only. The current state of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
OrganizationEvent.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the event.

.google.cloud.servicehealth.v1.OrganizationEvent.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getTitle()

public String getTitle()

Output only. Brief description for the event.

string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Output only. Brief description for the event.

string title = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for title.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the update was posted.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the update was posted.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getUpdates(int index)

public EventUpdate getUpdates(int index)

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

repeated .google.cloud.servicehealth.v1.EventUpdate updates = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EventUpdate

getUpdatesCount()

public int getUpdatesCount()

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

repeated .google.cloud.servicehealth.v1.EventUpdate updates = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getUpdatesList()

public List<EventUpdate> getUpdatesList()

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

repeated .google.cloud.servicehealth.v1.EventUpdate updates = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<EventUpdate>

getUpdatesOrBuilder(int index)

public EventUpdateOrBuilder getUpdatesOrBuilder(int index)

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

repeated .google.cloud.servicehealth.v1.EventUpdate updates = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
EventUpdateOrBuilder

getUpdatesOrBuilderList()

public List<? extends EventUpdateOrBuilder> getUpdatesOrBuilderList()

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

repeated .google.cloud.servicehealth.v1.EventUpdate updates = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.servicehealth.v1.EventUpdateOrBuilder>

hasEndTime()

public boolean hasEndTime()

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

.google.protobuf.Timestamp end_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasNextUpdateTime()

public boolean hasNextUpdateTime()

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

.google.protobuf.Timestamp next_update_time = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the nextUpdateTime field is set.

hasStartTime()

public boolean hasStartTime()

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

.google.protobuf.Timestamp start_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the update was posted.

.google.protobuf.Timestamp update_time = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OrganizationEvent.Builder newBuilderForType()
Returns
Type Description
OrganizationEvent.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OrganizationEvent.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OrganizationEvent.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OrganizationEvent.Builder toBuilder()
Returns
Type Description
OrganizationEvent.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException