Package com.atlassian.bamboo.cluster.event.bamboo.plan

Class HidePlanEvent

java.lang.Object

com.atlassian.bamboo.cluster.event.AbstractCrossNodesEvent<R,BambooCrossNodesEventsServiceGrpc.BambooCrossNodesEventsServiceStub>

com.atlassian.bamboo.cluster.event.bamboo.BambooCrossNodesEvent<CrossNodesCommunication.HidePlanRequest>

com.atlassian.bamboo.cluster.event.bamboo.plan.HidePlanEvent

All Implemented Interfaces:

CrossNodesEvent, CrossNodesInvalidationEvent, Serializable

public final class HidePlanEvent
extends BambooCrossNodesEvent<CrossNodesCommunication.HidePlanRequest>
implements CrossNodesInvalidationEvent, Serializable

Data holder for plan hiding cache invalidation event.

Since:

9.5

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.cluster.event.CrossNodesEvent

CrossNodesEvent.Type

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@NotNull CrossNodesEvent.Type	getType()	Returns the type of the event.
int	hashCode()	Returns a hash code value for the object.
boolean	isEmpty()	Returns whether the event is empty.
static HidePlanEvent	of(@NotNull PlanKey planKey)
void	send(@NotNull BambooCrossNodesEventsServiceGrpc.BambooCrossNodesEventsServiceStub stub, @NotNull MetadataInfo metadataInfo, @NotNull io.grpc.stub.StreamObserver<CrossNodesCommunication.CommonResponse> responseObserver)	Sends a gRPC request using the event specific data, provided stub and metadata information, and observes the response.
CrossNodesCommunication.HidePlanRequest	toGrpcRequestMessage(@NotNull MetadataInfo metadataInfo)	Converts event specific data and provided metadata information into the corresponding gRPC request message.
@NotNull String	toString()	Returns a string representation of the object.

Methods inherited from class com.atlassian.bamboo.cluster.event.bamboo.BambooCrossNodesEvent

getStubClass

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bamboo.cluster.event.CrossNodesEvent

isNotEmpty

Method Details

of

public static HidePlanEvent of(@NotNull
 @NotNull PlanKey planKey)

getType

@NotNull
public @NotNull CrossNodesEvent.Type getType()

Description copied from interface: CrossNodesEvent

Returns the type of the event.

Specified by:

getType in interface CrossNodesEvent

Returns:

the type of the event

isEmpty

public boolean isEmpty()

Description copied from interface: CrossNodesEvent

Returns whether the event is empty. May be needed to avoid sending empty events.

Specified by:

isEmpty in interface CrossNodesEvent

Returns:

true if the event is empty, false otherwise.

toString

@NotNull
public @NotNull String toString()

Description copied from interface: CrossNodesEvent

Returns a string representation of the object.

Specified by:

toString in interface CrossNodesEvent

Overrides:

toString in class Object

Returns:

a string representation of the object

equals

public boolean equals(Object o)

Description copied from interface: CrossNodesEvent

Indicates whether some other object is "equal to" this one.

Specified by:

equals in interface CrossNodesEvent

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare

Returns:

true if this object is the same as the obj argument; false otherwise

hashCode

public int hashCode()

Description copied from interface: CrossNodesEvent

Returns a hash code value for the object.

Specified by:

hashCode in interface CrossNodesEvent

Overrides:

hashCode in class Object

Returns:

a hash code value for this object

toGrpcRequestMessage

@NotNull
public CrossNodesCommunication.HidePlanRequest toGrpcRequestMessage(@NotNull
 @NotNull MetadataInfo metadataInfo)

Description copied from class: AbstractCrossNodesEvent

Converts event specific data and provided metadata information into the corresponding gRPC request message.

Specified by:

toGrpcRequestMessage in class AbstractCrossNodesEvent<CrossNodesCommunication.HidePlanRequest,BambooCrossNodesEventsServiceGrpc.BambooCrossNodesEventsServiceStub>

Parameters:

metadataInfo - Metadata information to be used.

Returns:

The gRPC request message

send

public void send(@NotNull BambooCrossNodesEventsServiceGrpc.BambooCrossNodesEventsServiceStub stub,
 @NotNull
 @NotNull MetadataInfo metadataInfo,
 @NotNull
 @NotNull io.grpc.stub.StreamObserver<CrossNodesCommunication.CommonResponse> responseObserver)

Description copied from class: AbstractCrossNodesEvent

Sends a gRPC request using the event specific data, provided stub and metadata information, and observes the response.

Specified by:

send in class AbstractCrossNodesEvent<CrossNodesCommunication.HidePlanRequest,BambooCrossNodesEventsServiceGrpc.BambooCrossNodesEventsServiceStub>

Parameters:

stub - The gRPC stub instance used to send the request.

metadataInfo - Metadata information associated with the request.

responseObserver - Observer for handling responses from the server.