ListImagesRequest (AWS Java SDK :: Services :: Amazon SageMaker 2.15.45 API)

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.ListImagesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListImagesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListImagesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListImagesRequest.Builder`	`builder()`
`Instant`	`creationTimeAfter()` A filter that returns only images created on or after the specified time.
`Instant`	`creationTimeBefore()` A filter that returns only images created on or before the specified time.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastModifiedTimeAfter()` A filter that returns only images modified on or after the specified time.
`Instant`	`lastModifiedTimeBefore()` A filter that returns only images modified on or before the specified time.
`Integer`	`maxResults()` The maximum number of images to return in the response.
`String`	`nameContains()` A filter that returns only images whose name contains the specified string.
`String`	`nextToken()` If the previous call to `ListImages` didn't return the full set of images, the call returns a token for getting the next set of images.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListImagesRequest.Builder>`	`serializableBuilderClass()`
`ImageSortBy`	`sortBy()` The property used to sort results.
`String`	`sortByAsString()` The property used to sort results.
`ImageSortOrder`	`sortOrder()` The sort order.
`String`	`sortOrderAsString()` The sort order.
`ListImagesRequest.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
  - creationTimeAfter
```
public Instant creationTimeAfter()
```
    A filter that returns only images created on or after the specified time.
    
    Returns:
    
    A filter that returns only images created on or after the specified time.
  - creationTimeBefore
```
public Instant creationTimeBefore()
```
    A filter that returns only images created on or before the specified time.
    
    Returns:
    
    A filter that returns only images created on or before the specified time.
  - lastModifiedTimeAfter
```
public Instant lastModifiedTimeAfter()
```
    A filter that returns only images modified on or after the specified time.
    
    Returns:
    
    A filter that returns only images modified on or after the specified time.
  - lastModifiedTimeBefore
```
public Instant lastModifiedTimeBefore()
```
    A filter that returns only images modified on or before the specified time.
    
    Returns:
    
    A filter that returns only images modified on or before the specified time.
  - maxResults
```
public Integer maxResults()
```
    The maximum number of images to return in the response. The default value is 10.
    
    Returns:
    
    The maximum number of images to return in the response. The default value is 10.
  - nameContains
```
public String nameContains()
```
    A filter that returns only images whose name contains the specified string.
    
    Returns:
    
    A filter that returns only images whose name contains the specified string.
  - nextToken
```
public String nextToken()
```
    If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
    
    Returns:
    
    If the previous call to ListImages didn't return the full set of images, the call returns a token for getting the next set of images.
  - sortBy
```
public ImageSortBy sortBy()
```
    The property used to sort results. The default value is CREATION_TIME.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ImageSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The property used to sort results. The default value is CREATION_TIME.
    
    See Also:
    
    ImageSortBy
  - sortByAsString
```
public String sortByAsString()
```
    The property used to sort results. The default value is CREATION_TIME.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return ImageSortBy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().
    
    Returns:
    
    The property used to sort results. The default value is CREATION_TIME.
    
    See Also:
    
    ImageSortBy
  - sortOrder
```
public ImageSortOrder sortOrder()
```
    The sort order. The default value is DESCENDING.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return ImageSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The sort order. The default value is DESCENDING.
    
    See Also:
    
    ImageSortOrder
  - sortOrderAsString
```
public String sortOrderAsString()
```
    The sort order. The default value is DESCENDING.
    
    If the service returns an enum value that is not available in the current SDK version, sortOrder will return ImageSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().
    
    Returns:
    
    The sort order. The default value is DESCENDING.
    
    See Also:
    
    ImageSortOrder
  - toBuilder
```
public ListImagesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListImagesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListImagesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class ListImagesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

creationTimeAfter

creationTimeBefore

lastModifiedTimeAfter

lastModifiedTimeBefore

maxResults

nameContains

nextToken

sortBy

sortByAsString

sortOrder

sortOrderAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields