Types for Stackdriver Incident Response & Management API Client

class google.cloud.irm_v1alpha2.types.Annotation

A text annotation by a user.

name

Resource name of the annotation, for example, “projects/{proje ct_id}/incidents/{incident_id}/annotations/{annotation_id}” .

author

Output only. Author of the annotation.

create_time

Output only. Time the annotation was created.

content

Content of the annotation. Immutable.

author

Field google.cloud.irm.v1alpha2.Annotation.author

content

Field google.cloud.irm.v1alpha2.Annotation.content

create_time

Field google.cloud.irm.v1alpha2.Annotation.create_time

name

Field google.cloud.irm.v1alpha2.Annotation.name

class google.cloud.irm_v1alpha2.types.Artifact

External artifact associated to an incident.

name

Output only. Resource name such as “projects/{project_id}/inc idents/{incident_id}/artifacts/{artifact_id}”.

display_name

User provided name of an artifact.

etag

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.

url

URL to access the artifact.

type

Type of this artifact.

display_name

Field google.cloud.irm.v1alpha2.Artifact.display_name

etag

Field google.cloud.irm.v1alpha2.Artifact.etag

name

Field google.cloud.irm.v1alpha2.Artifact.name

type

Field google.cloud.irm.v1alpha2.Artifact.type

url

Field google.cloud.irm.v1alpha2.Artifact.url

class google.cloud.irm_v1alpha2.types.CancelIncidentRoleHandoverRequest

Request to cancel a role handover.

name

Resource name of the role assignment.

new_assignee

Person who was proposed as the next assignee (i.e. IncidentRoleAssignment.proposed_assignee) and whose proposal is being cancelled.

name

Field google.cloud.irm.v1alpha2.CancelIncidentRoleHandoverRequest.name

new_assignee

Field google.cloud.irm.v1alpha2.CancelIncidentRoleHandoverRequest.new_assignee

class google.cloud.irm_v1alpha2.types.CommunicationChannel

Communication Channels are mechanisms used to receive notifications about changes to incidents.

endpoint

An endpoint describes how messages will be delivered.

email

Messages will be delivered via email.

notification_channel

Messages will be delivered via a Stackdriver notification channel.

class Email

A communication channel that delivers messages to an email address.

address

The email address, for example, “user@example.com”.

address

Field google.cloud.irm.v1alpha2.CommunicationChannel.Email.address

class NotificationChannel

A communication channel that delivers messages to a Stackdriver notification channel.

name

Stackdriver notification channel name.

name

Field google.cloud.irm.v1alpha2.CommunicationChannel.NotificationChannel.name

email

Field google.cloud.irm.v1alpha2.CommunicationChannel.email

notification_channel

Field google.cloud.irm.v1alpha2.CommunicationChannel.notification_channel

class google.cloud.irm_v1alpha2.types.ConfirmIncidentRoleHandoverRequest

Request to confirm a role handover.

name

Resource name of the role assignment.

new_assignee

The proposed assignee, who will now be the assignee. This should be the current user; otherwise ForceRoleHandover should be called.

name

Field google.cloud.irm.v1alpha2.ConfirmIncidentRoleHandoverRequest.name

new_assignee

Field google.cloud.irm.v1alpha2.ConfirmIncidentRoleHandoverRequest.new_assignee

class google.cloud.irm_v1alpha2.types.CreateAnnotationRequest

Request for the CreateAnnotation method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

annotation

Only annotation.content is an input argument.

annotation

Field google.cloud.irm.v1alpha2.CreateAnnotationRequest.annotation

parent

Field google.cloud.irm.v1alpha2.CreateAnnotationRequest.parent

class google.cloud.irm_v1alpha2.types.CreateArtifactRequest

Request for the CreateArtifact method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

artifact

The artifact to create.

artifact

Field google.cloud.irm.v1alpha2.CreateArtifactRequest.artifact

parent

Field google.cloud.irm.v1alpha2.CreateArtifactRequest.parent

class google.cloud.irm_v1alpha2.types.CreateIncidentRequest

Request for the CreateIncident method.

incident

The incident to create.

parent

The resource name of the hosting Stackdriver project which the incident belongs to. The name is of the form projects/{project_id_or_number} .

incident

Field google.cloud.irm.v1alpha2.CreateIncidentRequest.incident

parent

Field google.cloud.irm.v1alpha2.CreateIncidentRequest.parent

class google.cloud.irm_v1alpha2.types.CreateIncidentRoleAssignmentRequest

Request for creating a role assignment.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

incident_role_assignment

Role assignment to create.

incident_role_assignment

Field google.cloud.irm.v1alpha2.CreateIncidentRoleAssignmentRequest.incident_role_assignment

parent

Field google.cloud.irm.v1alpha2.CreateIncidentRoleAssignmentRequest.parent

class google.cloud.irm_v1alpha2.types.CreateSignalRequest

Request for the CreateSignal method.

parent

The resource name of the hosting Stackdriver project which requested signal belongs to.

signal

The signal to create.

parent

Field google.cloud.irm.v1alpha2.CreateSignalRequest.parent

signal

Field google.cloud.irm.v1alpha2.CreateSignalRequest.signal

class google.cloud.irm_v1alpha2.types.CreateSubscriptionRequest

Request for the CreateSubscription method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

subscription

The subscription to create.

parent

Field google.cloud.irm.v1alpha2.CreateSubscriptionRequest.parent

subscription

Field google.cloud.irm.v1alpha2.CreateSubscriptionRequest.subscription

class google.cloud.irm_v1alpha2.types.CreateTagRequest

Request for the CreateTag method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

tag

Tag to create. Only tag.display_name is an input argument.

parent

Field google.cloud.irm.v1alpha2.CreateTagRequest.parent

tag

Field google.cloud.irm.v1alpha2.CreateTagRequest.tag

class google.cloud.irm_v1alpha2.types.DeleteArtifactRequest

Request for deleting an artifact.

name

Resource name of the artifact.

name

Field google.cloud.irm.v1alpha2.DeleteArtifactRequest.name

class google.cloud.irm_v1alpha2.types.DeleteIncidentRoleAssignmentRequest

Request for deleting a role assignment.

name

Resource name of the role assignment.

name

Field google.cloud.irm.v1alpha2.DeleteIncidentRoleAssignmentRequest.name

class google.cloud.irm_v1alpha2.types.DeleteSubscriptionRequest

Request for deleting a subscription.

name

Resource name of the subscription.

name

Field google.cloud.irm.v1alpha2.DeleteSubscriptionRequest.name

class google.cloud.irm_v1alpha2.types.DeleteTagRequest

Request for the DeleteTag method.

name

Resource name of the tag.

name

Field google.cloud.irm.v1alpha2.DeleteTagRequest.name

class google.cloud.irm_v1alpha2.types.Empty

class google.cloud.irm_v1alpha2.types.EscalateIncidentRequest

Request to escalate an incident.

incident

The incident to escalate with the new values.

update_mask

List of fields that should be updated.

subscriptions

Subscriptions to add or update. Existing subscriptions with the same channel and address as a subscription in the list will be updated.

tags

Tags to add. Tags identical to existing tags will be ignored.

roles

Roles to add or update. Existing roles with the same type (and title, for TYPE_OTHER roles) will be updated.

artifacts

Artifacts to add. All artifacts are added without checking for duplicates.

artifacts

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.artifacts

incident

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.incident

roles

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.roles

subscriptions

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.subscriptions

tags

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.tags

update_mask

Field google.cloud.irm.v1alpha2.EscalateIncidentRequest.update_mask

class google.cloud.irm_v1alpha2.types.EscalateIncidentResponse

Response for EscalateIncident.

incident

The escalated incident.

subscriptions

New or modified subscriptions.

tags

New or modified tags.

roles

New or modified roles.

artifacts

New or modified artifacts.

artifacts

Field google.cloud.irm.v1alpha2.EscalateIncidentResponse.artifacts

incident

Field google.cloud.irm.v1alpha2.EscalateIncidentResponse.incident

roles

Field google.cloud.irm.v1alpha2.EscalateIncidentResponse.roles

subscriptions

Field google.cloud.irm.v1alpha2.EscalateIncidentResponse.subscriptions

tags

Field google.cloud.irm.v1alpha2.EscalateIncidentResponse.tags

class google.cloud.irm_v1alpha2.types.FieldMask

paths

Field google.protobuf.FieldMask.paths

class google.cloud.irm_v1alpha2.types.ForceIncidentRoleHandoverRequest

Request to force a role handover.

name

Resource name of the role assignment.

new_assignee

The proposed assignee, who will now be the assignee. This should not be the current user; otherwise ConfirmRoleHandover should be called.

name

Field google.cloud.irm.v1alpha2.ForceIncidentRoleHandoverRequest.name

new_assignee

Field google.cloud.irm.v1alpha2.ForceIncidentRoleHandoverRequest.new_assignee

class google.cloud.irm_v1alpha2.types.GetIncidentRequest

Request for the GetIncident method.

name

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

name

Field google.cloud.irm.v1alpha2.GetIncidentRequest.name

class google.cloud.irm_v1alpha2.types.GetSignalRequest

Request for the GetSignal method.

name

Resource name of the Signal resource, for example, “projects/{project_id}/signals/{signal_id}”.

name

Field google.cloud.irm.v1alpha2.GetSignalRequest.name

class google.cloud.irm_v1alpha2.types.Incident

Representation of an incident.

name

Output only. Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

title

One-line summary of the incident.

escalation_level

Escalation level of the incident.

etag

Etag to validate the object is unchanged for a read-modify- write operation. An empty etag will overwrite other changes.

severity

Severity of the incident.

stage

Stage of the incident.

duplicate_incident

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.

start_time

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.

synopsis

Output only. Synopsis of this incident.

communication_venue

Location of communications for this incident. This is informational only; IRM does not use this to send messages.

class CommunicationVenue

CommunicationVenue is a record of where conversations about an incident are happening.

uri

A URI to the web interface of the channel.

display_name

A name representing the channel in IRM UI.

channel_type

The type of channel/venue for incident communications.

channel_type

Field google.cloud.irm.v1alpha2.Incident.CommunicationVenue.channel_type

display_name

Field google.cloud.irm.v1alpha2.Incident.CommunicationVenue.display_name

uri

Field google.cloud.irm.v1alpha2.Incident.CommunicationVenue.uri

communication_venue

Field google.cloud.irm.v1alpha2.Incident.communication_venue

duplicate_incident

Field google.cloud.irm.v1alpha2.Incident.duplicate_incident

escalation_level

Field google.cloud.irm.v1alpha2.Incident.escalation_level

etag

Field google.cloud.irm.v1alpha2.Incident.etag

name

Field google.cloud.irm.v1alpha2.Incident.name

severity

Field google.cloud.irm.v1alpha2.Incident.severity

stage

Field google.cloud.irm.v1alpha2.Incident.stage

start_time

Field google.cloud.irm.v1alpha2.Incident.start_time

synopsis

Field google.cloud.irm.v1alpha2.Incident.synopsis

title

Field google.cloud.irm.v1alpha2.Incident.title

class google.cloud.irm_v1alpha2.types.IncidentRole

Describes a role that can be assigned to an incident.

type

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.

title

Output only unless TYPE_OTHER is used. Title of the role. For TYPE_OTHER, must be unique within an incident.

description

Output only unless TYPE_OTHER is used. Description of the role.

description

Field google.cloud.irm.v1alpha2.IncidentRole.description

title

Field google.cloud.irm.v1alpha2.IncidentRole.title

type

Field google.cloud.irm.v1alpha2.IncidentRole.type

class google.cloud.irm_v1alpha2.types.IncidentRoleAssignment

Stores the assignee of a role as well as the proposed next assignee.

name

Output only. Resource name such as “projects/{project_id}/inc idents/{incident_id}/role_assignments/{role_id}”.

etag

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.

role

The role that is or will be assigned.

assignee

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.

proposed_assignee

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

assignee

Field google.cloud.irm.v1alpha2.IncidentRoleAssignment.assignee

etag

Field google.cloud.irm.v1alpha2.IncidentRoleAssignment.etag

name

Field google.cloud.irm.v1alpha2.IncidentRoleAssignment.name

proposed_assignee

Field google.cloud.irm.v1alpha2.IncidentRoleAssignment.proposed_assignee

role

Field google.cloud.irm.v1alpha2.IncidentRoleAssignment.role

class google.cloud.irm_v1alpha2.types.ListAnnotationsRequest

Request for the ListAnnotations method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of annotations to return.

page_token

Page token from an earlier query, as returned in next_page_token.

page_size

Field google.cloud.irm.v1alpha2.ListAnnotationsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.ListAnnotationsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.ListAnnotationsRequest.parent

class google.cloud.irm_v1alpha2.types.ListAnnotationsResponse

Response for the ListAnnotations method.

annotations

List of annotations.

next_page_token

Page token to fetch the next set of annotations.

annotations

Field google.cloud.irm.v1alpha2.ListAnnotationsResponse.annotations

next_page_token

Field google.cloud.irm.v1alpha2.ListAnnotationsResponse.next_page_token

class google.cloud.irm_v1alpha2.types.ListArtifactsRequest

Request for the ListArtifacts method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of artifacts to return.

page_token

Page token from an earlier query, as returned in next_page_token.

page_size

Field google.cloud.irm.v1alpha2.ListArtifactsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.ListArtifactsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.ListArtifactsRequest.parent

class google.cloud.irm_v1alpha2.types.ListArtifactsResponse

Response for the ListArtifacts method.

artifacts

List of artifacts.

next_page_token

Page token to fetch the next set of artifacts.

artifacts

Field google.cloud.irm.v1alpha2.ListArtifactsResponse.artifacts

next_page_token

Field google.cloud.irm.v1alpha2.ListArtifactsResponse.next_page_token

class google.cloud.irm_v1alpha2.types.ListIncidentRoleAssignmentsRequest

Request to list role assignments of an incident.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of assignments to return.

page_token

Page token from an earlier query, as returned in next_page_token.

page_size

Field google.cloud.irm.v1alpha2.ListIncidentRoleAssignmentsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.ListIncidentRoleAssignmentsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.ListIncidentRoleAssignmentsRequest.parent

class google.cloud.irm_v1alpha2.types.ListIncidentRoleAssignmentsResponse

Response for the ListIncidentRoleAssignments method.

incident_role_assignments

List of assignments.

next_page_token

Page token to fetch the next set of assignments.

incident_role_assignments

Field google.cloud.irm.v1alpha2.ListIncidentRoleAssignmentsResponse.incident_role_assignments

next_page_token

Field google.cloud.irm.v1alpha2.ListIncidentRoleAssignmentsResponse.next_page_token

class google.cloud.irm_v1alpha2.types.ListSubscriptionsRequest

Request for the ListSubscriptions method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of subscriptions to return.

page_token

Page token from an earlier query, as returned in next_page_token.

page_size

Field google.cloud.irm.v1alpha2.ListSubscriptionsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.ListSubscriptionsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.ListSubscriptionsRequest.parent

class google.cloud.irm_v1alpha2.types.ListSubscriptionsResponse

Response for the ListSubscriptions method.

subscriptions

List of subscriptions.

next_page_token

Page token to fetch the next set of subscriptions.

next_page_token

Field google.cloud.irm.v1alpha2.ListSubscriptionsResponse.next_page_token

subscriptions

Field google.cloud.irm.v1alpha2.ListSubscriptionsResponse.subscriptions

class google.cloud.irm_v1alpha2.types.ListTagsRequest

Request for the ListTagsForIncident method.

parent

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of tags to return.

page_token

Page token from an earlier query, as returned in next_page_token.

page_size

Field google.cloud.irm.v1alpha2.ListTagsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.ListTagsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.ListTagsRequest.parent

class google.cloud.irm_v1alpha2.types.ListTagsResponse

Response for the ListTagsForIncident method.

tags

Tags.

next_page_token

Page token to fetch the next set of tags.

next_page_token

Field google.cloud.irm.v1alpha2.ListTagsResponse.next_page_token

tags

Field google.cloud.irm.v1alpha2.ListTagsResponse.tags

class google.cloud.irm_v1alpha2.types.RequestIncidentRoleHandoverRequest

Request to start a role handover.

name

Resource name of the role assignment.

new_assignee

The proposed assignee.

name

Field google.cloud.irm.v1alpha2.RequestIncidentRoleHandoverRequest.name

new_assignee

Field google.cloud.irm.v1alpha2.RequestIncidentRoleHandoverRequest.new_assignee

class google.cloud.irm_v1alpha2.types.SearchIncidentsRequest

Request for the SearchIncidents method.

parent

The resource name of the hosting Stackdriver project which requested incidents belong to.

query

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”

page_size

Number of incidents to return.

page_token

Page token from an earlier query, as returned in next_page_token.

time_zone

The time zone name. It should be an IANA TZ name, such as “America/Los_Angeles”. For more information, see https://en.w ikipedia.org/wiki/List_of_tz_database_time_zones. If no time zone is specified, the default is UTC.

page_size

Field google.cloud.irm.v1alpha2.SearchIncidentsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.SearchIncidentsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.SearchIncidentsRequest.parent

query

Field google.cloud.irm.v1alpha2.SearchIncidentsRequest.query

time_zone

Field google.cloud.irm.v1alpha2.SearchIncidentsRequest.time_zone

class google.cloud.irm_v1alpha2.types.SearchIncidentsResponse

Response for the SearchIncidents method.

incidents

Incidents.

next_page_token

Page token to fetch the next set of incidents.

incidents

Field google.cloud.irm.v1alpha2.SearchIncidentsResponse.incidents

next_page_token

Field google.cloud.irm.v1alpha2.SearchIncidentsResponse.next_page_token

class google.cloud.irm_v1alpha2.types.SearchSignalsRequest

Request for the SearchSignals method.

parent

The resource name of the hosting Stackdriver project which requested incidents belong to.

query

Query to specify which signals should be returned.

page_size

Maximum number of signals to return in the response.

page_token

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).

page_size

Field google.cloud.irm.v1alpha2.SearchSignalsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.SearchSignalsRequest.page_token

parent

Field google.cloud.irm.v1alpha2.SearchSignalsRequest.parent

query

Field google.cloud.irm.v1alpha2.SearchSignalsRequest.query

class google.cloud.irm_v1alpha2.types.SearchSignalsResponse

Response for the SearchSignals method.

signals

Signals that matched the query in the request.

next_page_token

Page token to fetch the next set of signals.

next_page_token

Field google.cloud.irm.v1alpha2.SearchSignalsResponse.next_page_token

signals

Field google.cloud.irm.v1alpha2.SearchSignalsResponse.signals

class google.cloud.irm_v1alpha2.types.SearchSimilarIncidentsRequest

Request for the SearchSimilarIncidents method.

name

Resource name of the incident or signal, for example, “projects/{project_id}/incidents/{incident_id}”.

page_size

Number of similar incidents to return.

page_token

Page token from an earlier query, as returned in ‘next_page_token’.

name

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsRequest.name

page_size

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsRequest.page_size

page_token

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsRequest.page_token

class google.cloud.irm_v1alpha2.types.SearchSimilarIncidentsResponse

Response for the SearchSimilarIncidents method.

results

The search results, ordered by descending relevance.

next_page_token

Page token to fetch the next set of similar incidents.

class Result

A single search result, i.e. an incident with (potentially) additional information.

incident

An incident that is “similar” to the incident or signal specified in the request.

incident

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsResponse.Result.incident

next_page_token

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsResponse.next_page_token

results

Field google.cloud.irm.v1alpha2.SearchSimilarIncidentsResponse.results

class google.cloud.irm_v1alpha2.types.SendShiftHandoffRequest

SendShiftHandoff and PreviewShiftHandoff RPC request.

parent

The resource name of the Stackdriver project that the handoff is being sent from. for example, projects/{project_id}

recipients

Email addresses of the recipients of the handoff, for example, “user@example.com”. Must contain at least one entry.

cc

Email addresses that should be CC’d on the handoff. Optional.

subject

The subject of the email. Required.

notes_content_type

Content type string, for example, ‘text/plain’ or ‘text/html’.

notes_content

Additional notes to be included in the handoff. Optional.

incidents

The set of incidents that should be included in the handoff. Optional.

preview_only

If set to true a ShiftHandoffResponse will be returned but the handoff will not actually be sent.

class Incident

Describes 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.

name

Resource name of the incident, for example, “projects/{project_id}/incidents/{incident_id}”.

name

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.Incident.name

cc

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.cc

incidents

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.incidents

notes_content

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.notes_content

notes_content_type

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.notes_content_type

parent

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.parent

preview_only

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.preview_only

recipients

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.recipients

subject

Field google.cloud.irm.v1alpha2.SendShiftHandoffRequest.subject

class google.cloud.irm_v1alpha2.types.SendShiftHandoffResponse

SendShiftHandoff and PreviewShiftHandoff RPC response.

content_type

Content type string, for example, ‘text/plain’ or ‘text/html’.

content

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.

content

Field google.cloud.irm.v1alpha2.SendShiftHandoffResponse.content

content_type

Field google.cloud.irm.v1alpha2.SendShiftHandoffResponse.content_type

class google.cloud.irm_v1alpha2.types.Signal

A signal is a message calling attention to a (potential) incident. An example is a page based on a Stackdriver Alerting policy.

name

Resource name of the signal, for example, “projects/{project_id}/signals/{signal_id}”.

etag

Etag to validate the object is unchanged for a read-modify- write operation. An empty etag will overwrite other changes.

incident

Resource name of the incident this signal is currently assigned to. May be empty if signal is unassigned.

create_time

Output only. Time this signal was created.

close_time

Output only. Time this signal was closed. This field is not populated while the signal is still firing.

detect_time

The time this Signal was first detected. This is identical to create_time for Signals created by Stackdriver Alerting.

creator

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).

title

One-line summary of the signal. Immutable.

content_type

Content type string, for example, ‘text/plain’ or’text/html’.

content

Full message of the signal. Immutable for Signals created by Stackdriver Alerting.

signal_state

The state of this signal. For Signals created by Stackdriver Alerting this field is output only.

signal_artifacts

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.

class SignalArtifact

An artifact associated with the Signal.

artifact_type

The type of resource linked to

user_type

A custom user type

uri

The URI for the artifact.

uri

Field google.cloud.irm.v1alpha2.Signal.SignalArtifact.uri

user_type

Field google.cloud.irm.v1alpha2.Signal.SignalArtifact.user_type

close_time

Field google.cloud.irm.v1alpha2.Signal.close_time

content

Field google.cloud.irm.v1alpha2.Signal.content

content_type

Field google.cloud.irm.v1alpha2.Signal.content_type

create_time

Field google.cloud.irm.v1alpha2.Signal.create_time

creator

Field google.cloud.irm.v1alpha2.Signal.creator

detect_time

Field google.cloud.irm.v1alpha2.Signal.detect_time

etag

Field google.cloud.irm.v1alpha2.Signal.etag

incident

Field google.cloud.irm.v1alpha2.Signal.incident

name

Field google.cloud.irm.v1alpha2.Signal.name

signal_artifacts

Field google.cloud.irm.v1alpha2.Signal.signal_artifacts

signal_state

Field google.cloud.irm.v1alpha2.Signal.signal_state

title

Field google.cloud.irm.v1alpha2.Signal.title

class google.cloud.irm_v1alpha2.types.Subscription

A subscription allows users to get notifications about changes to an incident.

name

Output only. Resource name such as “projects/{project_id}/inc idents/{incident_id}/subscriptions/{subscription_id}”.

etag

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.

subscription_channel

A communications channel to send subscription messages to.

event_types

Types of events this subscription receives notifications for.

etag

Field google.cloud.irm.v1alpha2.Subscription.etag

event_types

Field google.cloud.irm.v1alpha2.Subscription.event_types

name

Field google.cloud.irm.v1alpha2.Subscription.name

subscription_channel

Field google.cloud.irm.v1alpha2.Subscription.subscription_channel

class google.cloud.irm_v1alpha2.types.Synopsis

Synopsis is a summary of an incident and it contains a textual content, an author and a last updated timestamp.

content_type

Content type string, for example, ‘text/plain’ or ‘text/html’.

content

Textual content of the synopsis. It can be plain text or markdown as indicated by the content_type.

update_time

Last updated timestamp.

author

Author of the synopsis.

author

Field google.cloud.irm.v1alpha2.Synopsis.author

content

Field google.cloud.irm.v1alpha2.Synopsis.content

content_type

Field google.cloud.irm.v1alpha2.Synopsis.content_type

update_time

Field google.cloud.irm.v1alpha2.Synopsis.update_time

class google.cloud.irm_v1alpha2.types.Tag

A tag by a user.

name

Resource name of a tag, for example, “projects/{project_id}/i ncidents/{incident_id}/tags/{tag_id}”

display_name

Display name of the resource (for example, “cause:rollout”). Immutable.

display_name

Field google.cloud.irm.v1alpha2.Tag.display_name

name

Field google.cloud.irm.v1alpha2.Tag.name

class google.cloud.irm_v1alpha2.types.Timestamp

nanos

Field google.protobuf.Timestamp.nanos

seconds

Field google.protobuf.Timestamp.seconds

class google.cloud.irm_v1alpha2.types.UpdateArtifactRequest

Request for the UpdateArtifact method.

artifact

The artifact to update with the new values.

update_mask

List of fields that should be updated.

artifact

Field google.cloud.irm.v1alpha2.UpdateArtifactRequest.artifact

update_mask

Field google.cloud.irm.v1alpha2.UpdateArtifactRequest.update_mask

class google.cloud.irm_v1alpha2.types.UpdateIncidentRequest

Request for the UpdateIncident method.

incident

The incident to update with the new values.

update_mask

List of fields that should be updated.

incident

Field google.cloud.irm.v1alpha2.UpdateIncidentRequest.incident

update_mask

Field google.cloud.irm.v1alpha2.UpdateIncidentRequest.update_mask

class google.cloud.irm_v1alpha2.types.UpdateSignalRequest

Request for the UpdateSignal method.

signal

The signal to update with the new values.

update_mask

List of fields that should be updated.

signal

Field google.cloud.irm.v1alpha2.UpdateSignalRequest.signal

update_mask

Field google.cloud.irm.v1alpha2.UpdateSignalRequest.update_mask

class google.cloud.irm_v1alpha2.types.UpdateSubscriptionRequest

Request for the UpdateSubscription method.

subscription

The subscription to update, with new values.

update_mask

List of fields that should be updated.

subscription

Field google.cloud.irm.v1alpha2.UpdateSubscriptionRequest.subscription

update_mask

Field google.cloud.irm.v1alpha2.UpdateSubscriptionRequest.update_mask

class google.cloud.irm_v1alpha2.types.User

A user of the IRM app.

user

One of several ways to uniquely identify a user.

user_id

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).

email

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.

email

Field google.cloud.irm.v1alpha2.User.email

user_id

Field google.cloud.irm.v1alpha2.User.user_id