Package software.amazon.awssdk.services.sagemaker.model

Class InferenceExperimentSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.InferenceExperimentSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<InferenceExperimentSummary.Builder,InferenceExperimentSummary>

@Generated("software.amazon.awssdk:codegen")
public final class InferenceExperimentSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<InferenceExperimentSummary.Builder,InferenceExperimentSummary>

Lists a summary of properties of an inference experiment.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	InferenceExperimentSummary.Builder

Method Summary

Modifier and Type	Method	Description
static InferenceExperimentSummary.Builder	builder()
Instant	completionTime()	The timestamp at which the inference experiment was completed.
Instant	creationTime()	The timestamp at which the inference experiment was created.
String	description()	The description of the inference experiment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTime()	The timestamp when you last modified the inference experiment.
String	name()	The name of the inference experiment.
String	roleArn()	The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.
InferenceExperimentSchedule	schedule()	The duration for which the inference experiment ran or will run.
List<SdkField<?>>	sdkFields()
static Class<? extends InferenceExperimentSummary.Builder>	serializableBuilderClass()
InferenceExperimentStatus	status()	The status of the inference experiment.
String	statusAsString()	The status of the inference experiment.
String	statusReason()	The error message for the inference experiment status result.
InferenceExperimentSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
InferenceExperimentType	type()	The type of the inference experiment.
String	typeAsString()	The type of the inference experiment.

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

name

public final String name()

The name of the inference experiment.

Returns:

The name of the inference experiment.

type

public final InferenceExperimentType type()

The type of the inference experiment.

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

Returns:

The type of the inference experiment.

See Also:

InferenceExperimentType

typeAsString

public final String typeAsString()

The type of the inference experiment.

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

Returns:

The type of the inference experiment.

See Also:

InferenceExperimentType

schedule

public final InferenceExperimentSchedule schedule()

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

Returns:

The duration for which the inference experiment ran or will run.

The maximum duration that you can set for an inference experiment is 30 days.

status

public final InferenceExperimentStatus status()

The status of the inference experiment.

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

Returns:

The status of the inference experiment.

See Also:

InferenceExperimentStatus

statusAsString

public final String statusAsString()

The status of the inference experiment.

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

Returns:

The status of the inference experiment.

See Also:

InferenceExperimentStatus

statusReason

public final String statusReason()

The error message for the inference experiment status result.

Returns:

The error message for the inference experiment status result.

description

public final String description()

The description of the inference experiment.

Returns:

The description of the inference experiment.

creationTime

public final Instant creationTime()

The timestamp at which the inference experiment was created.

Returns:

The timestamp at which the inference experiment was created.

completionTime

public final Instant completionTime()

The timestamp at which the inference experiment was completed.

Returns:

The timestamp at which the inference experiment was completed.

lastModifiedTime

public final Instant lastModifiedTime()

The timestamp when you last modified the inference experiment.

Returns:

The timestamp when you last modified the inference experiment.

roleArn

public final String roleArn()

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

Returns:

The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

toBuilder

public InferenceExperimentSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<InferenceExperimentSummary.Builder,InferenceExperimentSummary>

builder

public static InferenceExperimentSummary.Builder builder()

serializableBuilderClass

public static Class<? extends InferenceExperimentSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo