software.amazon.awssdk.services.sagemaker.model

Class DescribeTrialResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeTrialResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeTrialResponse.Builder,DescribeTrialResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeTrialResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeTrialResponse.Builder,DescribeTrialResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeTrialResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeTrialResponse.Builder	builder()
UserContext	createdBy() Who created the trial.
Instant	creationTime() When the trial was created.
String	displayName() The name of the trial as displayed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
String	experimentName() The name of the experiment the trial is part of.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
UserContext	lastModifiedBy() Who last modified the trial.
Instant	lastModifiedTime() When the trial was last modified.
MetadataProperties	metadataProperties() Returns the value of the MetadataProperties property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeTrialResponse.Builder>	serializableBuilderClass()
TrialSource	source() The Amazon Resource Name (ARN) of the source and, optionally, the job type.
DescribeTrialResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
String	trialArn() The Amazon Resource Name (ARN) of the trial.
String	trialName() The name of the trial.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

trialName

public final String trialName()

The name of the trial.

Returns:

The name of the trial.

trialArn

public final String trialArn()

The Amazon Resource Name (ARN) of the trial.

Returns:

The Amazon Resource Name (ARN) of the trial.

displayName

public final String displayName()

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

Returns:

The name of the trial as displayed. If DisplayName isn't specified, TrialName is displayed.

experimentName

public final String experimentName()

The name of the experiment the trial is part of.

Returns:

The name of the experiment the trial is part of.

source

public final TrialSource source()

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

Returns:

The Amazon Resource Name (ARN) of the source and, optionally, the job type.

creationTime

public final Instant creationTime()

When the trial was created.

Returns:

When the trial was created.

createdBy

public final UserContext createdBy()

Who created the trial.

Returns:

Who created the trial.

lastModifiedTime

public final Instant lastModifiedTime()

When the trial was last modified.

Returns:

When the trial was last modified.

lastModifiedBy

public final UserContext lastModifiedBy()

Who last modified the trial.

Returns:

Who last modified the trial.

metadataProperties

public final MetadataProperties metadataProperties()

Returns the value of the MetadataProperties property for this object.

Returns:

The value of the MetadataProperties property for this object.

toBuilder

public DescribeTrialResponse.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<DescribeTrialResponse.Builder,DescribeTrialResponse>

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static DescribeTrialResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.