Package software.amazon.awssdk.services.pipes.model

Class Pipe

java.lang.Object

software.amazon.awssdk.services.pipes.model.Pipe

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Pipe.Builder,Pipe>

@Generated("software.amazon.awssdk:codegen")
public final class Pipe
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Pipe.Builder,Pipe>

An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Pipe.Builder

Method Summary

Modifier and Type	Method	Description
String	arn()	The ARN of the pipe.
static Pipe.Builder	builder()
Instant	creationTime()	The time the pipe was created.
PipeState	currentState()	The state the pipe is in.
String	currentStateAsString()	The state the pipe is in.
RequestedPipeState	desiredState()	The state the pipe should be in.
String	desiredStateAsString()	The state the pipe should be in.
String	enrichment()	The ARN of the enrichment resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime()	When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
String	name()	The name of the pipe.
List<SdkField<?>>	sdkFields()
static Class<? extends Pipe.Builder>	serializableBuilderClass()
String	source()	The ARN of the source resource.
String	stateReason()	The reason the pipe is in its current state.
String	target()	The ARN of the target resource.
Pipe.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

arn

public final String arn()

The ARN of the pipe.

Returns:

The ARN of the pipe.

creationTime

public final Instant creationTime()

The time the pipe was created.

Returns:

The time the pipe was created.

currentState

public final PipeState currentState()

The state the pipe is in.

If the service returns an enum value that is not available in the current SDK version, currentState will return PipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentStateAsString().

Returns:

The state the pipe is in.

See Also:

PipeState

currentStateAsString

public final String currentStateAsString()

The state the pipe is in.

If the service returns an enum value that is not available in the current SDK version, currentState will return PipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from currentStateAsString().

Returns:

The state the pipe is in.

See Also:

PipeState

desiredState

public final RequestedPipeState desiredState()

The state the pipe should be in.

If the service returns an enum value that is not available in the current SDK version, desiredState will return RequestedPipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

The state the pipe should be in.

See Also:

RequestedPipeState

desiredStateAsString

public final String desiredStateAsString()

The state the pipe should be in.

If the service returns an enum value that is not available in the current SDK version, desiredState will return RequestedPipeState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from desiredStateAsString().

Returns:

The state the pipe should be in.

See Also:

RequestedPipeState

enrichment

public final String enrichment()

The ARN of the enrichment resource.

Returns:

The ARN of the enrichment resource.

lastModifiedTime

public final Instant lastModifiedTime()

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

Returns:

When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).

name

public final String name()

The name of the pipe.

Returns:

The name of the pipe.

source

public final String source()

The ARN of the source resource.

Returns:

The ARN of the source resource.

stateReason

public final String stateReason()

The reason the pipe is in its current state.

Returns:

The reason the pipe is in its current state.

target

public final String target()

The ARN of the target resource.

Returns:

The ARN of the target resource.

toBuilder

public Pipe.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Pipe.Builder,Pipe>

builder

public static Pipe.Builder builder()

serializableBuilderClass

public static Class<? extends Pipe.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo