ListContextsRequest (AWS Java SDK :: Services :: Amazon SageMaker 2.20.27 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.ListContextsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListContextsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListContextsRequest.Builder`	`builder()`
`String`	`contextType()` A filter that returns only contexts of the specified type.
`Instant`	`createdAfter()` A filter that returns only contexts created on or after the specified time.
`Instant`	`createdBefore()` A filter that returns only contexts 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()`
`Integer`	`maxResults()` The maximum number of contexts to return in the response.
`String`	`nextToken()` If the previous call to `ListContexts` didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListContextsRequest.Builder>`	`serializableBuilderClass()`
`SortContextsBy`	`sortBy()` The property used to sort results.
`String`	`sortByAsString()` The property used to sort results.
`SortOrder`	`sortOrder()` The sort order.
`String`	`sortOrderAsString()` The sort order.
`String`	`sourceUri()` A filter that returns only contexts with the specified source URI.
`ListContextsRequest.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
  - sourceUri
```
public final String sourceUri()
```
    A filter that returns only contexts with the specified source URI.
    
    Returns:
    
    A filter that returns only contexts with the specified source URI.
  - contextType
```
public final String contextType()
```
    A filter that returns only contexts of the specified type.
    
    Returns:
    
    A filter that returns only contexts of the specified type.
  - createdAfter
```
public final Instant createdAfter()
```
    A filter that returns only contexts created on or after the specified time.
    
    Returns:
    
    A filter that returns only contexts created on or after the specified time.
  - createdBefore
```
public final Instant createdBefore()
```
    A filter that returns only contexts created on or before the specified time.
    
    Returns:
    
    A filter that returns only contexts created on or before the specified time.
  - sortBy
```
public final SortContextsBy sortBy()
```
    The property used to sort results. The default value is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortContextsBy.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 CreationTime.
    
    See Also:
    
    SortContextsBy
  - sortByAsString
```
public final String sortByAsString()
```
    The property used to sort results. The default value is CreationTime.
    
    If the service returns an enum value that is not available in the current SDK version, sortBy will return SortContextsBy.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 CreationTime.
    
    See Also:
    
    SortContextsBy
  - sortOrder
```
public final SortOrder 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 SortOrder.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:
    
    SortOrder
  - sortOrderAsString
```
public final 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 SortOrder.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:
    
    SortOrder
  - nextToken
```
public final String nextToken()
```
    If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
    
    Returns:
    
    If the previous call to ListContexts didn't return the full set of contexts, the call returns a token for getting the next set of contexts.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of contexts to return in the response. The default value is 10.
    
    Returns:
    
    The maximum number of contexts to return in the response. The default value is 10.
  - toBuilder
```
public ListContextsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListContextsRequest.Builder,ListContextsRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static ListContextsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListContextsRequest.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

Class ListContextsRequest

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

sourceUri

contextType

createdAfter

createdBefore

sortBy

sortByAsString

sortOrder

sortOrderAsString

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields