Class DescribeEvaluationsRequest

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.DescribeEvaluationsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeEvaluationsRequest.Builder,DescribeEvaluationsRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeEvaluationsRequest extends MachineLearningRequest implements ToCopyableBuilder<DescribeEvaluationsRequest.Builder,DescribeEvaluationsRequest>

  • Method Details

    • filterVariable

      public final EvaluationFilterVariable filterVariable()

      Use one of the following variable to filter a list of Evaluation objects:

      • CreatedAt - Sets the search criteria to the Evaluation creation date.

      • Status - Sets the search criteria to the Evaluation status.

      • Name - Sets the search criteria to the contents of Evaluation Name.

      • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.

      • MLModelId - Sets the search criteria to the MLModel that was evaluated.

      • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.

      • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

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

      Returns:
      Use one of the following variable to filter a list of Evaluation objects:

      • CreatedAt - Sets the search criteria to the Evaluation creation date.

      • Status - Sets the search criteria to the Evaluation status.

      • Name - Sets the search criteria to the contents of Evaluation Name.

      • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.

      • MLModelId - Sets the search criteria to the MLModel that was evaluated.

      • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.

      • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

      See Also:

    • filterVariableAsString

      public final String filterVariableAsString()

      Use one of the following variable to filter a list of Evaluation objects:

      • CreatedAt - Sets the search criteria to the Evaluation creation date.

      • Status - Sets the search criteria to the Evaluation status.

      • Name - Sets the search criteria to the contents of Evaluation Name.

      • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.

      • MLModelId - Sets the search criteria to the MLModel that was evaluated.

      • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.

      • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

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

      Returns:
      Use one of the following variable to filter a list of Evaluation objects:

      • CreatedAt - Sets the search criteria to the Evaluation creation date.

      • Status - Sets the search criteria to the Evaluation status.

      • Name - Sets the search criteria to the contents of Evaluation Name.

      • IAMUser - Sets the search criteria to the user account that invoked an Evaluation.

      • MLModelId - Sets the search criteria to the MLModel that was evaluated.

      • DataSourceId - Sets the search criteria to the DataSource used in Evaluation.

      • DataUri - Sets the search criteria to the data file(s) used in Evaluation. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.

      See Also:

    • eq

      public final String eq()

      The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

      Returns:
      The equal to operator. The Evaluation results will have FilterVariable values that exactly match the value specified with EQ.

    • gt

      public final String gt()

      The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

      Returns:
      The greater than operator. The Evaluation results will have FilterVariable values that are greater than the value specified with GT.

    • lt

      public final String lt()

      The less than operator. The Evaluation results will have FilterVariable values that are less than the value specified with LT.

      Returns:
      The less than operator. The Evaluation 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 Evaluation 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 Evaluation 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 Evaluation 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 Evaluation 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 Evaluation results will have FilterVariable values not equal to the value specified with NE.

      Returns:
      The not equal to operator. The Evaluation 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 Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, 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 Evaluation could have the Name 2014-09-09-HolidayGiftMailer. To search for this Evaluation, 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 Evaluation.

      • 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 Evaluation.

      • 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:

    • sortOrderAsString

      public final String sortOrderAsString()

      A two-value parameter that determines the sequence of the resulting list of Evaluation.

      • 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 Evaluation.

      • 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:

    • 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 maximum number of Evaluation to include in the result.

      Returns:
      The maximum number of Evaluation to include in the result.

    • toBuilder

      public DescribeEvaluationsRequest.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<DescribeEvaluationsRequest.Builder,DescribeEvaluationsRequest>
      Specified by:
      toBuilder in class MachineLearningRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeEvaluationsRequest.Builder builder()

    • serializableBuilderClass

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