software.amazon.awssdk.services.sagemaker.model

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(value="software.amazon.awssdk:codegen")
public final class ListMonitoringExecutionsRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListMonitoringExecutionsRequest.Builder,ListMonitoringExecutionsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListMonitoringExecutionsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListMonitoringExecutionsRequest.Builder	builder()
Instant	creationTimeAfter() A filter that returns only jobs created after a specified time.
Instant	creationTimeBefore() A filter that returns only jobs created before a specified time.
String	endpointName() Name of a specific endpoint to fetch jobs for.
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 jobs modified before a specified time.
Instant	lastModifiedTimeBefore() A filter that returns only jobs modified after a specified time.
Integer	maxResults() The maximum number of jobs to return in the response.
String	monitoringJobDefinitionName() Gets a list of the monitoring job runs of the specified monitoring job definitions.
String	monitoringScheduleName() Name of a specific schedule to fetch jobs for.
MonitoringType	monitoringTypeEquals() A filter that returns only the monitoring job runs of the specified monitoring type.
String	monitoringTypeEqualsAsString() A filter that returns only the monitoring job runs of the specified monitoring type.
String	nextToken() The token returned if the response is truncated.
Instant	scheduledTimeAfter() Filter for jobs scheduled after a specified time.
Instant	scheduledTimeBefore() Filter for jobs scheduled before a specified time.
List<SdkField<?>>	sdkFields()
static Class<? extends ListMonitoringExecutionsRequest.Builder>	serializableBuilderClass()
MonitoringExecutionSortKey	sortBy() Whether to sort results by Status, CreationTime, ScheduledTime field.
String	sortByAsString() Whether to sort results by Status, CreationTime, ScheduledTime field.
SortOrder	sortOrder() Whether to sort the results in Ascending or Descending order.
String	sortOrderAsString() Whether to sort the results in Ascending or Descending order.
ExecutionStatus	statusEquals() A filter that retrieves only jobs with a specific status.
String	statusEqualsAsString() A filter that retrieves only jobs with a specific status.
ListMonitoringExecutionsRequest.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

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 results by Status, CreationTime, 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 results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

See Also:

MonitoringExecutionSortKey

sortByAsString

public final String sortByAsString()

Whether to sort results by Status, CreationTime, 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 results by Status, CreationTime, ScheduledTime field. The default is CreationTime.

See Also:

MonitoringExecutionSortKey

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:

SortOrder

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:

SortOrder

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:

ExecutionStatus

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:

ExecutionStatus

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:

MonitoringType

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:

MonitoringType

toBuilder

public ListMonitoringExecutionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListMonitoringExecutionsRequest.Builder,ListMonitoringExecutionsRequest>

Specified by:

toBuilder in class SageMakerRequest

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)

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