Represents an OrganizationEvent.
Package
@google-cloud/servicehealthConstructors
(constructor)(properties)
constructor(properties?: google.cloud.servicehealth.v1.IOrganizationEvent);Constructs a new OrganizationEvent.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrganizationEvent
Properties to set |
Properties
category
public category: (google.cloud.servicehealth.v1.OrganizationEvent.EventCategory|keyof typeof google.cloud.servicehealth.v1.OrganizationEvent.EventCategory);OrganizationEvent category.
description
public description: string;OrganizationEvent description.
detailedCategory
public detailedCategory: (google.cloud.servicehealth.v1.OrganizationEvent.DetailedCategory|keyof typeof google.cloud.servicehealth.v1.OrganizationEvent.DetailedCategory);OrganizationEvent detailedCategory.
detailedState
public detailedState: (google.cloud.servicehealth.v1.OrganizationEvent.DetailedState|keyof typeof google.cloud.servicehealth.v1.OrganizationEvent.DetailedState);OrganizationEvent detailedState.
endTime
public endTime?: (google.protobuf.ITimestamp|null);OrganizationEvent endTime.
eventImpacts
public eventImpacts: google.cloud.servicehealth.v1.IEventImpact[];OrganizationEvent eventImpacts.
name
public name: string;OrganizationEvent name.
nextUpdateTime
public nextUpdateTime?: (google.protobuf.ITimestamp|null);OrganizationEvent nextUpdateTime.
parentEvent
public parentEvent: string;OrganizationEvent parentEvent.
startTime
public startTime?: (google.protobuf.ITimestamp|null);OrganizationEvent startTime.
state
public state: (google.cloud.servicehealth.v1.OrganizationEvent.State|keyof typeof google.cloud.servicehealth.v1.OrganizationEvent.State);OrganizationEvent state.
title
public title: string;OrganizationEvent title.
updates
public updates: google.cloud.servicehealth.v1.IEventUpdate[];OrganizationEvent updates.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);OrganizationEvent updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.servicehealth.v1.IOrganizationEvent): google.cloud.servicehealth.v1.OrganizationEvent;Creates a new OrganizationEvent instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IOrganizationEvent
Properties to set |
| Returns | |
|---|---|
| Type | Description |
OrganizationEvent | OrganizationEvent instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.servicehealth.v1.OrganizationEvent;Decodes an OrganizationEvent message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
OrganizationEvent | OrganizationEvent |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.servicehealth.v1.OrganizationEvent;Decodes an OrganizationEvent message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
OrganizationEvent | OrganizationEvent |
encode(message, writer)
public static encode(message: google.cloud.servicehealth.v1.IOrganizationEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OrganizationEvent message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrganizationEvent
OrganizationEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.servicehealth.v1.IOrganizationEvent, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified OrganizationEvent message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IOrganizationEvent
OrganizationEvent message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.servicehealth.v1.OrganizationEvent;Creates an OrganizationEvent message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
OrganizationEvent | OrganizationEvent |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for OrganizationEvent
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this OrganizationEvent to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.servicehealth.v1.OrganizationEvent, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from an OrganizationEvent message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
OrganizationEvent
OrganizationEvent |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies an OrganizationEvent message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|