Class ListMonitoringExecutionsRequest

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

  • Method Details

    • monitoringScheduleName

      public final String monitoringScheduleName()

      Name of a specific schedule to fetch jobs for.

      Returns:
      Name of a specific schedule to fetch jobs for.

    • endpointName

      public final String endpointName()

      Name of a specific endpoint to fetch jobs for.

      Returns:
      Name of a specific endpoint to fetch jobs for.

    • sortBy

      public final MonitoringExecutionSortKey sortBy()

      Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

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

      Returns:
      Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
      See Also:

    • sortByAsString

      public final String sortByAsString()

      Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.

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

      Returns:
      Whether to sort the results by the Status, CreationTime, or ScheduledTime field. The default is CreationTime.
      See Also:

    • sortOrder

      public final SortOrder sortOrder()

      Whether to sort the results in Ascending or Descending order. The default 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:
      Whether to sort the results in Ascending or Descending order. The default is Descending.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Whether to sort the results in Ascending or Descending order. The default 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:
      Whether to sort the results in Ascending or Descending order. The default is Descending.
      See Also:

    • nextToken

      public final String nextToken()

      The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

      Returns:
      The token returned if the response is truncated. To retrieve the next set of job executions, use it in the next request.

    • maxResults

      public final Integer maxResults()

      The maximum number of jobs to return in the response. The default value is 10.

      Returns:
      The maximum number of jobs to return in the response. The default value is 10.

    • scheduledTimeBefore

      public final Instant scheduledTimeBefore()

      Filter for jobs scheduled before a specified time.

      Returns:
      Filter for jobs scheduled before a specified time.

    • scheduledTimeAfter

      public final Instant scheduledTimeAfter()

      Filter for jobs scheduled after a specified time.

      Returns:
      Filter for jobs scheduled after a specified time.

    • creationTimeBefore

      public final Instant creationTimeBefore()

      A filter that returns only jobs created before a specified time.

      Returns:
      A filter that returns only jobs created before a specified time.

    • creationTimeAfter

      public final Instant creationTimeAfter()

      A filter that returns only jobs created after a specified time.

      Returns:
      A filter that returns only jobs created after a specified time.

    • lastModifiedTimeBefore

      public final Instant lastModifiedTimeBefore()

      A filter that returns only jobs modified after a specified time.

      Returns:
      A filter that returns only jobs modified after a specified time.

    • lastModifiedTimeAfter

      public final Instant lastModifiedTimeAfter()

      A filter that returns only jobs modified before a specified time.

      Returns:
      A filter that returns only jobs modified before a specified time.

    • statusEquals

      public final ExecutionStatus statusEquals()

      A filter that retrieves only jobs with a specific status.

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

      Returns:
      A filter that retrieves only jobs with a specific status.
      See Also:

    • statusEqualsAsString

      public final String statusEqualsAsString()

      A filter that retrieves only jobs with a specific status.

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

      Returns:
      A filter that retrieves only jobs with a specific status.
      See Also:

    • monitoringJobDefinitionName

      public final String monitoringJobDefinitionName()

      Gets a list of the monitoring job runs of the specified monitoring job definitions.

      Returns:
      Gets a list of the monitoring job runs of the specified monitoring job definitions.

    • monitoringTypeEquals

      public final MonitoringType monitoringTypeEquals()

      A filter that returns only the monitoring job runs of the specified monitoring type.

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

      Returns:
      A filter that returns only the monitoring job runs of the specified monitoring type.
      See Also:

    • monitoringTypeEqualsAsString

      public final String monitoringTypeEqualsAsString()

      A filter that returns only the monitoring job runs of the specified monitoring type.

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

      Returns:
      A filter that returns only the monitoring job runs of the specified monitoring type.
      See Also:

    • toBuilder

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

    • builder

      public static ListMonitoringExecutionsRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.