software.amazon.awssdk.services.sagemaker.model

Class ListPipelinesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.ListPipelinesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListPipelinesRequest.Builder,ListPipelinesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class ListPipelinesRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListPipelinesRequest.Builder,ListPipelinesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListPipelinesRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListPipelinesRequest.Builder	builder()
Instant	createdAfter() A filter that returns the pipelines that were created after a specified time.
Instant	createdBefore() A filter that returns the pipelines that were created before a specified time.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
Integer	maxResults() The maximum number of pipelines to return in the response.
String	nextToken() If the result of the previous ListPipelines request was truncated, the response includes a NextToken.
String	pipelineNamePrefix() The prefix of the pipeline name.
List<SdkField<?>>	sdkFields()
static Class<? extends ListPipelinesRequest.Builder>	serializableBuilderClass()
SortPipelinesBy	sortBy() The field by which to sort results.
String	sortByAsString() The field by which to sort results.
SortOrder	sortOrder() The sort order for results.
String	sortOrderAsString() The sort order for results.
ListPipelinesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

pipelineNamePrefix

public final String pipelineNamePrefix()

The prefix of the pipeline name.

Returns:

The prefix of the pipeline name.

createdAfter

public final Instant createdAfter()

A filter that returns the pipelines that were created after a specified time.

Returns:

A filter that returns the pipelines that were created after a specified time.

createdBefore

public final Instant createdBefore()

A filter that returns the pipelines that were created before a specified time.

Returns:

A filter that returns the pipelines that were created before a specified time.

sortBy

public final SortPipelinesBy sortBy()

The field by which to sort results. The default is CreatedTime.

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

Returns:

The field by which to sort results. The default is CreatedTime.

See Also:

SortPipelinesBy

sortByAsString

public final String sortByAsString()

The field by which to sort results. The default is CreatedTime.

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

Returns:

The field by which to sort results. The default is CreatedTime.

See Also:

SortPipelinesBy

sortOrder

public final SortOrder sortOrder()

The sort order for results.

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

Returns:

The sort order for results.

See Also:

SortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order for results.

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

Returns:

The sort order for results.

See Also:

SortOrder

nextToken

public final String nextToken()

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

Returns:

If the result of the previous ListPipelines request was truncated, the response includes a NextToken. To retrieve the next set of pipelines, use the token in the next request.

maxResults

public final Integer maxResults()

The maximum number of pipelines to return in the response.

Returns:

The maximum number of pipelines to return in the response.

toBuilder

public ListPipelinesRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ListPipelinesRequest.Builder,ListPipelinesRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static ListPipelinesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListPipelinesRequest.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.