Service Health API v1 - Package cloud.google.com/go/servicehealth/apiv1/servicehealthpb (v1.7.0)

1.7.0 (latest) 1.6.0 1.5.0 1.4.0 1.3.0 1.2.4 1.1.3 1.0.5 0.1.4

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

ServiceHealth_ListEvents_FullMethodName, ServiceHealth_GetEvent_FullMethodName, ServiceHealth_ListOrganizationEvents_FullMethodName, ServiceHealth_GetOrganizationEvent_FullMethodName, ServiceHealth_ListOrganizationImpacts_FullMethodName, ServiceHealth_GetOrganizationImpact_FullMethodName

const (
	ServiceHealth_ListEvents_FullMethodName              = "/google.cloud.servicehealth.v1.ServiceHealth/ListEvents"
	ServiceHealth_GetEvent_FullMethodName                = "/google.cloud.servicehealth.v1.ServiceHealth/GetEvent"
	ServiceHealth_ListOrganizationEvents_FullMethodName  = "/google.cloud.servicehealth.v1.ServiceHealth/ListOrganizationEvents"
	ServiceHealth_GetOrganizationEvent_FullMethodName    = "/google.cloud.servicehealth.v1.ServiceHealth/GetOrganizationEvent"
	ServiceHealth_ListOrganizationImpacts_FullMethodName = "/google.cloud.servicehealth.v1.ServiceHealth/ListOrganizationImpacts"
	ServiceHealth_GetOrganizationImpact_FullMethodName   = "/google.cloud.servicehealth.v1.ServiceHealth/GetOrganizationImpact"
)

Variables

EventView_name, EventView_value

var (
	EventView_name = map[int32]string{
		0: "EVENT_VIEW_UNSPECIFIED",
		1: "EVENT_VIEW_BASIC",
		2: "EVENT_VIEW_FULL",
	}
	EventView_value = map[string]int32{
		"EVENT_VIEW_UNSPECIFIED": 0,
		"EVENT_VIEW_BASIC":       1,
		"EVENT_VIEW_FULL":        2,
	}
)

Enum value maps for EventView.

OrganizationEventView_name, OrganizationEventView_value

var (
	OrganizationEventView_name = map[int32]string{
		0: "ORGANIZATION_EVENT_VIEW_UNSPECIFIED",
		1: "ORGANIZATION_EVENT_VIEW_BASIC",
		2: "ORGANIZATION_EVENT_VIEW_FULL",
	}
	OrganizationEventView_value = map[string]int32{
		"ORGANIZATION_EVENT_VIEW_UNSPECIFIED": 0,
		"ORGANIZATION_EVENT_VIEW_BASIC":       1,
		"ORGANIZATION_EVENT_VIEW_FULL":        2,
	}
)

Enum value maps for OrganizationEventView.

Event_EventCategory_name, Event_EventCategory_value

var (
	Event_EventCategory_name = map[int32]string{
		0: "EVENT_CATEGORY_UNSPECIFIED",
		2: "INCIDENT",
	}
	Event_EventCategory_value = map[string]int32{
		"EVENT_CATEGORY_UNSPECIFIED": 0,
		"INCIDENT":                   2,
	}
)

Enum value maps for Event_EventCategory.

Event_DetailedCategory_name, Event_DetailedCategory_value

var (
	Event_DetailedCategory_name = map[int32]string{
		0: "DETAILED_CATEGORY_UNSPECIFIED",
		1: "CONFIRMED_INCIDENT",
		2: "EMERGING_INCIDENT",
	}
	Event_DetailedCategory_value = map[string]int32{
		"DETAILED_CATEGORY_UNSPECIFIED": 0,
		"CONFIRMED_INCIDENT":            1,
		"EMERGING_INCIDENT":             2,
	}
)

Enum value maps for Event_DetailedCategory.

Event_State_name, Event_State_value

var (
	Event_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
		2: "CLOSED",
	}
	Event_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
		"CLOSED":            2,
	}
)

Enum value maps for Event_State.

Event_DetailedState_name, Event_DetailedState_value

var (
	Event_DetailedState_name = map[int32]string{
		0:  "DETAILED_STATE_UNSPECIFIED",
		1:  "EMERGING",
		2:  "CONFIRMED",
		3:  "RESOLVED",
		4:  "MERGED",
		9:  "AUTO_CLOSED",
		10: "FALSE_POSITIVE",
	}
	Event_DetailedState_value = map[string]int32{
		"DETAILED_STATE_UNSPECIFIED": 0,
		"EMERGING":                   1,
		"CONFIRMED":                  2,
		"RESOLVED":                   3,
		"MERGED":                     4,
		"AUTO_CLOSED":                9,
		"FALSE_POSITIVE":             10,
	}
)

Enum value maps for Event_DetailedState.

Event_Relevance_name, Event_Relevance_value

var (
	Event_Relevance_name = map[int32]string{
		0: "RELEVANCE_UNSPECIFIED",
		2: "UNKNOWN",
		6: "NOT_IMPACTED",
		7: "PARTIALLY_RELATED",
		8: "RELATED",
		9: "IMPACTED",
	}
	Event_Relevance_value = map[string]int32{
		"RELEVANCE_UNSPECIFIED": 0,
		"UNKNOWN":               2,
		"NOT_IMPACTED":          6,
		"PARTIALLY_RELATED":     7,
		"RELATED":               8,
		"IMPACTED":              9,
	}
)

Enum value maps for Event_Relevance.

OrganizationEvent_EventCategory_name, OrganizationEvent_EventCategory_value

var (
	OrganizationEvent_EventCategory_name = map[int32]string{
		0: "EVENT_CATEGORY_UNSPECIFIED",
		2: "INCIDENT",
	}
	OrganizationEvent_EventCategory_value = map[string]int32{
		"EVENT_CATEGORY_UNSPECIFIED": 0,
		"INCIDENT":                   2,
	}
)

Enum value maps for OrganizationEvent_EventCategory.

OrganizationEvent_DetailedCategory_name, OrganizationEvent_DetailedCategory_value

var (
	OrganizationEvent_DetailedCategory_name = map[int32]string{
		0: "DETAILED_CATEGORY_UNSPECIFIED",
		1: "CONFIRMED_INCIDENT",
		2: "EMERGING_INCIDENT",
	}
	OrganizationEvent_DetailedCategory_value = map[string]int32{
		"DETAILED_CATEGORY_UNSPECIFIED": 0,
		"CONFIRMED_INCIDENT":            1,
		"EMERGING_INCIDENT":             2,
	}
)

Enum value maps for OrganizationEvent_DetailedCategory.

OrganizationEvent_State_name, OrganizationEvent_State_value

var (
	OrganizationEvent_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "ACTIVE",
		2: "CLOSED",
	}
	OrganizationEvent_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"ACTIVE":            1,
		"CLOSED":            2,
	}
)

Enum value maps for OrganizationEvent_State.

OrganizationEvent_DetailedState_name, OrganizationEvent_DetailedState_value

var (
	OrganizationEvent_DetailedState_name = map[int32]string{
		0:  "DETAILED_STATE_UNSPECIFIED",
		1:  "EMERGING",
		2:  "CONFIRMED",
		3:  "RESOLVED",
		4:  "MERGED",
		9:  "AUTO_CLOSED",
		10: "FALSE_POSITIVE",
	}
	OrganizationEvent_DetailedState_value = map[string]int32{
		"DETAILED_STATE_UNSPECIFIED": 0,
		"EMERGING":                   1,
		"CONFIRMED":                  2,
		"RESOLVED":                   3,
		"MERGED":                     4,
		"AUTO_CLOSED":                9,
		"FALSE_POSITIVE":             10,
	}
)

Enum value maps for OrganizationEvent_DetailedState.

File_google_cloud_servicehealth_v1_event_resources_proto

var File_google_cloud_servicehealth_v1_event_resources_proto protoreflect.FileDescriptor

File_google_cloud_servicehealth_v1_event_service_proto

var File_google_cloud_servicehealth_v1_event_service_proto protoreflect.FileDescriptor

ServiceHealth_ServiceDesc

var ServiceHealth_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.servicehealth.v1.ServiceHealth",
	HandlerType: (*ServiceHealthServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListEvents",
			Handler:    _ServiceHealth_ListEvents_Handler,
		},
		{
			MethodName: "GetEvent",
			Handler:    _ServiceHealth_GetEvent_Handler,
		},
		{
			MethodName: "ListOrganizationEvents",
			Handler:    _ServiceHealth_ListOrganizationEvents_Handler,
		},
		{
			MethodName: "GetOrganizationEvent",
			Handler:    _ServiceHealth_GetOrganizationEvent_Handler,
		},
		{
			MethodName: "ListOrganizationImpacts",
			Handler:    _ServiceHealth_ListOrganizationImpacts_Handler,
		},
		{
			MethodName: "GetOrganizationImpact",
			Handler:    _ServiceHealth_GetOrganizationImpact_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/servicehealth/v1/event_service.proto",
}

ServiceHealth_ServiceDesc is the grpc.ServiceDesc for ServiceHealth service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterServiceHealthServer

func RegisterServiceHealthServer(s grpc.ServiceRegistrar, srv ServiceHealthServer)

Asset

type Asset struct {

	// Output only. Full name of the resource as defined in
	// [Resource
	// Names](https://cloud.google.com/apis/design/resource_names#full_resource_name).
	AssetName string `protobuf:"bytes,1,opt,name=asset_name,json=assetName,proto3" json:"asset_name,omitempty"`
	// Output only. Type of the asset. Example:
	// `"cloudresourcemanager.googleapis.com/Project"`
	AssetType string `protobuf:"bytes,2,opt,name=asset_type,json=assetType,proto3" json:"asset_type,omitempty"`
	// contains filtered or unexported fields
}

Represents the asset impacted by the events.

func (*Asset) Descriptor

func (*Asset) Descriptor() ([]byte, []int)

Deprecated: Use Asset.ProtoReflect.Descriptor instead.

func (*Asset) GetAssetName

func (x *Asset) GetAssetName() string

func (*Asset) GetAssetType

func (x *Asset) GetAssetType() string

func (*Asset) ProtoMessage

func (*Asset) ProtoMessage()

func (*Asset) ProtoReflect

func (x *Asset) ProtoReflect() protoreflect.Message

func (*Asset) Reset

func (x *Asset) Reset()

func (*Asset) String

func (x *Asset) String() string

Event

type Event struct {

	// Output only. Identifier. Name of the event. Unique name of the event in
	// this scope including project and location using the form
	// `projects/{project_id}/locations/{location}/events/{event_id}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Brief description for the event.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. Free-form, human-readable description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The category of the event.
	Category Event_EventCategory `protobuf:"varint,4,opt,name=category,proto3,enum=google.cloud.servicehealth.v1.Event_EventCategory" json:"category,omitempty"`
	// Output only. The detailed category of the event.
	DetailedCategory Event_DetailedCategory `protobuf:"varint,21,opt,name=detailed_category,json=detailedCategory,proto3,enum=google.cloud.servicehealth.v1.Event_DetailedCategory" json:"detailed_category,omitempty"`
	// Output only. The current state of the event.
	State Event_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.servicehealth.v1.Event_State" json:"state,omitempty"`
	// Output only. The current detailed state of the incident.
	DetailedState Event_DetailedState `protobuf:"varint,19,opt,name=detailed_state,json=detailedState,proto3,enum=google.cloud.servicehealth.v1.Event_DetailedState" json:"detailed_state,omitempty"`
	// Google Cloud products and locations impacted by the event.
	EventImpacts []*EventImpact `protobuf:"bytes,20,rep,name=event_impacts,json=eventImpacts,proto3" json:"event_impacts,omitempty"`
	// Output only. Communicates why a given event is deemed relevant in the
	// context of a given project.
	Relevance Event_Relevance `protobuf:"varint,8,opt,name=relevance,proto3,enum=google.cloud.servicehealth.v1.Event_Relevance" json:"relevance,omitempty"`
	// Output only. Event updates are correspondence from Google.
	Updates []*EventUpdate `protobuf:"bytes,9,rep,name=updates,proto3" json:"updates,omitempty"`
	// 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.
	ParentEvent string `protobuf:"bytes,10,opt,name=parent_event,json=parentEvent,proto3" json:"parent_event,omitempty"`
	// Output only. The time when the event was last modified.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The start time of the event, if applicable.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The end time of the event, if applicable.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. The time when the next update can be expected.
	NextUpdateTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=next_update_time,json=nextUpdateTime,proto3" json:"next_update_time,omitempty"`
	// contains filtered or unexported fields
}

Represents service health events that may affect Google Cloud products. Event resource is a read-only view and does not allow any modifications. All fields are output only.

func (*Event) Descriptor

func (*Event) Descriptor() ([]byte, []int)

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetCategory

func (x *Event) GetCategory() Event_EventCategory

func (*Event) GetDescription

func (x *Event) GetDescription() string

func (*Event) GetDetailedCategory

func (x *Event) GetDetailedCategory() Event_DetailedCategory

func (*Event) GetDetailedState

func (x *Event) GetDetailedState() Event_DetailedState

func (*Event) GetEndTime

func (x *Event) GetEndTime() *timestamppb.Timestamp

func (*Event) GetEventImpacts

func (x *Event) GetEventImpacts() []*EventImpact

func (*Event) GetName

func (x *Event) GetName() string

func (*Event) GetNextUpdateTime

func (x *Event) GetNextUpdateTime() *timestamppb.Timestamp

func (*Event) GetParentEvent

func (x *Event) GetParentEvent() string

func (*Event) GetRelevance

func (x *Event) GetRelevance() Event_Relevance

func (*Event) GetStartTime

func (x *Event) GetStartTime() *timestamppb.Timestamp

func (*Event) GetState

func (x *Event) GetState() Event_State

func (*Event) GetTitle

func (x *Event) GetTitle() string

func (*Event) GetUpdateTime

func (x *Event) GetUpdateTime() *timestamppb.Timestamp

func (*Event) GetUpdates

func (x *Event) GetUpdates() []*EventUpdate

func (*Event) ProtoMessage

func (*Event) ProtoMessage()

func (*Event) ProtoReflect

func (x *Event) ProtoReflect() protoreflect.Message

func (*Event) Reset

func (x *Event) Reset()

func (*Event) String

func (x *Event) String() string

EventImpact

type EventImpact struct {

	// Google Cloud product impacted by the event.
	Product *Product `protobuf:"bytes,1,opt,name=product,proto3" json:"product,omitempty"`
	// Location impacted by the event.
	Location *Location `protobuf:"bytes,2,opt,name=location,proto3" json:"location,omitempty"`
	// contains filtered or unexported fields
}

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

func (*EventImpact) Descriptor

func (*EventImpact) Descriptor() ([]byte, []int)

Deprecated: Use EventImpact.ProtoReflect.Descriptor instead.

func (*EventImpact) GetLocation

func (x *EventImpact) GetLocation() *Location

func (*EventImpact) GetProduct

func (x *EventImpact) GetProduct() *Product

func (*EventImpact) ProtoMessage

func (*EventImpact) ProtoMessage()

func (*EventImpact) ProtoReflect

func (x *EventImpact) ProtoReflect() protoreflect.Message

func (*EventImpact) Reset

func (x *EventImpact) Reset()

func (*EventImpact) String

func (x *EventImpact) String() string

EventUpdate

type EventUpdate struct {

	// Output only. The time the update was posted.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Brief title for the event.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. Free-form, human-readable description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. Symptoms of the event, if available.
	Symptom string `protobuf:"bytes,4,opt,name=symptom,proto3" json:"symptom,omitempty"`
	// Output only. Workaround steps to remediate the event impact, if available.
	Workaround string `protobuf:"bytes,5,opt,name=workaround,proto3" json:"workaround,omitempty"`
	// contains filtered or unexported fields
}

Records an update made to the event.

func (*EventUpdate) Descriptor

func (*EventUpdate) Descriptor() ([]byte, []int)

Deprecated: Use EventUpdate.ProtoReflect.Descriptor instead.

func (*EventUpdate) GetDescription

func (x *EventUpdate) GetDescription() string

func (*EventUpdate) GetSymptom

func (x *EventUpdate) GetSymptom() string

func (*EventUpdate) GetTitle

func (x *EventUpdate) GetTitle() string

func (*EventUpdate) GetUpdateTime

func (x *EventUpdate) GetUpdateTime() *timestamppb.Timestamp

func (*EventUpdate) GetWorkaround

func (x *EventUpdate) GetWorkaround() string

func (*EventUpdate) ProtoMessage

func (*EventUpdate) ProtoMessage()

func (*EventUpdate) ProtoReflect

func (x *EventUpdate) ProtoReflect() protoreflect.Message

func (*EventUpdate) Reset

func (x *EventUpdate) Reset()

func (*EventUpdate) String

func (x *EventUpdate) String() string

EventView

type EventView int32

The event fields to include in ListEvents API response. This enum lists all possible event views.

EventView_EVENT_VIEW_UNSPECIFIED, EventView_EVENT_VIEW_BASIC, EventView_EVENT_VIEW_FULL

const (
	// Unspecified event view. Default to `EVENT_VIEW_BASIC`.
	EventView_EVENT_VIEW_UNSPECIFIED EventView = 0
	// Includes all fields except `updates`. This view is the default for
	// ListEvents API.
	EventView_EVENT_VIEW_BASIC EventView = 1
	// Includes all event fields.
	EventView_EVENT_VIEW_FULL EventView = 2
)

func (EventView) Descriptor

func (EventView) Descriptor() protoreflect.EnumDescriptor

func (EventView) Enum

func (x EventView) Enum() *EventView

func (EventView) EnumDescriptor

func (EventView) EnumDescriptor() ([]byte, []int)

Deprecated: Use EventView.Descriptor instead.

func (EventView) Number

func (x EventView) Number() protoreflect.EnumNumber

func (EventView) String

func (x EventView) String() string

func (EventView) Type

func (EventView) Type() protoreflect.EnumType

Event_DetailedCategory

type Event_DetailedCategory int32

The detailed category of an event. Contains all possible states for all event categories.

Event_DETAILED_CATEGORY_UNSPECIFIED, Event_CONFIRMED_INCIDENT, Event_EMERGING_INCIDENT

const (
	// Unspecified detailed category.
	Event_DETAILED_CATEGORY_UNSPECIFIED Event_DetailedCategory = 0
	// Indicates an event with category INCIDENT has a confirmed impact to at
	// least one Google Cloud product.
	Event_CONFIRMED_INCIDENT Event_DetailedCategory = 1
	// Indicates an event with category INCIDENT is under investigation to
	// determine if it has a confirmed impact on any Google Cloud products.
	Event_EMERGING_INCIDENT Event_DetailedCategory = 2
)

func (Event_DetailedCategory) Descriptor

func (Event_DetailedCategory) Descriptor() protoreflect.EnumDescriptor

func (Event_DetailedCategory) Enum

func (x Event_DetailedCategory) Enum() *Event_DetailedCategory

func (Event_DetailedCategory) EnumDescriptor

