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

Class CreateTrialRequest

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.CreateTrialRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateTrialRequest.Builder,CreateTrialRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateTrialRequest
extends SageMakerRequest
implements ToCopyableBuilder<CreateTrialRequest.Builder,CreateTrialRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateTrialRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateTrialRequest.Builder	builder()
String	displayName()	The name of the trial as displayed.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	experimentName()	The name of the experiment to associate the trial with.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
MetadataProperties	metadataProperties()	Returns the value of the MetadataProperties property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateTrialRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to associate with the trial.
CreateTrialRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trialName()	The name of the trial.

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

trialName

public final String trialName()

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

Returns:

The name of the trial. The name must be unique in your Amazon Web Services account and is not case-sensitive.

displayName

public final String displayName()

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

Returns:

The name of the trial as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialName is displayed.

experimentName

public final String experimentName()

The name of the experiment to associate the trial with.

Returns:

The name of the experiment to associate the trial with.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

A list of tags to associate with the trial. You can use Search API to search on the tags.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

A list of tags to associate with the trial. You can use Search API to search on the tags.

toBuilder

public CreateTrialRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateTrialRequest.Builder,CreateTrialRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateTrialRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo