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

Class ListPipesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pipes.model.PipesRequest

software.amazon.awssdk.services.pipes.model.ListPipesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPipesRequest.Builder,ListPipesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListPipesRequest
extends PipesRequest
implements ToCopyableBuilder<ListPipesRequest.Builder,ListPipesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListPipesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListPipesRequest.Builder	builder()
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.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	limit()	The maximum number of pipes to include in the response.
String	namePrefix()	A value that will return a subset of the pipes associated with this account.
String	nextToken()	If nextToken is returned, there are more results available.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPipesRequest.Builder>	serializableBuilderClass()
String	sourcePrefix()	The prefix matching the pipe source.
String	targetPrefix()	The prefix matching the pipe target.
ListPipesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

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

limit

public final Integer limit()

The maximum number of pipes to include in the response.

Returns:

The maximum number of pipes to include in the response.

namePrefix

public final String namePrefix()

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

Returns:

A value that will return a subset of the pipes associated with this account. For example, "NamePrefix": "ABC" will return all endpoints with "ABC" in the name.

nextToken

public final String nextToken()

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Returns:

If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

sourcePrefix

public final String sourcePrefix()

The prefix matching the pipe source.

Returns:

The prefix matching the pipe source.

targetPrefix

public final String targetPrefix()

The prefix matching the pipe target.

Returns:

The prefix matching the pipe target.

toBuilder

public ListPipesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListPipesRequest.Builder,ListPipesRequest>

Specified by:

toBuilder in class PipesRequest

builder

public static ListPipesRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo