com.google.irm.service.v1alpha2.api

Class IncidentServiceGrpc.IncidentServiceFutureStub

java.lang.Object

io.grpc.stub.AbstractStub<S>

io.grpc.stub.AbstractFutureStub<IncidentServiceGrpc.IncidentServiceFutureStub>

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

Enclosing class:

IncidentServiceGrpc

public static final class IncidentServiceGrpc.IncidentServiceFutureStub
extends AbstractFutureStub<IncidentServiceGrpc.IncidentServiceFutureStub>

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

Methods inherited from class io.grpc.stub.AbstractFutureStub

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.IncidentServiceFutureStub build(Channel channel,
                                                              CallOptions callOptions)

Specified by:

build in class AbstractStub<IncidentServiceGrpc.IncidentServiceFutureStub>

createIncident

public com.google.common.util.concurrent.ListenableFuture<Incident> createIncident(CreateIncidentRequest request)

 Creates a new incident.
 

getIncident

public com.google.common.util.concurrent.ListenableFuture<Incident> getIncident(GetIncidentRequest request)

 Returns an incident by name.
 

searchIncidents

public com.google.common.util.concurrent.ListenableFuture<SearchIncidentsResponse> searchIncidents(SearchIncidentsRequest request)

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

updateIncident

public com.google.common.util.concurrent.ListenableFuture<Incident> updateIncident(UpdateIncidentRequest request)

 Updates an existing incident.
 

searchSimilarIncidents

public com.google.common.util.concurrent.ListenableFuture<SearchSimilarIncidentsResponse> searchSimilarIncidents(SearchSimilarIncidentsRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<Annotation> createAnnotation(CreateAnnotationRequest request)

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

listAnnotations

public com.google.common.util.concurrent.ListenableFuture<ListAnnotationsResponse> listAnnotations(ListAnnotationsRequest request)

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

createTag

public com.google.common.util.concurrent.ListenableFuture<Tag> createTag(CreateTagRequest request)

 Creates a tag on an existing incident.
 

deleteTag

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteTag(DeleteTagRequest request)

 Deletes an existing tag.
 

listTags

public com.google.common.util.concurrent.ListenableFuture<ListTagsResponse> listTags(ListTagsRequest request)

 Lists tags that are part of an incident.
 

createSignal

public com.google.common.util.concurrent.ListenableFuture<Signal> createSignal(CreateSignalRequest request)

 Creates a new signal.
 

searchSignals

public com.google.common.util.concurrent.ListenableFuture<SearchSignalsResponse> searchSignals(SearchSignalsRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<Signal> lookupSignal(LookupSignalRequest request)

 Finds a signal by other unique IDs.
 

getSignal

public com.google.common.util.concurrent.ListenableFuture<Signal> getSignal(GetSignalRequest request)

 Returns a signal by name.
 

updateSignal

public com.google.common.util.concurrent.ListenableFuture<Signal> updateSignal(UpdateSignalRequest request)

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

escalateIncident

public com.google.common.util.concurrent.ListenableFuture<EscalateIncidentResponse> escalateIncident(EscalateIncidentRequest request)

 Escalates an incident.
 

createArtifact

public com.google.common.util.concurrent.ListenableFuture<Artifact> createArtifact(CreateArtifactRequest request)

 Creates a new artifact.
 

listArtifacts

public com.google.common.util.concurrent.ListenableFuture<ListArtifactsResponse> listArtifacts(ListArtifactsRequest request)

 Returns a list of artifacts for an incident.
 

updateArtifact

public com.google.common.util.concurrent.ListenableFuture<Artifact> updateArtifact(UpdateArtifactRequest request)

 Updates an existing artifact.
 

deleteArtifact

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteArtifact(DeleteArtifactRequest request)

 Deletes an existing artifact.
 

sendShiftHandoff

public com.google.common.util.concurrent.ListenableFuture<SendShiftHandoffResponse> sendShiftHandoff(SendShiftHandoffRequest request)

 Sends a summary of the shift for oncall handoff.
 

createSubscription

public com.google.common.util.concurrent.ListenableFuture<Subscription> createSubscription(CreateSubscriptionRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<Subscription> updateSubscription(UpdateSubscriptionRequest request)

 Updates a subscription.
 

listSubscriptions

public com.google.common.util.concurrent.ListenableFuture<ListSubscriptionsResponse> listSubscriptions(ListSubscriptionsRequest request)

 Returns a list of subscriptions for an incident.
 

deleteSubscription

public com.google.common.util.concurrent.ListenableFuture<Empty> deleteSubscription(DeleteSubscriptionRequest request)

 Deletes an existing subscription.
 

createIncidentRoleAssignment

public com.google.common.util.concurrent.ListenableFuture<IncidentRoleAssignment> createIncidentRoleAssignment(CreateIncidentRoleAssignmentRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<Empty> deleteIncidentRoleAssignment(DeleteIncidentRoleAssignmentRequest request)

 Deletes an existing role assignment.
 

listIncidentRoleAssignments

public com.google.common.util.concurrent.ListenableFuture<ListIncidentRoleAssignmentsResponse> listIncidentRoleAssignments(ListIncidentRoleAssignmentsRequest request)

 Lists role assignments that are part of an incident.
 

requestIncidentRoleHandover

public com.google.common.util.concurrent.ListenableFuture<IncidentRoleAssignment> requestIncidentRoleHandover(RequestIncidentRoleHandoverRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<IncidentRoleAssignment> confirmIncidentRoleHandover(ConfirmIncidentRoleHandoverRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<IncidentRoleAssignment> forceIncidentRoleHandover(ForceIncidentRoleHandoverRequest request)

 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 com.google.common.util.concurrent.ListenableFuture<IncidentRoleAssignment> cancelIncidentRoleHandover(CancelIncidentRoleHandoverRequest request)

 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.