package google.cloud.irm.v1alpha2
Get desktop application:
View/edit binary Protocol Buffers messages
The Incident API for Incident Response & Management.
Creates a new incident.
message
incidents_service.proto:322Request for the CreateIncident method.
optional incident = 1
The incident to create.
string parent = 2
The resource name of the hosting Stackdriver project which the incident belongs to. The name is of the form `projects/{project_id_or_number}` .
Returns an incident by name.
message
incidents_service.proto:334Request for the GetIncident method.
string name = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
Returns a list of incidents. Incidents are ordered by start time, with the most recent incidents first.
message
incidents_service.proto:573Request for the SearchIncidents method.
string parent = 1
The resource name of the hosting Stackdriver project which requested incidents belong to.
string query = 2
An expression that defines which incidents to return. Search atoms can be used to match certain specific fields. Otherwise, plain text will match text fields in the incident. Search atoms: * `start` - (timestamp) The time the incident started. * `stage` - The stage of the incident, one of detected, triaged, mitigated, resolved, documented, or duplicate (which correspond to values in the Incident.Stage enum). These are ordered, so `stage<resolved` is equivalent to `stage:detected OR stage:triaged OR stage:mitigated`. * `severity` - (Incident.Severity) The severity of the incident. + Supports matching on a specific severity (for example, `severity:major`) or on a range (for example, `severity>medium`, `severity<=minor`, etc.). Timestamp formats: * yyyy-MM-dd - an absolute date, treated as a calendar-day-wide window. In other words, the "<" operator will match dates before that date, the ">" operator will match dates after that date, and the ":" or "=" operators will match the entire day. * Nd (for example, 7d) - a relative number of days ago, treated as a moment in time (as opposed to a day-wide span). A multiple of 24 hours ago (as opposed to calendar days). In the case of daylight savings time, it will apply the current timezone to both ends of the range. Note that exact matching (for example, `start:7d`) is unlikely to be useful because that would only match incidents created precisely at a particular instant in time. Examples: * `foo` - matches incidents containing the word "foo" * `"foo bar"` - matches incidents containing the phrase "foo bar" * `foo bar` or `foo AND bar` - matches incidents containing the words "foo" and "bar" * `foo -bar` or `foo AND NOT bar` - matches incidents containing the word "foo" but not the word "bar" * `foo OR bar` - matches incidents containing the word "foo" or the word "bar" * `start>2018-11-28` - matches incidents which started after November 11, 2018. * `start<=2018-11-28` - matches incidents which started on or before November 11, 2018. * `start:2018-11-28` - matches incidents which started on November 11, 2018. * `start>7d` - matches incidents which started after the point in time 7*24 hours ago * `start>180d` - similar to 7d, but likely to cross the daylight savings time boundary, so the end time will be 1 hour different from "now." * `foo AND start>90d AND stage<resolved` - unresolved incidents from the past 90 days containing the word "foo"
int32 page_size = 3
Number of incidents to return.
string page_token = 4
Page token from an earlier query, as returned in `next_page_token`.
string time_zone = 5
The time zone name. It should be an IANA TZ name, such as "America/Los_Angeles". For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. If no time zone is specified, the default is UTC.
message
incidents_service.proto:645Response for the SearchIncidents method.
repeated incidents = 1
Incidents.
string next_page_token = 2
Page token to fetch the next set of incidents.
Updates an existing incident.
message
incidents_service.proto:341Request for the UpdateIncident method.
optional incident = 1
The incident to update with the new values.
optional update_mask = 2
List of fields that should be updated.
Returns a list of incidents that are "similar" to the specified incident or signal. This functionality is provided on a best-effort basis and the definition of "similar" is subject to change.
message
incidents_service.proto:350Request for the SearchSimilarIncidents method.
string name = 1
Resource name of the incident or signal, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of similar incidents to return.
string page_token = 3
Page token from an earlier query, as returned in 'next_page_token'.
message
incidents_service.proto:363Response for the SearchSimilarIncidents method.
repeated results = 1
The search results, ordered by descending relevance.
string next_page_token = 2
Page token to fetch the next set of similar incidents.
Creates an annotation on an existing incident. Only 'text/plain' and 'text/markdown' annotations can be created via this method.
message
incidents_service.proto:380Request for the CreateAnnotation method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
optional annotation = 2
Only annotation.content is an input argument.
Lists annotations that are part of an incident. No assumptions should be made on the content-type of the annotation returned.
message
incidents_service.proto:390Request for the ListAnnotations method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of annotations to return.
string page_token = 3
Page token from an earlier query, as returned in `next_page_token`.
message
incidents_service.proto:403Response for the ListAnnotations method.
repeated annotations = 1
List of annotations.
string next_page_token = 2
Page token to fetch the next set of annotations.
rpc CreateTag (, )
incidents_service.proto:102Creates a tag on an existing incident.
message
incidents_service.proto:412Request for the CreateTag method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
optional tag = 2
Tag to create. Only tag.display_name is an input argument.
rpc DeleteTag (, )
incidents_service.proto:110Deletes an existing tag.
message
incidents_service.proto:422Request for the DeleteTag method.
string name = 1
Resource name of the tag.
rpc ListTags (, )
incidents_service.proto:117Lists tags that are part of an incident.
message
incidents_service.proto:428Request for the ListTagsForIncident method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of tags to return.
string page_token = 3
Page token from an earlier query, as returned in `next_page_token`.
message
incidents_service.proto:441Response for the ListTagsForIncident method.
repeated tags = 1
Tags.
string next_page_token = 2
Page token to fetch the next set of tags.
Creates a new signal.
message
incidents_service.proto:450Request for the CreateSignal method.
string parent = 1
The resource name of the hosting Stackdriver project which requested signal belongs to.
optional signal = 2
The signal to create.
Lists signals that are part of an incident. Signals are returned in reverse chronological order.
message
incidents_service.proto:460Request for the SearchSignals method.
string parent = 1
The resource name of the hosting Stackdriver project which requested incidents belong to.
string query = 2
An expression that defines which signals to return. Search atoms can be used to match certain specific fields. Otherwise, plain text will match text fields in the signal. Search atoms: * `start` - (timestamp) The time the signal was created. * `title` - The title of the signal. * `signal_state` - `open` or `closed`. State of the signal. (e.g., `signal_state:open`) Timestamp formats: * yyyy-MM-dd - an absolute date, treated as a calendar-day-wide window. In other words, the "<" operator will match dates before that date, the ">" operator will match dates after that date, and the ":" operator will match the entire day. * yyyy-MM-ddTHH:mm - Same as above, but with minute resolution. * yyyy-MM-ddTHH:mm:ss - Same as above, but with second resolution. * Nd (e.g. 7d) - a relative number of days ago, treated as a moment in time (as opposed to a day-wide span) a multiple of 24 hours ago (as opposed to calendar days). In the case of daylight savings time, it will apply the current timezone to both ends of the range. Note that exact matching (e.g. `start:7d`) is unlikely to be useful because that would only match signals created precisely at a particular instant in time. The absolute timestamp formats (everything starting with a year) can optionally be followed with a UTC offset in +/-hh:mm format. Also, the 'T' separating dates and times can optionally be replaced with a space. Note that any timestamp containing a space or colon will need to be quoted. Examples: * `foo` - matches signals containing the word "foo" * `"foo bar"` - matches signals containing the phrase "foo bar" * `foo bar` or `foo AND bar` - matches signals containing the words "foo" and "bar" * `foo -bar` or `foo AND NOT bar` - matches signals containing the word "foo" but not the word "bar" * `foo OR bar` - matches signals containing the word "foo" or the word "bar" * `start>2018-11-28` - matches signals which started after November 11, 2018. * `start<=2018-11-28` - matches signals which started on or before November 11, 2018. * `start:2018-11-28` - matches signals which started on November 11, 2018. * `start>"2018-11-28 01:02:03+04:00"` - matches signals which started after November 11, 2018 at 1:02:03 AM according to the UTC+04 time zone. * `start>7d` - matches signals which started after the point in time 7*24 hours ago * `start>180d` - similar to 7d, but likely to cross the daylight savings time boundary, so the end time will be 1 hour different from "now." * `foo AND start>90d AND stage<resolved` - unresolved signals from the past 90 days containing the word "foo"
int32 page_size = 3
Maximum number of `signals` to return in the response.
string page_token = 4
Page token from an earlier query, as returned in `next_page_token`. All field values except for page_size and page_token should be the same as the original query (may return an error or unexpected data otherwise).
message
incidents_service.proto:535Response for the SearchSignals method.
repeated signals = 1
Signals that matched the query in the request.
string next_page_token = 2
Page token to fetch the next set of signals.
Finds a signal by other unique IDs.
message
incidents_service.proto:551Request for the LookupSignal method.
oneof alternate_id
Required. The ID to use for lookup.
string cscc_finding = 2
Full resource name of the CSCC finding id this signal refers to (e.g. "organizations/abc/sources/123/findings/xyz")
string stackdriver_notification_id = 3
The ID from the Stackdriver Alerting notification.
rpc GetSignal (, )
incidents_service.proto:147Returns a signal by name.
message
incidents_service.proto:544Request for the GetSignal method.
string name = 1
Resource name of the Signal resource, for example, "projects/{project_id}/signals/{signal_id}".
Updates an existing signal (for example, to assign/unassign it to an incident).
message
incidents_service.proto:564Request for the UpdateSignal method.
optional signal = 1
The signal to update with the new values.
optional update_mask = 2
List of fields that should be updated.
Escalates an incident.
message
incidents_service.proto:654Request to escalate an incident.
optional incident = 1
The incident to escalate with the new values.
optional update_mask = 2
List of fields that should be updated.
repeated subscriptions = 3
Subscriptions to add or update. Existing subscriptions with the same channel and address as a subscription in the list will be updated.
repeated tags = 4
Tags to add. Tags identical to existing tags will be ignored.
repeated roles = 5
Roles to add or update. Existing roles with the same type (and title, for TYPE_OTHER roles) will be updated.
repeated artifacts = 6
Artifacts to add. All artifacts are added without checking for duplicates.
message
incidents_service.proto:677Response for EscalateIncident.
optional incident = 1
The escalated incident.
repeated subscriptions = 2
New or modified subscriptions.
repeated tags = 3
New or modified tags.
repeated roles = 4
New or modified roles.
repeated artifacts = 5
New or modified artifacts.
Creates a new artifact.
message
incidents_service.proto:695Request for the CreateArtifact method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
optional artifact = 2
The artifact to create.
Returns a list of artifacts for an incident.
message
incidents_service.proto:705Request for the ListArtifacts method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of artifacts to return.
string page_token = 3
Page token from an earlier query, as returned in `next_page_token`.
message
incidents_service.proto:718Response for the ListArtifacts method.
repeated artifacts = 1
List of artifacts.
string next_page_token = 2
Page token to fetch the next set of artifacts.
Updates an existing artifact.
message
incidents_service.proto:727Request for the UpdateArtifact method.
optional artifact = 1
The artifact to update with the new values.
optional update_mask = 2
List of fields that should be updated.
Deletes an existing artifact.
message
incidents_service.proto:736Request for deleting an artifact.
string name = 1
Resource name of the artifact.
Sends a summary of the shift for oncall handoff.
message
incidents_service.proto:742SendShiftHandoff and PreviewShiftHandoff RPC request.
string parent = 1
The resource name of the Stackdriver project that the handoff is being sent from. for example, `projects/{project_id}`
repeated string recipients = 2
Email addresses of the recipients of the handoff, for example, "user@example.com". Must contain at least one entry.
repeated string cc = 3
Email addresses that should be CC'd on the handoff. Optional.
string subject = 4
The subject of the email. Required.
string notes_content_type = 5
Content type string, for example, 'text/plain' or 'text/html'.
string notes_content = 6
Additional notes to be included in the handoff. Optional.
repeated incidents = 7
The set of incidents that should be included in the handoff. Optional.
bool preview_only = 8
If set to true a ShiftHandoffResponse will be returned but the handoff will not actually be sent.
message
incidents_service.proto:781SendShiftHandoff and PreviewShiftHandoff RPC response.
string content_type = 1
Content type string, for example, 'text/plain' or 'text/html'.
string content = 2
The contents of the handoff that was sent or would have been sent (if the request was preview_only). This will typically contain a full HTML document.
Creates a new subscription. This will fail if: a. there are too many (50) subscriptions in the incident already b. a subscription using the given channel already exists
message
incidents_service.proto:792Request for the CreateSubscription method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
optional subscription = 2
The subscription to create.
Updates a subscription.
message
incidents_service.proto:802Request for the UpdateSubscription method.
optional subscription = 1
The subscription to update, with new values.
optional update_mask = 2
List of fields that should be updated.
Returns a list of subscriptions for an incident.
message
incidents_service.proto:811Request for the ListSubscriptions method.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of subscriptions to return.
string page_token = 3
Page token from an earlier query, as returned in `next_page_token`.
message
incidents_service.proto:824Response for the ListSubscriptions method.
repeated subscriptions = 1
List of subscriptions.
string next_page_token = 2
Page token to fetch the next set of subscriptions.
Deletes an existing subscription.
message
incidents_service.proto:833Request for deleting a subscription.
string name = 1
Resource name of the subscription.
Creates a role assignment on an existing incident. Normally, the user field will be set when assigning a role to oneself, and the next field will be set when proposing another user as the assignee. Setting the next field directly to a user other than oneself is equivalent to proposing and force-assigning the role to the user.
message
incidents_service.proto:839Request for creating a role assignment.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
optional incident_role_assignment = 2
Role assignment to create.
Deletes an existing role assignment.
message
incidents_service.proto:849Request for deleting a role assignment.
string name = 1
Resource name of the role assignment.
Lists role assignments that are part of an incident.
message
incidents_service.proto:855Request to list role assignments of an incident.
string parent = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
int32 page_size = 2
Number of assignments to return.
string page_token = 3
Page token from an earlier query, as returned in `next_page_token`.
message
incidents_service.proto:868Response for the ListIncidentRoleAssignments method.
repeated incident_role_assignments = 1
List of assignments.
string next_page_token = 2
Page token to fetch the next set of assignments.
Starts a role handover. The proposed assignee will receive an email notifying them of the assignment. This will fail if a role handover is already pending.
message
incidents_service.proto:877Request to start a role handover.
string name = 1
Resource name of the role assignment.
optional new_assignee = 2
The proposed assignee.
Confirms a role handover. This will fail if the 'proposed_assignee' field of the IncidentRoleAssignment is not equal to the 'new_assignee' field of the request. If the caller is not the new_assignee, ForceIncidentRoleHandover should be used instead.
message
incidents_service.proto:886Request to confirm a role handover.
string name = 1
Resource name of the role assignment.
optional new_assignee = 2
The proposed assignee, who will now be the assignee. This should be the current user; otherwise ForceRoleHandover should be called.
Forces a role handover. This will fail if the 'proposed_assignee' field of the IncidentRoleAssignment is not equal to the 'new_assignee' field of the request. If the caller is the new_assignee, ConfirmIncidentRoleHandover should be used instead.
message
incidents_service.proto:896Request to force a role handover.
string name = 1
Resource name of the role assignment.
optional new_assignee = 2
The proposed assignee, who will now be the assignee. This should not be the current user; otherwise ConfirmRoleHandover should be called.
Cancels a role handover. This will fail if the 'proposed_assignee' field of the IncidentRoleAssignment is not equal to the 'new_assignee' field of the request.
message
incidents_service.proto:906Request to cancel a role handover.
string name = 1
Resource name of the role assignment.
optional new_assignee = 2
Person who was proposed as the next assignee (i.e. IncidentRoleAssignment.proposed_assignee) and whose proposal is being cancelled.
message
incidents.proto:125A text annotation by a user.
Used as response type in: IncidentService.CreateAnnotation
Used as field type in: ,
string name = 1
Resource name of the annotation, for example, "projects/{project_id}/incidents/{incident_id}/annotations/{annotation_id}".
optional author = 2
Output only. Author of the annotation.
optional create_time = 3
Output only. Time the annotation was created.
string content = 4
Content of the annotation. Immutable.
string content_type = 5
Content type of the annotation, for example, 'text/plain' or 'text/markdown'. Immutable.
message
incidents.proto:392External artifact associated to an incident.
Used as response type in: IncidentService.CreateArtifact, IncidentService.UpdateArtifact
Used as field type in: , , , ,
string name = 1
Output only. Resource name such as "projects/{project_id}/incidents/{incident_id}/artifacts/{artifact_id}".
string display_name = 2
User provided name of an artifact.
string etag = 3
Output only. Etag for this version of the resource. Must be specified in update requests and match the current version in storage. Must not be modified by the client.
string url = 4
URL to access the artifact.
Artifact.Type type = 5
Type of this artifact.
Possible types of an artifact.
Used in:
TYPE_UNSPECIFIED = 0
External type is unspecified.
TYPE_URL = 1
URL.
TYPE_JIRA_ISSUE = 4
A JIRA issue.
message
incidents.proto:426Communication Channels are mechanisms used to receive notifications about changes to incidents.
Used in:
oneof endpoint
An endpoint describes how messages will be delivered.
email = 1
Messages will be delivered via email.
notification_channel = 2
Messages will be delivered via a Stackdriver notification channel.
message
incidents.proto:428A communication channel that delivers messages to an email address.
Used in:
string address = 1
The email address, for example, "user@example.com".
message
incidents.proto:435A communication channel that delivers messages to a Stackdriver notification channel.
Used in:
string name = 1
Stackdriver notification channel name.
message
incidents.proto:172Representation of an incident.
Used as response type in: IncidentService.CreateIncident, IncidentService.GetIncident, IncidentService.UpdateIncident
Used as field type in: , , , , ,
string name = 1
Output only. Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
string title = 2
One-line summary of the incident.
Incident.EscalationLevel escalation_level = 3
Escalation level of the incident.
string etag = 4
Etag to validate the object is unchanged for a read-modify-write operation. An empty etag will overwrite other changes.
Incident.Severity severity = 5
Severity of the incident.
Incident.Stage stage = 6
Stage of the incident.
string duplicate_incident = 9
Resource name of the incident this incident is a duplicate of. Empty if this incident is not a duplicate. An incident can only be a duplicate of an incident that is not marked as a duplicate already. Setting this to a non-empty value must also set the stage to `STAGE_DUPLICATE`. Unsetting this value value must also update `stage` to a value other than `STAGE_DUPLICATE`.
optional start_time = 7
Output only. Time this incident started. Used to measure the 'elapsed time'. Start time of an incident is the earliest creation time of any of its Signals or the create time of the incident if no Signals are assigned.
optional synopsis = 8
Output only. Synopsis of this incident.
optional communication_venue = 10
Location of communications for this incident. This is informational only; IRM does not use this to send messages.
message
incidents.proto:175CommunicationVenue is a record of where conversations about an incident are happening.
Used in:
string uri = 1
A URI to the web interface of the channel.
string display_name = 2
A name representing the channel in IRM UI.
CommunicationVenue.ChannelType channel_type = 3
The type of channel/venue for incident communications.
The type of channel/venue for incident communications.
Used in:
CHANNEL_TYPE_UNSPECIFIED = 0
An unspecified communication channel.
CHANNEL_TYPE_URI = 1
A communication channel that is represented by a generic URI.
CHANNEL_TYPE_SLACK = 5
A communication channel that represents a Slack channel.
Specifies the escalation level of this incident, within the IRM protocol for handling incidents.
Used in:
ESCALATION_LEVEL_UNSPECIFIED = 0
The incident has not been escalated. This is the value used by all new and legacy incidents.
ESCALATION_LEVEL_ORGANIZATION = 1
The incident has been escalated to the organizational level.
Severity of an incident.
Used in:
SEVERITY_UNSPECIFIED = 0
Severity is not specified.
SEVERITY_HUGE = 1
Huge incident.
SEVERITY_MAJOR = 2
Major incident.
SEVERITY_MEDIUM = 3
Medium incident.
SEVERITY_MINOR = 4
Minor incident.
SEVERITY_NEGLIGIBLE = 5
Negligible incident.
Stage of an incident.
Used in:
STAGE_UNSPECIFIED = 0
This is the default value if no stage has been specified. Note: The caller of the API should set the stage to DETECTED.
STAGE_DETECTED = 4
The incident has been detected. This is the initial stage of a new incident. Note: The caller still has to set the stage manually.
STAGE_TRIAGED = 1
This incident has been formally characterized.
STAGE_MITIGATED = 2
This incident has been mitigated, i.e. does not affect the service level anymore.
STAGE_RESOLVED = 3
This incident has been fully resolved, i.e. there are no immediate follow-up tasks.
STAGE_DOCUMENTED = 5
Postmortem for the incident was written.
STAGE_DUPLICATE = 6
Stage for an incident with `duplicate_incident`. This incident is not authoritative anymore and the `duplicate_incident` should be used to determine the stage.
message
incidents.proto:303Describes a role that can be assigned to an incident.
Used in: ,
IncidentRole.Type type = 1
The type of role. The role type is immutable in role assignments. Each role type can only be used once per incident, except for TYPE_OTHER.
string title = 2
Output only unless TYPE_OTHER is used. Title of the role. For TYPE_OTHER, must be unique within an incident.
string description = 3
Output only unless TYPE_OTHER is used. Description of the role.
List of possible roles.
Used in:
TYPE_UNSPECIFIED = 0
The role is unspecified.
TYPE_INCIDENT_COMMANDER = 1
Incident Commander: Manages response plan, near-term and long-term objectives, establishes priorities, and delegates tasks as needed.
TYPE_COMMUNICATIONS_LEAD = 2
Communications Lead: Keeps everybody outside and within the response team informed.
TYPE_OPERATIONS_LEAD = 3
Operations Lead: Figures out what to do, and gets it done.
TYPE_EXTERNAL_CUSTOMER_COMMUNICATIONS_LEAD = 4
External Customer Communications Lead: Responsible for communicating incident details to customers/public.
TYPE_PRIMARY_ONCALL = 5
Primary Oncall: Responds to the initial page and handles all responsibilities for pre-escalated incidents.
TYPE_SECONDARY_ONCALL = 6
Secondary Oncall: Helps the primary oncall if necessary; mostly useful for pre-escalated incidents.
TYPE_OTHER = 7
User-specified roles. One example is a Planning Lead, who keeps track of the incident. Another is an assistant Incident Commander.
message
incidents.proto:350Stores the assignee of a role as well as the proposed next assignee.
Used as response type in: IncidentService.CancelIncidentRoleHandover, IncidentService.ConfirmIncidentRoleHandover, IncidentService.CreateIncidentRoleAssignment, IncidentService.ForceIncidentRoleHandover, IncidentService.RequestIncidentRoleHandover
Used as field type in: , ,
string name = 1
Output only. Resource name such as "projects/{project_id}/incidents/{incident_id}/role_assignments/{role_id}".
string etag = 2
Output only. Etag for this version of the resource. Must be specified in update requests and match the current version in storage. Must not be modified by the client.
optional role = 3
The role that is or will be assigned.
optional assignee = 4
The user this role is assigned to. This field can only be directly set during creation request. Subsequent updates are done via the IncidentRoleHandover methods.
optional proposed_assignee = 5
The recipient of a requested role handoff. This field can only be directly set during creation request. Subsequent updates are done via the IncidentRoleHandover methods. `assignee` is always the current role-holder, and `proposed_assignee` is used to track unfinished assignments and handoffs. Let's say Bob assigns Alice to a role. Then the fields are: `assignee`: nil, `proposed_assignee`: Alice If Alice accepts, then the fields are: `assignee`: Alice, `proposed_assignee`: nil If she cancels, then the RoleAssignment is deleted. Let's say Alice has the role. Then the fields are: `assignee`: Alice, `proposed_assignee`: nil If Alice becomes incapacitated and Bob requests Carol to take over, then the fields are: `assignee`: Alice, `proposed_assignee`: Carol After Carol accepts the handover, the fields are: `assignee`: Carol, `proposed_assignee`: nil Or if Carol refuses the handover, the fields are: `assignee`: Alice, `proposed_assignee`: nil
message
incidents_service.proto:366A single search result, i.e. an incident with (potentially) additional information.
Used in:
optional incident = 1
An incident that is "similar" to the incident or signal specified in the request.
message
incidents_service.proto:746Describes an incident for inclusion in the handoff. This is wrapped in a message to provide flexibility for potentially attaching additional data to each incident in the future.
Used in:
string name = 1
Resource name of the incident, for example, "projects/{project_id}/incidents/{incident_id}".
message
incidents.proto:47A signal is a message calling attention to a (potential) incident. An example is a page based on a Stackdriver Alerting policy.
Used as response type in: IncidentService.CreateSignal, IncidentService.GetSignal, IncidentService.LookupSignal, IncidentService.UpdateSignal
Used as field type in: , ,
string name = 1
Resource name of the signal, for example, "projects/{project_id}/signals/{signal_id}".
string etag = 2
Etag to validate the object is unchanged for a read-modify-write operation. An empty etag will overwrite other changes.
string incident = 3
Resource name of the incident this signal is currently assigned to. May be empty if signal is unassigned.
optional create_time = 4
Output only. Time this signal was created.
optional close_time = 10
Output only. Time this signal was closed. This field is not populated while the signal is still firing.
optional detect_time = 15
The time this Signal was first detected. This is identical to create_time for Signals created by Stackdriver Alerting.
optional creator = 5
Output only. The user that created this signal for manually created signals. Empty if this signal was generated by a system (for example, Stackdriver Alerting).
string title = 6
One-line summary of the signal. Immutable.
string content_type = 7
Content type string. 'text/plain' is currently the only supported content type for Signals created via the API. Signals created by Stackdriver Alerting support 'text/html' as well. Immutable for Signals created by Stackdriver Alerting.
string content = 8
Full message of the signal. Immutable for Signals created by Stackdriver Alerting.
Signal.State signal_state = 9
The state of this signal. For Signals created by Stackdriver Alerting this field is output only.
repeated signal_artifacts = 16
A set of artifacts to additional resources for this Signal. For example, a link to Stackdriver logging for the Signal. Immutable for Signals created by Stackdriver Alerting.
message
incidents.proto:49An artifact associated with the Signal.
Used in:
oneof artifact_type
The type of resource linked to
string user_type = 2
A custom user type
string uri = 3
The URI for the artifact.
Describes whether the alerting condition is still firing.
Used in:
STATE_UNSPECIFIED = 0
Unspecified
STATE_OPEN = 1
Firing
STATE_CLOSED = 2
Non-firing
message
incidents.proto:452A subscription allows users to get notifications about changes to an incident.
Used as response type in: IncidentService.CreateSubscription, IncidentService.UpdateSubscription
Used as field type in: , , , ,
string name = 1
Output only. Resource name such as "projects/{project_id}/incidents/{incident_id}/subscriptions/{subscription_id}".
string etag = 2
Output only. Etag for this version of the resource. Must be specified in update requests and match the current version in storage. Must not be modified by the client.
optional subscription_channel = 3
A communications channel to send subscription messages to.
repeated Subscription.EventType event_types = 4
Types of events this subscription receives notifications for.
Types of changes that users can subscribe to in an incident.
Used in:
EVENT_TYPE_UNSPECIFIED = 0
An event_type that's not specified is an error.
EVENT_TYPE_TITLE_CHANGE = 1
The incident's title has changed.
EVENT_TYPE_SYNOPSIS_CHANGE = 2
The incident's synopsis has changed.
EVENT_TYPE_STAGE_CHANGE = 3
The incident's stage has changed.
EVENT_TYPE_SEVERITY_CHANGE = 4
The incident's severity has changed.
EVENT_TYPE_ANNOTATION_ADD = 5
A new annotation has been added to the incident.
EVENT_TYPE_ANNOTATION_CHANGE = 6
An annotation has been modified.
message
incidents.proto:156Synopsis is a summary of an incident and it contains a textual content, an author and a last updated timestamp.
Used in:
string content_type = 1
Content type string, for example, 'text/plain' or 'text/markdown'.
string content = 2
Textual content of the synopsis. It can be plain text or markdown as indicated by the content_type.
optional update_time = 3
Last updated timestamp.
optional author = 4
Author of the synopsis.
message
incidents.proto:145A tag by a user.
Used as response type in: IncidentService.CreateTag
Used as field type in: , , ,
string name = 1
Resource name of a tag, for example, "projects/{project_id}/incidents/{incident_id}/tags/{tag_id}"
string display_name = 2
Display name of the resource (for example, "cause:rollout"). Immutable.
message
incidents.proto:29A user of the IRM app.
Used in: , , , , , , ,
oneof user
One of several ways to uniquely identify a user.
string user_id = 1
Output only. User id that will allow to get additional information from People API. This field will be populated implicitly if the caller creates or edits a resource (for example, posts an annotation).
string email = 2
Email address of the user. This must be associated with a Google account. This field will be set if the user is explicitly identified (verbatim) by email address in an API request (potentially sometime in the past). It will not be populated based on the credentials of a caller of the API.