java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.machinelearning.model.MachineLearningRequest
    - - software.amazon.awssdk.services.machinelearning.model.DescribeMlModelsRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeMlModelsRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeMlModelsRequest.Builder`	`builder()`
`String`	`eq()`	The equal to operator.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`MLModelFilterVariable`	`filterVariable()`	Use one of the following variables to filter a list of `MLModel`:
`String`	`filterVariableAsString()`	Use one of the following variables to filter a list of `MLModel`:
`String`	`ge()`	The greater than or equal to operator.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`gt()`	The greater than operator.
`int`	`hashCode()`
`String`	`le()`	The less than or equal to operator.
`Integer`	`limit()`	The number of pages of information to include in the result.
`String`	`lt()`	The less than operator.
`String`	`ne()`	The not equal to operator.
`String`	`nextToken()`	The ID of the page in the paginated results.
`String`	`prefix()`	A string that is found at the beginning of a variable, such as `Name` or `Id`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeMlModelsRequest.Builder>`	`serializableBuilderClass()`
`SortOrder`	`sortOrder()`	A two-value parameter that determines the sequence of the resulting list of `MLModel`.
`String`	`sortOrderAsString()`	A two-value parameter that determines the sequence of the resulting list of `MLModel`.
`DescribeMlModelsRequest.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
  - filterVariable
```
public final MLModelFilterVariable filterVariable()
```
    Use one of the following variables to filter a list of MLModel:
    
    CreatedAt - Sets the search criteria to MLModel creation date.
    
    Status - Sets the search criteria to MLModel status.
    
    Name - Sets the search criteria to the contents of MLModel Name.
    
    IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
    
    TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
    
    RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
    
    MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
    
    Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
    
    TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    
    If the service returns an enum value that is not available in the current SDK version, filterVariable will return MLModelFilterVariable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterVariableAsString().
    Returns:
    
    Use one of the following variables to filter a list of MLModel:
    
    CreatedAt - Sets the search criteria to MLModel creation date.
    
    Status - Sets the search criteria to MLModel status.
    
    Name - Sets the search criteria to the contents of MLModel Name.
    
    IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
    
    TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
    
    RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
    
    MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
    
    Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
    
    TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    
    See Also:
    
    MLModelFilterVariable
  - filterVariableAsString
```
public final String filterVariableAsString()
```
    Use one of the following variables to filter a list of MLModel:
    
    CreatedAt - Sets the search criteria to MLModel creation date.
    
    Status - Sets the search criteria to MLModel status.
    
    Name - Sets the search criteria to the contents of MLModel Name.
    
    IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
    
    TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
    
    RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
    
    MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
    
    Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
    
    TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    
    If the service returns an enum value that is not available in the current SDK version, filterVariable will return MLModelFilterVariable.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from filterVariableAsString().
    Returns:
    
    Use one of the following variables to filter a list of MLModel:
    
    CreatedAt - Sets the search criteria to MLModel creation date.
    
    Status - Sets the search criteria to MLModel status.
    
    Name - Sets the search criteria to the contents of MLModel Name.
    
    IAMUser - Sets the search criteria to the user account that invoked the MLModel creation.
    
    TrainingDataSourceId - Sets the search criteria to the DataSource used to train one or more MLModel.
    
    RealtimeEndpointStatus - Sets the search criteria to the MLModel real-time endpoint status.
    
    MLModelType - Sets the search criteria to MLModel type: binary, regression, or multi-class.
    
    Algorithm - Sets the search criteria to the algorithm that the MLModel uses.
    
    TrainingDataURI - Sets the search criteria to the data file(s) used in training a MLModel. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.
    
    See Also:
    
    MLModelFilterVariable
  - eq
```
public final String eq()
```
    The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.
    
    Returns:
    
    The equal to operator. The MLModel results will have FilterVariable values that exactly match the value specified with EQ.
  - gt
```
public final String gt()
```
    The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.
    
    Returns:
    
    The greater than operator. The MLModel results will have FilterVariable values that are greater than the value specified with GT.
  - lt
```
public final String lt()
```
    The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.
    
    Returns:
    
    The less than operator. The MLModel results will have FilterVariable values that are less than the value specified with LT.
  - ge
```
public final String ge()
```
    The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.
    
    Returns:
    
    The greater than or equal to operator. The MLModel results will have FilterVariable values that are greater than or equal to the value specified with GE.
  - le
```
public final String le()
```
    The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.
    
    Returns:
    
    The less than or equal to operator. The MLModel results will have FilterVariable values that are less than or equal to the value specified with LE.
  - ne
```
public final String ne()
```
    The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.
    
    Returns:
    
    The not equal to operator. The MLModel results will have FilterVariable values not equal to the value specified with NE.
  - prefix
```
public final String prefix()
```
    A string that is found at the beginning of a variable, such as Name or Id.
    
    For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
    
    2014-09
    
    2014-09-09
    
    2014-09-09-Holiday
    Returns:
    
    A string that is found at the beginning of a variable, such as Name or Id.
    
    For example, an MLModel could have the Name 2014-09-09-HolidayGiftMailer. To search for this MLModel, select Name for the FilterVariable and any of the following strings for the Prefix:
    
    2014-09
    
    2014-09-09
    
    2014-09-09-Holiday
  - sortOrder
```
public final SortOrder sortOrder()
```
    A two-value parameter that determines the sequence of the resulting list of MLModel.
    
    asc - Arranges the list in ascending order (A-Z, 0-9).
    
    dsc - Arranges the list in descending order (Z-A, 9-0).
    
    Results are sorted by FilterVariable.
    
    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:
    
    A two-value parameter that determines the sequence of the resulting list of MLModel.
    
    asc - Arranges the list in ascending order (A-Z, 0-9).
    
    dsc - Arranges the list in descending order (Z-A, 9-0).
    
    Results are sorted by FilterVariable.
    
    See Also:
    
    SortOrder
  - sortOrderAsString
```
public final String sortOrderAsString()
```
    A two-value parameter that determines the sequence of the resulting list of MLModel.
    
    asc - Arranges the list in ascending order (A-Z, 0-9).
    
    dsc - Arranges the list in descending order (Z-A, 9-0).
    
    Results are sorted by FilterVariable.
    
    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:
    
    A two-value parameter that determines the sequence of the resulting list of MLModel.
    
    asc - Arranges the list in ascending order (A-Z, 0-9).
    
    dsc - Arranges the list in descending order (Z-A, 9-0).
    
    Results are sorted by FilterVariable.
    
    See Also:
    
    SortOrder
  - nextToken
```
public final String nextToken()
```
    The ID of the page in the paginated results.
    
    Returns:
    
    The ID of the page in the paginated results.
  - limit
```
public final Integer limit()
```
    The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
    
    Returns:
    
    The number of pages of information to include in the result. The range of acceptable values is 1 through 100. The default value is 100.
  - toBuilder
```
public DescribeMlModelsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeMlModelsRequest.Builder,DescribeMlModelsRequest>
    
    Specified by:
    
    toBuilder in class MachineLearningRequest
  - builder
```
public static DescribeMlModelsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeMlModelsRequest.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 DescribeMlModelsRequest

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

filterVariable

filterVariableAsString

eq

gt

lt

ge

le

ne

prefix

sortOrder

sortOrderAsString

nextToken

limit

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields