com.google.irm.service.v1alpha2.api

Class IncidentServiceGrpc.IncidentServiceStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractAsyncStub<IncidentServiceGrpc.IncidentServiceStub>

com.google.irm.service.v1alpha2.api.IncidentServiceGrpc.IncidentServiceStub

Enclosing class:

IncidentServiceGrpc

public static final class IncidentServiceGrpc.IncidentServiceStub
extends AbstractAsyncStub<IncidentServiceGrpc.IncidentServiceStub>

 The Incident API for Incident Response & Management.
 

Nested Class Summary

Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

AbstractStub.StubFactory<T extends AbstractStub<T>>

Method Summary

Modifier and Type	Method and Description
protected IncidentServiceGrpc.IncidentServiceStub	build(Channel channel, CallOptions callOptions)
void	cancelIncidentRoleHandover(CancelIncidentRoleHandoverRequest request, StreamObserver<IncidentRoleAssignment> responseObserver) Cancels a role handover.
void	confirmIncidentRoleHandover(ConfirmIncidentRoleHandoverRequest request, StreamObserver<IncidentRoleAssignment> responseObserver) Confirms a role handover.
void	createAnnotation(CreateAnnotationRequest request, StreamObserver<Annotation> responseObserver) Creates an annotation on an existing incident.
void	createArtifact(CreateArtifactRequest request, StreamObserver<Artifact> responseObserver) Creates a new artifact.
void	createIncident(CreateIncidentRequest request, StreamObserver<Incident> responseObserver) Creates a new incident.
void	createIncidentRoleAssignment(CreateIncidentRoleAssignmentRequest request, StreamObserver<IncidentRoleAssignment> responseObserver) Creates a role assignment on an existing incident.
void	createSignal(CreateSignalRequest request, StreamObserver<Signal> responseObserver) Creates a new signal.
void	createSubscription(CreateSubscriptionRequest request, StreamObserver<Subscription> responseObserver) Creates a new subscription.
void	createTag(CreateTagRequest request, StreamObserver<Tag> responseObserver) Creates a tag on an existing incident.
void	deleteArtifact(DeleteArtifactRequest request, StreamObserver<Empty> responseObserver) Deletes an existing artifact.
void	deleteIncidentRoleAssignment(DeleteIncidentRoleAssignmentRequest request, StreamObserver<Empty> responseObserver) Deletes an existing role assignment.
void	deleteSubscription(DeleteSubscriptionRequest request, StreamObserver<Empty> responseObserver) Deletes an existing subscription.
void	deleteTag(DeleteTagRequest request, StreamObserver<Empty> responseObserver) Deletes an existing tag.
void	escalateIncident(EscalateIncidentRequest request, StreamObserver<EscalateIncidentResponse> responseObserver) Escalates an incident.
void	forceIncidentRoleHandover(ForceIncidentRoleHandoverRequest request, StreamObserver<IncidentRoleAssignment> responseObserver) Forces a role handover.
void	getIncident(GetIncidentRequest request, StreamObserver<Incident> responseObserver) Returns an incident by name.
void	getSignal(GetSignalRequest request, StreamObserver<Signal> responseObserver) Returns a signal by name.
void	listAnnotations(ListAnnotationsRequest request, StreamObserver<ListAnnotationsResponse> responseObserver) Lists annotations that are part of an incident.
void	listArtifacts(ListArtifactsRequest request, StreamObserver<ListArtifactsResponse> responseObserver) Returns a list of artifacts for an incident.
void	listIncidentRoleAssignments(ListIncidentRoleAssignmentsRequest request, StreamObserver<ListIncidentRoleAssignmentsResponse> responseObserver) Lists role assignments that are part of an incident.
void	listSubscriptions(ListSubscriptionsRequest request, StreamObserver<ListSubscriptionsResponse> responseObserver) Returns a list of subscriptions for an incident.
void	listTags(ListTagsRequest request, StreamObserver<ListTagsResponse> responseObserver) Lists tags that are part of an incident.
void	lookupSignal(LookupSignalRequest request, StreamObserver<Signal> responseObserver) Finds a signal by other unique IDs.
void	requestIncidentRoleHandover(RequestIncidentRoleHandoverRequest request, StreamObserver<IncidentRoleAssignment> responseObserver) Starts a role handover.
void	searchIncidents(SearchIncidentsRequest request, StreamObserver<SearchIncidentsResponse> responseObserver) Returns a list of incidents.
void	searchSignals(SearchSignalsRequest request, StreamObserver<SearchSignalsResponse> responseObserver) Lists signals that are part of an incident.
void	searchSimilarIncidents(SearchSimilarIncidentsRequest request, StreamObserver<SearchSimilarIncidentsResponse> responseObserver) Returns a list of incidents that are "similar" to the specified incident or signal.
void	sendShiftHandoff(SendShiftHandoffRequest request, StreamObserver<SendShiftHandoffResponse> responseObserver) Sends a summary of the shift for oncall handoff.
void	updateArtifact(UpdateArtifactRequest request, StreamObserver<Artifact> responseObserver) Updates an existing artifact.
void	updateIncident(UpdateIncidentRequest request, StreamObserver<Incident> responseObserver) Updates an existing incident.
void	updateSignal(UpdateSignalRequest request, StreamObserver<Signal> responseObserver) Updates an existing signal (for example, to assign/unassign it to an incident).
void	updateSubscription(UpdateSubscriptionRequest request, StreamObserver<Subscription> responseObserver) Updates a subscription.

Methods inherited from class io.grpc.stub.AbstractAsyncStub

newStub, newStub

Methods inherited from class io.grpc.stub.AbstractStub

getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOption, withWaitForReady

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

build

protected IncidentServiceGrpc.IncidentServiceStub build(Channel channel,
                                                        CallOptions callOptions)

Specified by:

build in class AbstractStub<IncidentServiceGrpc.IncidentServiceStub>

createIncident

public void createIncident(CreateIncidentRequest request,
                           StreamObserver<Incident> responseObserver)

 Creates a new incident.
 

getIncident

public void getIncident(GetIncidentRequest request,
                        StreamObserver<Incident> responseObserver)

 Returns an incident by name.
 

searchIncidents

public void searchIncidents(SearchIncidentsRequest request,
                            StreamObserver<SearchIncidentsResponse> responseObserver)

 Returns a list of incidents.
 Incidents are ordered by start time, with the most recent incidents first.
 

updateIncident

public void updateIncident(UpdateIncidentRequest request,
                           StreamObserver<Incident> responseObserver)

 Updates an existing incident.
 

searchSimilarIncidents

public void searchSimilarIncidents(SearchSimilarIncidentsRequest request,
                                   StreamObserver<SearchSimilarIncidentsResponse> responseObserver)

 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.
 

createAnnotation

public void createAnnotation(CreateAnnotationRequest request,
                             StreamObserver<Annotation> responseObserver)

 Creates an annotation on an existing incident. Only 'text/plain' and
 'text/markdown' annotations can be created via this method.
 

listAnnotations

public void listAnnotations(ListAnnotationsRequest request,
                            StreamObserver<ListAnnotationsResponse> responseObserver)

 Lists annotations that are part of an incident. No assumptions should be
 made on the content-type of the annotation returned.
 

createTag

public void createTag(CreateTagRequest request,
                      StreamObserver<Tag> responseObserver)

 Creates a tag on an existing incident.
 

deleteTag

public void deleteTag(DeleteTagRequest request,
                      StreamObserver<Empty> responseObserver)

 Deletes an existing tag.
 

listTags

public void listTags(ListTagsRequest request,
                     StreamObserver<ListTagsResponse> responseObserver)

 Lists tags that are part of an incident.
 

createSignal

public void createSignal(CreateSignalRequest request,
                         StreamObserver<Signal> responseObserver)

 Creates a new signal.
 

searchSignals

public void searchSignals(SearchSignalsRequest request,
                          StreamObserver<SearchSignalsResponse> responseObserver)

 Lists signals that are part of an incident.
 Signals are returned in reverse chronological order.
 Note that search should not be relied on for critical functionality.  It
 has lower availability guarantees and might fail to return valid results.
 Returned results might include stale or extraneous entries.
 

lookupSignal

public void lookupSignal(LookupSignalRequest request,
                         StreamObserver<Signal> responseObserver)

 Finds a signal by other unique IDs.
 

getSignal

public void getSignal(GetSignalRequest request,
                      StreamObserver<Signal> responseObserver)

 Returns a signal by name.
 

updateSignal

public void updateSignal(UpdateSignalRequest request,
                         StreamObserver<Signal> responseObserver)

 Updates an existing signal (for example, to assign/unassign it to an
 incident).
 

escalateIncident

public void escalateIncident(EscalateIncidentRequest request,
                             StreamObserver<EscalateIncidentResponse> responseObserver)

 Escalates an incident.
 

createArtifact

public void createArtifact(CreateArtifactRequest request,
                           StreamObserver<Artifact> responseObserver)

 Creates a new artifact.
 

listArtifacts

public void listArtifacts(ListArtifactsRequest request,
                          StreamObserver<ListArtifactsResponse> responseObserver)

 Returns a list of artifacts for an incident.
 

updateArtifact

public void updateArtifact(UpdateArtifactRequest request,
                           StreamObserver<Artifact> responseObserver)

 Updates an existing artifact.
 

deleteArtifact

public void deleteArtifact(DeleteArtifactRequest request,
                           StreamObserver<Empty> responseObserver)

 Deletes an existing artifact.
 

sendShiftHandoff

public void sendShiftHandoff(SendShiftHandoffRequest request,
                             StreamObserver<SendShiftHandoffResponse> responseObserver)

 Sends a summary of the shift for oncall handoff.
 

createSubscription

public void createSubscription(CreateSubscriptionRequest request,
                               StreamObserver<Subscription> responseObserver)

 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
 

updateSubscription

public void updateSubscription(UpdateSubscriptionRequest request,
                               StreamObserver<Subscription> responseObserver)

 Updates a subscription.
 

listSubscriptions

public void listSubscriptions(ListSubscriptionsRequest request,
                              StreamObserver<ListSubscriptionsResponse> responseObserver)

 Returns a list of subscriptions for an incident.
 

deleteSubscription

public void deleteSubscription(DeleteSubscriptionRequest request,
                               StreamObserver<Empty> responseObserver)

 Deletes an existing subscription.
 

createIncidentRoleAssignment

public void createIncidentRoleAssignment(CreateIncidentRoleAssignmentRequest request,
                                         StreamObserver<IncidentRoleAssignment> responseObserver)

 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.
 

deleteIncidentRoleAssignment

public void deleteIncidentRoleAssignment(DeleteIncidentRoleAssignmentRequest request,
                                         StreamObserver<Empty> responseObserver)

 Deletes an existing role assignment.
 

listIncidentRoleAssignments

public void listIncidentRoleAssignments(ListIncidentRoleAssignmentsRequest request,
                                        StreamObserver<ListIncidentRoleAssignmentsResponse> responseObserver)

 Lists role assignments that are part of an incident.
 

requestIncidentRoleHandover

public void requestIncidentRoleHandover(RequestIncidentRoleHandoverRequest request,
                                        StreamObserver<IncidentRoleAssignment> responseObserver)

 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.
 Handover to an oncall ladder is not permitted. Use
 CreateIncidentRoleAssignment instead.
 

confirmIncidentRoleHandover

public void confirmIncidentRoleHandover(ConfirmIncidentRoleHandoverRequest request,
                                        StreamObserver<IncidentRoleAssignment> responseObserver)

 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.
 

forceIncidentRoleHandover

public void forceIncidentRoleHandover(ForceIncidentRoleHandoverRequest request,
                                      StreamObserver<IncidentRoleAssignment> responseObserver)

 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.
 

cancelIncidentRoleHandover

public void cancelIncidentRoleHandover(CancelIncidentRoleHandoverRequest request,
                                       StreamObserver<IncidentRoleAssignment> responseObserver)

 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.