func (Event_DetailedCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_DetailedCategory.Descriptor instead.

func (Event_DetailedCategory) Number

func (x Event_DetailedCategory) Number() protoreflect.EnumNumber

func (Event_DetailedCategory) String

func (x Event_DetailedCategory) String() string

func (Event_DetailedCategory) Type

func (Event_DetailedCategory) Type() protoreflect.EnumType

Event_DetailedState

type Event_DetailedState int32

The detailed state of the incident. This enum lists all possible detailed states of an incident.

Event_DETAILED_STATE_UNSPECIFIED, Event_EMERGING, Event_CONFIRMED, Event_RESOLVED, Event_MERGED, Event_AUTO_CLOSED, Event_FALSE_POSITIVE

const (
	// Unspecified detail state.
	Event_DETAILED_STATE_UNSPECIFIED Event_DetailedState = 0
	// Google engineers are actively investigating the event to determine the
	// impact.
	Event_EMERGING Event_DetailedState = 1
	// The incident is confirmed and impacting at least one Google Cloud
	// product. Ongoing status updates will be provided until it is resolved.
	Event_CONFIRMED Event_DetailedState = 2
	// The incident is no longer affecting any Google Cloud product, and there
	// will be no further updates.
	Event_RESOLVED Event_DetailedState = 3
	// The incident was merged into a parent incident. All further updates will
	// be published to the parent only. The `parent_event` field contains the
	// name of the parent.
	Event_MERGED Event_DetailedState = 4
	// The incident was automatically closed because of the following reasons:
	//
	//   - The impact of the incident could not be confirmed.
	//
	//   - The incident was intermittent or resolved itself.
	//
	//     The incident does not have a resolution because no action or
	//     investigation happened. If it is intermittent, the incident may reopen.
	Event_AUTO_CLOSED Event_DetailedState = 9
	// Upon investigation, Google engineers concluded that the incident is not
	// affecting a Google Cloud product. This state can change if the incident
	// is reviewed again.
	Event_FALSE_POSITIVE Event_DetailedState = 10
)

func (Event_DetailedState) Descriptor

func (Event_DetailedState) Descriptor() protoreflect.EnumDescriptor

func (Event_DetailedState) Enum

func (x Event_DetailedState) Enum() *Event_DetailedState

func (Event_DetailedState) EnumDescriptor

func (Event_DetailedState) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_DetailedState.Descriptor instead.

func (Event_DetailedState) Number

func (x Event_DetailedState) Number() protoreflect.EnumNumber

func (Event_DetailedState) String

func (x Event_DetailedState) String() string

func (Event_DetailedState) Type

func (Event_DetailedState) Type() protoreflect.EnumType

Event_EventCategory

type Event_EventCategory int32

The category of the event. This enum lists all possible categories of event.

Event_EVENT_CATEGORY_UNSPECIFIED, Event_INCIDENT

const (
	// Unspecified category.
	Event_EVENT_CATEGORY_UNSPECIFIED Event_EventCategory = 0
	// Event category for service outage or degradation.
	Event_INCIDENT Event_EventCategory = 2
)

func (Event_EventCategory) Descriptor

func (Event_EventCategory) Descriptor() protoreflect.EnumDescriptor

func (Event_EventCategory) Enum

func (x Event_EventCategory) Enum() *Event_EventCategory

func (Event_EventCategory) EnumDescriptor

func (Event_EventCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_EventCategory.Descriptor instead.

func (Event_EventCategory) Number

func (x Event_EventCategory) Number() protoreflect.EnumNumber

func (Event_EventCategory) String

func (x Event_EventCategory) String() string

func (Event_EventCategory) Type

func (Event_EventCategory) Type() protoreflect.EnumType

Event_Relevance

type Event_Relevance int32

Communicates why a given incident is deemed relevant in the context of a given project. This enum lists all possible detailed states of relevance.

Event_RELEVANCE_UNSPECIFIED, Event_UNKNOWN, Event_NOT_IMPACTED, Event_PARTIALLY_RELATED, Event_RELATED, Event_IMPACTED

const (
	// Unspecified relevance.
	Event_RELEVANCE_UNSPECIFIED Event_Relevance = 0
	// The relevance of the incident to the project is unknown.
	Event_UNKNOWN Event_Relevance = 2
	// The incident does not impact the project.
	Event_NOT_IMPACTED Event_Relevance = 6
	// The incident is associated with a Google Cloud product your project uses,
	// but the incident may not be impacting your project. For example, the
	// incident may be impacting a Google Cloud product that your project uses,
	// but in a location that your project does not use.
	Event_PARTIALLY_RELATED Event_Relevance = 7
	// The incident has a direct connection with your project and impacts a
	// Google Cloud product in a location your project uses.
	Event_RELATED Event_Relevance = 8
	// The incident is verified to be impacting your project.
	Event_IMPACTED Event_Relevance = 9
)

func (Event_Relevance) Descriptor

func (Event_Relevance) Descriptor() protoreflect.EnumDescriptor

func (Event_Relevance) Enum

func (x Event_Relevance) Enum() *Event_Relevance

func (Event_Relevance) EnumDescriptor

func (Event_Relevance) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_Relevance.Descriptor instead.

func (Event_Relevance) Number

func (x Event_Relevance) Number() protoreflect.EnumNumber

func (Event_Relevance) String

func (x Event_Relevance) String() string

func (Event_Relevance) Type

func (Event_Relevance) Type() protoreflect.EnumType

Event_State

type Event_State int32

The state of the event. This enum lists all possible states of event.

Event_STATE_UNSPECIFIED, Event_ACTIVE, Event_CLOSED

const (
	// Unspecified state.
	Event_STATE_UNSPECIFIED Event_State = 0
	// Event is actively affecting a Google Cloud product and will continue to
	// receive updates.
	Event_ACTIVE Event_State = 1
	// Event is no longer affecting the Google Cloud product or has been merged
	// with another event.
	Event_CLOSED Event_State = 2
)

func (Event_State) Descriptor

func (Event_State) Descriptor() protoreflect.EnumDescriptor

func (Event_State) Enum

func (x Event_State) Enum() *Event_State

func (Event_State) EnumDescriptor

func (Event_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Event_State.Descriptor instead.

func (Event_State) Number

func (x Event_State) Number() protoreflect.EnumNumber

func (Event_State) String

func (x Event_State) String() string

func (Event_State) Type

func (Event_State) Type() protoreflect.EnumType

GetEventRequest

type GetEventRequest struct {

	// Required. Unique name of the event in this scope including project
	// and location using the form
	// `projects/{project_id}/locations/{location}/events/{event_id}`.
	//
	// `project_id` - Project ID of the project that contains the event. 

	// `location` - The location to get the service health events from. 

	// `event_id` - Event ID to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Gets information about a specific event.

func (*GetEventRequest) Descriptor

func (*GetEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetEventRequest.ProtoReflect.Descriptor instead.

func (*GetEventRequest) GetName

func (x *GetEventRequest) GetName() string

func (*GetEventRequest) ProtoMessage

func (*GetEventRequest) ProtoMessage()

func (*GetEventRequest) ProtoReflect

func (x *GetEventRequest) ProtoReflect() protoreflect.Message

func (*GetEventRequest) Reset

func (x *GetEventRequest) Reset()

func (*GetEventRequest) String

func (x *GetEventRequest) String() string

GetOrganizationEventRequest

type GetOrganizationEventRequest struct {

	// Required. Unique name of the event in this scope including organization and
	// event ID using the form
	// `organizations/{organization_id}/locations/locations/global/organizationEvents/{event_id}`.
	//
	// `organization_id` - ID (number) of the project that contains the event. To
	// get your `organization_id`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

	// `event_id` - Organization event ID to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Gets information about a specific event affecting an organization.

func (*GetOrganizationEventRequest) Descriptor

func (*GetOrganizationEventRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetOrganizationEventRequest.ProtoReflect.Descriptor instead.

func (*GetOrganizationEventRequest) GetName

func (x *GetOrganizationEventRequest) GetName() string

func (*GetOrganizationEventRequest) ProtoMessage

func (*GetOrganizationEventRequest) ProtoMessage()

func (*GetOrganizationEventRequest) ProtoReflect

func (x *GetOrganizationEventRequest) ProtoReflect() protoreflect.Message

func (*GetOrganizationEventRequest) Reset

func (x *GetOrganizationEventRequest) Reset()

func (*GetOrganizationEventRequest) String

func (x *GetOrganizationEventRequest) String() string

GetOrganizationImpactRequest

type GetOrganizationImpactRequest struct {

	// Required. Name of the resource using the form
	// `organizations/{organization_id}/locations/global/organizationImpacts/{organization_impact_id}`.
	//
	// `organization_id` - ID (number) of the organization that contains the
	// event. To get your `organization_id`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

	// `organization_impact_id` - ID of the [OrganizationImpact
	// resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Gets information about an event that affects a project under an organization.

func (*GetOrganizationImpactRequest) Descriptor

func (*GetOrganizationImpactRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetOrganizationImpactRequest.ProtoReflect.Descriptor instead.

func (*GetOrganizationImpactRequest) GetName

func (x *GetOrganizationImpactRequest) GetName() string

func (*GetOrganizationImpactRequest) ProtoMessage

func (*GetOrganizationImpactRequest) ProtoMessage()

func (*GetOrganizationImpactRequest) ProtoReflect

func (x *GetOrganizationImpactRequest) ProtoReflect() protoreflect.Message

func (*GetOrganizationImpactRequest) Reset

func (x *GetOrganizationImpactRequest) Reset()

func (*GetOrganizationImpactRequest) String

func (x *GetOrganizationImpactRequest) String() string

ListEventsRequest

type ListEventsRequest struct {

	// Required. Parent value using the form
	// `projects/{project_id}/locations/{location}/events`.
	//
	// `project_id` - ID of the project for which to list service health
	// events.
	// `location` - The location to get the service health events from.
	// To retrieve service health events of category = INCIDENT, use `location` =
	// `global`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of events that should be returned.  Acceptable
	// values are 1 to 100, inclusive. (The default value is 10.) If more results
	// are available, the service returns a next_page_token that you can use to
	// get the next page of results in subsequent list requests. The service may
	// return fewer events than the requested page_size.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	// Provide Page token returned by a previous `ListEvents` call to retrieve the
	// next page of results. When paginating, all other parameters provided to
	// `ListEvents` must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter expression that filters resources listed in the
	// response. The expression takes the following forms: 

	// *   field=value for `category` and `state`

	// *   field <, >, <=, or >= value for `update_time` 

	// Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`,
	// `event_impacts.product.product_name:"Eventarc"`
	// 

	//
	// Multiple filter queries are separated by spaces. Example:
	// `category=INCIDENT state=ACTIVE`.
	//
	// By default, each expression is an AND expression. However, you can include
	// AND and OR expressions explicitly.
	//
	// Filter is supported for the following fields: `category`, `state`,
	// `update_time`, `event_impacts.product.product_name`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Event fields to include in response.
	View EventView `protobuf:"varint,6,opt,name=view,proto3,enum=google.cloud.servicehealth.v1.EventView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Requests list of events.

func (*ListEventsRequest) Descriptor

func (*ListEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListEventsRequest.ProtoReflect.Descriptor instead.

func (*ListEventsRequest) GetFilter

func (x *ListEventsRequest) GetFilter() string

func (*ListEventsRequest) GetPageSize

func (x *ListEventsRequest) GetPageSize() int32

func (*ListEventsRequest) GetPageToken

func (x *ListEventsRequest) GetPageToken() string

func (*ListEventsRequest) GetParent

func (x *ListEventsRequest) GetParent() string

func (*ListEventsRequest) GetView

func (x *ListEventsRequest) GetView() EventView

func (*ListEventsRequest) ProtoMessage

func (*ListEventsRequest) ProtoMessage()

func (*ListEventsRequest) ProtoReflect

func (x *ListEventsRequest) ProtoReflect() protoreflect.Message

func (*ListEventsRequest) Reset

func (x *ListEventsRequest) Reset()

func (*ListEventsRequest) String

func (x *ListEventsRequest) String() string

ListEventsResponse

type ListEventsResponse struct {

	// Output only. List of events.
	Events []*Event `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	// Output only. The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request as page_token to retrieve
	// the next page.
	//
	// If this field is not present, there are no subsequent results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Output only. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response to request for listing events.

func (*ListEventsResponse) Descriptor

func (*ListEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListEventsResponse.ProtoReflect.Descriptor instead.

func (*ListEventsResponse) GetEvents

func (x *ListEventsResponse) GetEvents() []*Event

func (*ListEventsResponse) GetNextPageToken

func (x *ListEventsResponse) GetNextPageToken() string

func (*ListEventsResponse) GetUnreachable

func (x *ListEventsResponse) GetUnreachable() []string

func (*ListEventsResponse) ProtoMessage

func (*ListEventsResponse) ProtoMessage()

func (*ListEventsResponse) ProtoReflect

func (x *ListEventsResponse) ProtoReflect() protoreflect.Message

func (*ListEventsResponse) Reset

func (x *ListEventsResponse) Reset()

func (*ListEventsResponse) String

func (x *ListEventsResponse) String() string

ListOrganizationEventsRequest

type ListOrganizationEventsRequest struct {

	// Required. Parent value using the form
	// `organizations/{organization_id}/locations/{location}/organizationEvents`.
	//
	// `organization_id` - ID (number) of the project that contains the event. To
	// get your `organization_id`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

	// `location` - The location to get the service health events from. To
	// retrieve service health events of category = INCIDENT, use `location` =
	// `global`.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of events that should be returned.  Acceptable
	// values are `1` to `100`, inclusive. (The default value is `10`.) If more
	// results are available, the service returns a `next_page_token` that you can
	// use to get the next page of results in subsequent list requests. The
	// service may return fewer events than the requested `page_size`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	//
	// Provide Page token returned by a previous `ListOrganizationEvents` call to
	// retrieve the next page of results.
	//
	// When paginating, all other parameters provided to
	// `ListOrganizationEvents` must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter expression that filters resources listed in the
	// response. The expression takes the following forms:
	//
	// *   field=value for `category` and `state`
	// *   field <, >, <=, or >= value for `update_time`
	//
	// Examples: `category=INCIDENT`, `update_time>="2000-01-01T11:30:00-04:00"`
	//
	// Multiple filter queries are space-separated. Example:
	// `category=INCIDENT state=ACTIVE`.
	//
	// By default, each expression is an AND expression. However, you can include
	// AND and OR expressions explicitly.
	//
	// Filter is supported for the following fields: `category`, `state`,
	// `update_time`
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. OrganizationEvent fields to include in response.
	View OrganizationEventView `protobuf:"varint,6,opt,name=view,proto3,enum=google.cloud.servicehealth.v1.OrganizationEventView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Requests list of events that affect an organization.

func (*ListOrganizationEventsRequest) Descriptor

func (*ListOrganizationEventsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListOrganizationEventsRequest.ProtoReflect.Descriptor instead.

func (*ListOrganizationEventsRequest) GetFilter

func (x *ListOrganizationEventsRequest) GetFilter() string

func (*ListOrganizationEventsRequest) GetPageSize

func (x *ListOrganizationEventsRequest) GetPageSize() int32

func (*ListOrganizationEventsRequest) GetPageToken

func (x *ListOrganizationEventsRequest) GetPageToken() string

func (*ListOrganizationEventsRequest) GetParent

func (x *ListOrganizationEventsRequest) GetParent() string

func (*ListOrganizationEventsRequest) GetView

func (x *ListOrganizationEventsRequest) GetView() OrganizationEventView

func (*ListOrganizationEventsRequest) ProtoMessage

func (*ListOrganizationEventsRequest) ProtoMessage()

func (*ListOrganizationEventsRequest) ProtoReflect

func (x *ListOrganizationEventsRequest) ProtoReflect() protoreflect.Message

func (*ListOrganizationEventsRequest) Reset

func (x *ListOrganizationEventsRequest) Reset()

func (*ListOrganizationEventsRequest) String

func (x *ListOrganizationEventsRequest) String() string

ListOrganizationEventsResponse

type ListOrganizationEventsResponse struct {

	// Output only. List of organization events affecting an organization.
	OrganizationEvents []*OrganizationEvent `protobuf:"bytes,1,rep,name=organization_events,json=organizationEvents,proto3" json:"organization_events,omitempty"`
	// Output only. The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request as `page_token` to
	// retrieve the next page.
	//
	// If this field is not present, there are no subsequent results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Output only. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response to request for listing organization events.

func (*ListOrganizationEventsResponse) Descriptor

func (*ListOrganizationEventsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListOrganizationEventsResponse.ProtoReflect.Descriptor instead.

func (*ListOrganizationEventsResponse) GetNextPageToken

func (x *ListOrganizationEventsResponse) GetNextPageToken() string

func (*ListOrganizationEventsResponse) GetOrganizationEvents

func (x *ListOrganizationEventsResponse) GetOrganizationEvents() []*OrganizationEvent

func (*ListOrganizationEventsResponse) GetUnreachable

func (x *ListOrganizationEventsResponse) GetUnreachable() []string

func (*ListOrganizationEventsResponse) ProtoMessage

func (*ListOrganizationEventsResponse) ProtoMessage()

func (*ListOrganizationEventsResponse) ProtoReflect

func (x *ListOrganizationEventsResponse) ProtoReflect() protoreflect.Message

func (*ListOrganizationEventsResponse) Reset

func (x *ListOrganizationEventsResponse) Reset()

func (*ListOrganizationEventsResponse) String

func (x *ListOrganizationEventsResponse) String() string

ListOrganizationImpactsRequest

type ListOrganizationImpactsRequest struct {

	// Required. Parent value using the form
	// `organizations/{organization_id}/locations/{location}/organizationImpacts`.
	//
	// `organization_id` - ID (number) of the project that contains the event. To
	// get your `organization_id`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of events that should be returned. Acceptable
	// values are `1` to `100`, inclusive. The default value is `10`.
	//
	//	If more results are available, the service returns a
	//
	// `next_page_token` that can be used to get the next page of results in
	// subsequent list requests. The service may return fewer
	// [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
	// than the requested `page_size`.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	//
	// Provide `page_token` returned by a previous `ListOrganizationImpacts` call
	// to retrieve the next page of results.
	//
	// When paginating, all other parameters provided to `ListOrganizationImpacts`
	// must match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. A filter expression that filters resources listed in the
	// response. The expression is in the form of `field:value` for checking if a
	// repeated field contains a value.
	//
	// Example:
	// `events:organizations%2F{organization_id}%2Flocations%2Fglobal%2ForganizationEvents%2Fevent-id`
	//
	// To get your `{organization_id}`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).
	//
	// Multiple filter queries are separated by spaces.
	//
	// By default, each expression is an AND expression. However, you can include
	// AND and OR expressions explicitly.
	// Filter is supported for the following fields: `events`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Requests list of projects under an organization affected by an event.

func (*ListOrganizationImpactsRequest) Descriptor

func (*ListOrganizationImpactsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListOrganizationImpactsRequest.ProtoReflect.Descriptor instead.

func (*ListOrganizationImpactsRequest) GetFilter

func (x *ListOrganizationImpactsRequest) GetFilter() string

func (*ListOrganizationImpactsRequest) GetPageSize

func (x *ListOrganizationImpactsRequest) GetPageSize() int32

func (*ListOrganizationImpactsRequest) GetPageToken

func (x *ListOrganizationImpactsRequest) GetPageToken() string

func (*ListOrganizationImpactsRequest) GetParent

func (x *ListOrganizationImpactsRequest) GetParent() string

func (*ListOrganizationImpactsRequest) ProtoMessage

func (*ListOrganizationImpactsRequest) ProtoMessage()

func (*ListOrganizationImpactsRequest) ProtoReflect

func (x *ListOrganizationImpactsRequest) ProtoReflect() protoreflect.Message

func (*ListOrganizationImpactsRequest) Reset

func (x *ListOrganizationImpactsRequest) Reset()

func (*ListOrganizationImpactsRequest) String

func (x *ListOrganizationImpactsRequest) String() string

ListOrganizationImpactsResponse

type ListOrganizationImpactsResponse struct {

	// Output only. List of
	// [impacts](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact)
	// for an organization affected by service health events.
	OrganizationImpacts []*OrganizationImpact `protobuf:"bytes,1,rep,name=organization_impacts,json=organizationImpacts,proto3" json:"organization_impacts,omitempty"`
	// Output only. The continuation token, used to page through large result
	// sets. Provide this value in a subsequent request as `page_token` to
	// retrieve the next page.
	//
	// If this field is not present, there are no subsequent results.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Output only. Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Response to request for listing projects under an organization affected by an event.

func (*ListOrganizationImpactsResponse) Descriptor

func (*ListOrganizationImpactsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListOrganizationImpactsResponse.ProtoReflect.Descriptor instead.

func (*ListOrganizationImpactsResponse) GetNextPageToken

func (x *ListOrganizationImpactsResponse) GetNextPageToken() string

func (*ListOrganizationImpactsResponse) GetOrganizationImpacts

func (x *ListOrganizationImpactsResponse) GetOrganizationImpacts() []*OrganizationImpact

func (*ListOrganizationImpactsResponse) GetUnreachable

func (x *ListOrganizationImpactsResponse) GetUnreachable() []string

func (*ListOrganizationImpactsResponse) ProtoMessage

func (*ListOrganizationImpactsResponse) ProtoMessage()

func (*ListOrganizationImpactsResponse) ProtoReflect

func (x *ListOrganizationImpactsResponse) ProtoReflect() protoreflect.Message

func (*ListOrganizationImpactsResponse) Reset

func (x *ListOrganizationImpactsResponse) Reset()

func (*ListOrganizationImpactsResponse) String

func (x *ListOrganizationImpactsResponse) String() string

Location

type Location struct {

	// Location impacted by the event. Example: `"us-central1"`
	LocationName string `protobuf:"bytes,1,opt,name=location_name,json=locationName,proto3" json:"location_name,omitempty"`
	// contains filtered or unexported fields
}

Represents the locations impacted by the event.

func (*Location) Descriptor

func (*Location) Descriptor() ([]byte, []int)

Deprecated: Use Location.ProtoReflect.Descriptor instead.

func (*Location) GetLocationName

func (x *Location) GetLocationName() string

func (*Location) ProtoMessage

func (*Location) ProtoMessage()

func (*Location) ProtoReflect

func (x *Location) ProtoReflect() protoreflect.Message

func (*Location) Reset

func (x *Location) Reset()

func (*Location) String

func (x *Location) String() string

OrganizationEvent

type OrganizationEvent struct {

	// 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](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

	// `location` - The location to get the service health events from.

	// `event_id` - Organization event ID to retrieve.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. Brief description for the event.
	Title string `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"`
	// Output only. Free-form, human-readable description.
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The category of the event.
	Category OrganizationEvent_EventCategory `protobuf:"varint,4,opt,name=category,proto3,enum=google.cloud.servicehealth.v1.OrganizationEvent_EventCategory" json:"category,omitempty"`
	// Output only. The detailed category of the event.
	DetailedCategory OrganizationEvent_DetailedCategory `protobuf:"varint,17,opt,name=detailed_category,json=detailedCategory,proto3,enum=google.cloud.servicehealth.v1.OrganizationEvent_DetailedCategory" json:"detailed_category,omitempty"`
	// Output only. The current state of the event.
	State OrganizationEvent_State `protobuf:"varint,5,opt,name=state,proto3,enum=google.cloud.servicehealth.v1.OrganizationEvent_State" json:"state,omitempty"`
	// Output only. The current detailed state of the incident.
	DetailedState OrganizationEvent_DetailedState `protobuf:"varint,16,opt,name=detailed_state,json=detailedState,proto3,enum=google.cloud.servicehealth.v1.OrganizationEvent_DetailedState" json:"detailed_state,omitempty"`
	// Output only. Represents the Google Cloud products and locations impacted by
	// the event.
	EventImpacts []*EventImpact `protobuf:"bytes,15,rep,name=event_impacts,json=eventImpacts,proto3" json:"event_impacts,omitempty"`
	// Output only. Incident-only field. Event updates are correspondence from
	// Google.
	Updates []*EventUpdate `protobuf:"bytes,8,rep,name=updates,proto3" json:"updates,omitempty"`
	// 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.
	ParentEvent string `protobuf:"bytes,9,opt,name=parent_event,json=parentEvent,proto3" json:"parent_event,omitempty"`
	// Output only. The time the update was posted.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,11,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. The start time of the event, if applicable.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// Output only. The end time of the event, if applicable.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Incident-only field. The time when the next update can be
	// expected.
	NextUpdateTime *timestamppb.Timestamp `protobuf:"bytes,14,opt,name=next_update_time,json=nextUpdateTime,proto3" json:"next_update_time,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*OrganizationEvent) Descriptor

func (*OrganizationEvent) Descriptor() ([]byte, []int)

Deprecated: Use OrganizationEvent.ProtoReflect.Descriptor instead.

func (*OrganizationEvent) GetCategory

func (x *OrganizationEvent) GetCategory() OrganizationEvent_EventCategory

func (*OrganizationEvent) GetDescription

func (x *OrganizationEvent) GetDescription() string

func (*OrganizationEvent) GetDetailedCategory

func (x *OrganizationEvent) GetDetailedCategory() OrganizationEvent_DetailedCategory

func (*OrganizationEvent) GetDetailedState

func (x *OrganizationEvent) GetDetailedState() OrganizationEvent_DetailedState

func (*OrganizationEvent) GetEndTime

func (x *OrganizationEvent) GetEndTime() *timestamppb.Timestamp

func (*OrganizationEvent) GetEventImpacts

func (x *OrganizationEvent) GetEventImpacts() []*EventImpact

func (*OrganizationEvent) GetName

func (x *OrganizationEvent) GetName() string

func (*OrganizationEvent) GetNextUpdateTime

func (x *OrganizationEvent) GetNextUpdateTime() *timestamppb.Timestamp

func (*OrganizationEvent) GetParentEvent

func (x *OrganizationEvent) GetParentEvent() string

func (*OrganizationEvent) GetStartTime

func (x *OrganizationEvent) GetStartTime() *timestamppb.Timestamp

func (*OrganizationEvent) GetState

func (x *OrganizationEvent) GetState() OrganizationEvent_State

func (*OrganizationEvent) GetTitle

func (x *OrganizationEvent) GetTitle() string

func (*OrganizationEvent) GetUpdateTime

func (x *OrganizationEvent) GetUpdateTime() *timestamppb.Timestamp

func (*OrganizationEvent) GetUpdates

func (x *OrganizationEvent) GetUpdates() []*EventUpdate

func (*OrganizationEvent) ProtoMessage

func (*OrganizationEvent) ProtoMessage()

func (*OrganizationEvent) ProtoReflect

func (x *OrganizationEvent) ProtoReflect() protoreflect.Message

func (*OrganizationEvent) Reset

func (x *OrganizationEvent) Reset()

func (*OrganizationEvent) String

func (x *OrganizationEvent) String() string

OrganizationEventView

type OrganizationEventView int32

The organization event fields to include in ListOrganizationEvents API response. This enum lists all possible organization event views.

OrganizationEventView_ORGANIZATION_EVENT_VIEW_UNSPECIFIED, OrganizationEventView_ORGANIZATION_EVENT_VIEW_BASIC, OrganizationEventView_ORGANIZATION_EVENT_VIEW_FULL

const (
	// Unspecified event view. Default to `ORGANIZATION_EVENT_VIEW_BASIC`.
	OrganizationEventView_ORGANIZATION_EVENT_VIEW_UNSPECIFIED OrganizationEventView = 0
	// Includes all organization event fields except `updates`. This view is the
	// default for ListOrganizationEvents API.
	OrganizationEventView_ORGANIZATION_EVENT_VIEW_BASIC OrganizationEventView = 1
	// Includes all organization event fields.
	OrganizationEventView_ORGANIZATION_EVENT_VIEW_FULL OrganizationEventView = 2
)

func (OrganizationEventView) Descriptor

func (OrganizationEventView) Descriptor() protoreflect.EnumDescriptor

func (OrganizationEventView) Enum

func (x OrganizationEventView) Enum() *OrganizationEventView

func (OrganizationEventView) EnumDescriptor

func (OrganizationEventView) EnumDescriptor() ([]byte, []int)

Deprecated: Use OrganizationEventView.Descriptor instead.

func (OrganizationEventView) Number

func (x OrganizationEventView) Number() protoreflect.EnumNumber

func (OrganizationEventView) String

func (x OrganizationEventView) String() string

func (OrganizationEventView) Type

func (OrganizationEventView) Type() protoreflect.EnumType

OrganizationEvent_DetailedCategory

type OrganizationEvent_DetailedCategory int32

The detailed category of an event. Contains all possible states for all event categories.

OrganizationEvent_DETAILED_CATEGORY_UNSPECIFIED, OrganizationEvent_CONFIRMED_INCIDENT, OrganizationEvent_EMERGING_INCIDENT

const (
	// Unspecified detailed category.
	OrganizationEvent_DETAILED_CATEGORY_UNSPECIFIED OrganizationEvent_DetailedCategory = 0
	// Indicates an event with category INCIDENT has a confirmed impact to at
	// least one Google Cloud product.
	OrganizationEvent_CONFIRMED_INCIDENT OrganizationEvent_DetailedCategory = 1
	// Indicates an event with category INCIDENT is under investigation to
	// determine if it has a confirmed impact on any Google Cloud products.
	OrganizationEvent_EMERGING_INCIDENT OrganizationEvent_DetailedCategory = 2
)

func (OrganizationEvent_DetailedCategory) Descriptor

func (OrganizationEvent_DetailedCategory) Descriptor() protoreflect.EnumDescriptor

func (OrganizationEvent_DetailedCategory) Enum

func (x OrganizationEvent_DetailedCategory) Enum() *OrganizationEvent_DetailedCategory

func (OrganizationEvent_DetailedCategory) EnumDescriptor

func (OrganizationEvent_DetailedCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use OrganizationEvent_DetailedCategory.Descriptor instead.

func (OrganizationEvent_DetailedCategory) Number

func (x OrganizationEvent_DetailedCategory) Number() protoreflect.EnumNumber

func (OrganizationEvent_DetailedCategory) String

func (x OrganizationEvent_DetailedCategory) String() string

func (OrganizationEvent_DetailedCategory) Type

func (OrganizationEvent_DetailedCategory) Type() protoreflect.EnumType

OrganizationEvent_DetailedState

type OrganizationEvent_DetailedState int32

The detailed state of the incident. This enum lists all possible detailed states of an incident.

OrganizationEvent_DETAILED_STATE_UNSPECIFIED, OrganizationEvent_EMERGING, OrganizationEvent_CONFIRMED, OrganizationEvent_RESOLVED, OrganizationEvent_MERGED, OrganizationEvent_AUTO_CLOSED, OrganizationEvent_FALSE_POSITIVE

const (
	// Unspecified detail state.
	OrganizationEvent_DETAILED_STATE_UNSPECIFIED OrganizationEvent_DetailedState = 0
	// Google engineers are actively investigating the incident to determine the
	// impact.
	OrganizationEvent_EMERGING OrganizationEvent_DetailedState = 1
	// The incident is confirmed and impacting at least one Google Cloud
	// product. Ongoing status updates will be provided until it is resolved.
	OrganizationEvent_CONFIRMED OrganizationEvent_DetailedState = 2
	// The incident is no longer affecting any Google Cloud product, and there
	// will be no further updates.
	OrganizationEvent_RESOLVED OrganizationEvent_DetailedState = 3
	// The incident was merged into a parent event. All further updates will be
	// published to the parent only. The `parent_event` contains the name of the
	// parent.
	OrganizationEvent_MERGED OrganizationEvent_DetailedState = 4
	// The incident was automatically closed because of the following reasons:
	//
	//   - The impact of the incident could not be confirmed.
	//
	//   - The incident was intermittent or resolved itself.
	//
	//     The incident does not have a resolution because no action or
	//     investigation happened. If it is intermittent, the incident may reopen.
	OrganizationEvent_AUTO_CLOSED OrganizationEvent_DetailedState = 9
	// Upon investigation, Google engineers concluded that the incident is not
	// affecting a Google Cloud product. This state can change if the incident
	// is reviewed again.
	OrganizationEvent_FALSE_POSITIVE OrganizationEvent_DetailedState = 10
)

func (OrganizationEvent_DetailedState) Descriptor

func (OrganizationEvent_DetailedState) Descriptor() protoreflect.EnumDescriptor

func (OrganizationEvent_DetailedState) Enum

func (x OrganizationEvent_DetailedState) Enum() *OrganizationEvent_DetailedState

func (OrganizationEvent_DetailedState) EnumDescriptor

func (OrganizationEvent_DetailedState) EnumDescriptor() ([]byte, []int)

Deprecated: Use OrganizationEvent_DetailedState.Descriptor instead.

func (OrganizationEvent_DetailedState) Number

func (x OrganizationEvent_DetailedState) Number() protoreflect.EnumNumber

func (OrganizationEvent_DetailedState) String

func (x OrganizationEvent_DetailedState) String() string

func (OrganizationEvent_DetailedState) Type

func (OrganizationEvent_DetailedState) Type() protoreflect.EnumType

OrganizationEvent_EventCategory

type OrganizationEvent_EventCategory int32

The category of the event. This enum lists all possible categories of event.

OrganizationEvent_EVENT_CATEGORY_UNSPECIFIED, OrganizationEvent_INCIDENT

const (
	// Unspecified category.
	OrganizationEvent_EVENT_CATEGORY_UNSPECIFIED OrganizationEvent_EventCategory = 0
	// Event category for service outage or degradation.
	OrganizationEvent_INCIDENT OrganizationEvent_EventCategory = 2
)

func (OrganizationEvent_EventCategory) Descriptor

func (OrganizationEvent_EventCategory) Descriptor() protoreflect.EnumDescriptor

func (OrganizationEvent_EventCategory) Enum

func (x OrganizationEvent_EventCategory) Enum() *OrganizationEvent_EventCategory

func (OrganizationEvent_EventCategory) EnumDescriptor

func (OrganizationEvent_EventCategory) EnumDescriptor() ([]byte, []int)

Deprecated: Use OrganizationEvent_EventCategory.Descriptor instead.

func (OrganizationEvent_EventCategory) Number

func (x OrganizationEvent_EventCategory) Number() protoreflect.EnumNumber

func (OrganizationEvent_EventCategory) String

func (x OrganizationEvent_EventCategory) String() string

func (OrganizationEvent_EventCategory) Type

func (OrganizationEvent_EventCategory) Type() protoreflect.EnumType

OrganizationEvent_State

type OrganizationEvent_State int32

The state of the organization event. This enum lists all possible states of event.

OrganizationEvent_STATE_UNSPECIFIED, OrganizationEvent_ACTIVE, OrganizationEvent_CLOSED

const (
	// Unspecified state.
	OrganizationEvent_STATE_UNSPECIFIED OrganizationEvent_State = 0
	// Event is actively affecting a Google Cloud product and will continue to
	// receive updates.
	OrganizationEvent_ACTIVE OrganizationEvent_State = 1
	// Event is no longer affecting the Google Cloud product or has been merged
	// with another event.
	OrganizationEvent_CLOSED OrganizationEvent_State = 2
)

func (OrganizationEvent_State) Descriptor

func (OrganizationEvent_State) Descriptor() protoreflect.EnumDescriptor

func (OrganizationEvent_State) Enum

func (x OrganizationEvent_State) Enum() *OrganizationEvent_State

func (OrganizationEvent_State) EnumDescriptor

func (OrganizationEvent_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use OrganizationEvent_State.Descriptor instead.

func (OrganizationEvent_State) Number

func (x OrganizationEvent_State) Number() protoreflect.EnumNumber

func (OrganizationEvent_State) String

func (x OrganizationEvent_State) String() string

func (OrganizationEvent_State) Type

func (OrganizationEvent_State) Type() protoreflect.EnumType

OrganizationImpact

type OrganizationImpact struct {

	// Output only. Identifier. Unique name of the organization impact in this
	// scope including organization and location using the form
	// `organizations/{organization_id}/locations/{location}/organizationImpacts/{organization_impact_id}`.
	//
	// `organization_id` - ID (number) of the organization that contains the
	// event. To get your `organization_id`, see
	// [Getting your organization resource
	// ID](https://cloud.google.com/resource-manager/docs/creating-managing-organization#retrieving_your_organization_id).

	// `organization_impact_id` - ID of the [OrganizationImpact
	// resource](/service-health/docs/reference/rest/v1beta/organizations.locations.organizationImpacts#OrganizationImpact).
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. A list of event names impacting the asset.
	Events []string `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// Output only. Google Cloud asset possibly impacted by the specified events.
	Asset *Asset `protobuf:"bytes,3,opt,name=asset,proto3" json:"asset,omitempty"`
	// Output only. The time when the affected project was last modified.
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// contains filtered or unexported fields
}

Represents impact to assets at organizational level. It is a read-only view and does not allow any modifications.

func (*OrganizationImpact) Descriptor

func (*OrganizationImpact) Descriptor() ([]byte, []int)

Deprecated: Use OrganizationImpact.ProtoReflect.Descriptor instead.

func (*OrganizationImpact) GetAsset

func (x *OrganizationImpact) GetAsset() *Asset

func (*OrganizationImpact) GetEvents

func (x *OrganizationImpact) GetEvents() []string

func (*OrganizationImpact) GetName

func (x *OrganizationImpact) GetName() string

func (*OrganizationImpact) GetUpdateTime

func (x *OrganizationImpact) GetUpdateTime() *timestamppb.Timestamp

func (*OrganizationImpact) ProtoMessage

func (*OrganizationImpact) ProtoMessage()

func (*OrganizationImpact) ProtoReflect

func (x *OrganizationImpact) ProtoReflect() protoreflect.Message

func (*OrganizationImpact) Reset

func (x *OrganizationImpact) Reset()

func (*OrganizationImpact) String

func (x *OrganizationImpact) String() string

Product

type Product struct {

	// Google Cloud product impacted by the event. Example: `"Google Cloud SQL"`
	ProductName string `protobuf:"bytes,1,opt,name=product_name,json=productName,proto3" json:"product_name,omitempty"`
	// Unique identifier for the product.
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Represents the Google Cloud product impacted by the event.

func (*Product) Descriptor

func (*Product) Descriptor() ([]byte, []int)

Deprecated: Use Product.ProtoReflect.Descriptor instead.

func (*Product) GetId

func (x *Product) GetId() string

func (*Product) GetProductName

func (x *Product) GetProductName() string

func (*Product) ProtoMessage

func (*Product) ProtoMessage()

func (*Product) ProtoReflect

func (x *Product) ProtoReflect() protoreflect.Message

func (*Product) Reset

func (x *Product) Reset()

func (*Product) String

func (x *Product) String() string

ServiceHealthClient

type ServiceHealthClient interface {
	// Lists events under a given project and location.
	ListEvents(ctx context.Context, in *ListEventsRequest, opts ...grpc.CallOption) (*ListEventsResponse, error)
	// Retrieves a resource containing information about an event.
	GetEvent(ctx context.Context, in *GetEventRequest, opts ...grpc.CallOption) (*Event, error)
	// Lists organization events under a given organization and location.
	ListOrganizationEvents(ctx context.Context, in *ListOrganizationEventsRequest, opts ...grpc.CallOption) (*ListOrganizationEventsResponse, error)
	// Retrieves a resource containing information about an event affecting an
	// organization .
	GetOrganizationEvent(ctx context.Context, in *GetOrganizationEventRequest, opts ...grpc.CallOption) (*OrganizationEvent, error)
	// Lists assets impacted by organization events under a given organization and
	// location.
	ListOrganizationImpacts(ctx context.Context, in *ListOrganizationImpactsRequest, opts ...grpc.CallOption) (*ListOrganizationImpactsResponse, error)
	// Retrieves a resource containing information about impact to an asset under
	// an organization affected by a service health event.
	GetOrganizationImpact(ctx context.Context, in *GetOrganizationImpactRequest, opts ...grpc.CallOption) (*OrganizationImpact, error)
}

ServiceHealthClient is the client API for ServiceHealth service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewServiceHealthClient

func NewServiceHealthClient(cc grpc.ClientConnInterface) ServiceHealthClient

ServiceHealthServer

type ServiceHealthServer interface {
	// Lists events under a given project and location.
	ListEvents(context.Context, *ListEventsRequest) (*ListEventsResponse, error)
	// Retrieves a resource containing information about an event.
	GetEvent(context.Context, *GetEventRequest) (*Event, error)
	// Lists organization events under a given organization and location.
	ListOrganizationEvents(context.Context, *ListOrganizationEventsRequest) (*ListOrganizationEventsResponse, error)
	// Retrieves a resource containing information about an event affecting an
	// organization .
	GetOrganizationEvent(context.Context, *GetOrganizationEventRequest) (*OrganizationEvent, error)
	// Lists assets impacted by organization events under a given organization and
	// location.
	ListOrganizationImpacts(context.Context, *ListOrganizationImpactsRequest) (*ListOrganizationImpactsResponse, error)
	// Retrieves a resource containing information about impact to an asset under
	// an organization affected by a service health event.
	GetOrganizationImpact(context.Context, *GetOrganizationImpactRequest) (*OrganizationImpact, error)
}

ServiceHealthServer is the server API for ServiceHealth service. All implementations should embed UnimplementedServiceHealthServer for forward compatibility

UnimplementedServiceHealthServer

type UnimplementedServiceHealthServer struct {
}

UnimplementedServiceHealthServer should be embedded to have forward compatible implementations.

func (UnimplementedServiceHealthServer) GetEvent

func (UnimplementedServiceHealthServer) GetEvent(context.Context, *GetEventRequest) (*Event, error)

func (UnimplementedServiceHealthServer) GetOrganizationEvent

func (UnimplementedServiceHealthServer) GetOrganizationEvent(context.Context, *GetOrganizationEventRequest) (*OrganizationEvent, error)

func (UnimplementedServiceHealthServer) GetOrganizationImpact

func (UnimplementedServiceHealthServer) GetOrganizationImpact(context.Context, *GetOrganizationImpactRequest) (*OrganizationImpact, error)

func (UnimplementedServiceHealthServer) ListEvents

func (UnimplementedServiceHealthServer) ListEvents(context.Context, *ListEventsRequest) (*ListEventsResponse, error)

func (UnimplementedServiceHealthServer) ListOrganizationEvents

func (UnimplementedServiceHealthServer) ListOrganizationEvents(context.Context, *ListOrganizationEventsRequest) (*ListOrganizationEventsResponse, error)

func (UnimplementedServiceHealthServer) ListOrganizationImpacts

func (UnimplementedServiceHealthServer) ListOrganizationImpacts(context.Context, *ListOrganizationImpactsRequest) (*ListOrganizationImpactsResponse, error)

UnsafeServiceHealthServer

type UnsafeServiceHealthServer interface {
	// contains filtered or unexported methods
}

UnsafeServiceHealthServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ServiceHealthServer will result in compilation errors.