Class TrialComponent
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.TrialComponent
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TrialComponent.Builder,TrialComponent>
@Generated("software.amazon.awssdk:codegen") public final class TrialComponent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<TrialComponent.Builder,TrialComponent>
The properties of a trial component as returned by the Search API.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
TrialComponent.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static TrialComponent.Builder
builder()
UserContext
createdBy()
Who created the trial component.Instant
creationTime()
When the component was created.String
displayName()
The name of the component as displayed.Instant
endTime()
When the component ended.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasInputArtifacts()
For responses, this returns true if the service returned a value for the InputArtifacts property.boolean
hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property.boolean
hasOutputArtifacts()
For responses, this returns true if the service returned a value for the OutputArtifacts property.boolean
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.boolean
hasParents()
For responses, this returns true if the service returned a value for the Parents property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Map<String,TrialComponentArtifact>
inputArtifacts()
The input artifacts of the component.UserContext
lastModifiedBy()
Returns the value of the LastModifiedBy property for this object.Instant
lastModifiedTime()
When the component was last modified.String
lineageGroupArn()
The Amazon Resource Name (ARN) of the lineage group resource.MetadataProperties
metadataProperties()
Returns the value of the MetadataProperties property for this object.List<TrialComponentMetricSummary>
metrics()
The metrics for the component.Map<String,TrialComponentArtifact>
outputArtifacts()
The output artifacts of the component.Map<String,TrialComponentParameterValue>
parameters()
The hyperparameters of the component.List<Parent>
parents()
An array of the parents of the component.String
runName()
The name of the experiment run.List<SdkField<?>>
sdkFields()
static Class<? extends TrialComponent.Builder>
serializableBuilderClass()
TrialComponentSource
source()
The Amazon Resource Name (ARN) and job type of the source of the component.TrialComponentSourceDetail
sourceDetail()
Details of the source of the component.Instant
startTime()
When the component started.TrialComponentStatus
status()
Returns the value of the Status property for this object.List<Tag>
tags()
The list of tags that are associated with the component.TrialComponent.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
trialComponentArn()
The Amazon Resource Name (ARN) of the trial component.String
trialComponentName()
The name of the trial component.-
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
-
trialComponentName
public final String trialComponentName()
The name of the trial component.
- Returns:
- The name of the trial component.
-
displayName
public final String displayName()
The name of the component as displayed. If
DisplayName
isn't specified,TrialComponentName
is displayed.- Returns:
- The name of the component as displayed. If
DisplayName
isn't specified,TrialComponentName
is displayed.
-
trialComponentArn
public final String trialComponentArn()
The Amazon Resource Name (ARN) of the trial component.
- Returns:
- The Amazon Resource Name (ARN) of the trial component.
-
source
public final TrialComponentSource source()
The Amazon Resource Name (ARN) and job type of the source of the component.
- Returns:
- The Amazon Resource Name (ARN) and job type of the source of the component.
-
status
public final TrialComponentStatus status()
Returns the value of the Status property for this object.- Returns:
- The value of the Status property for this object.
-
startTime
public final Instant startTime()
When the component started.
- Returns:
- When the component started.
-
endTime
public final Instant endTime()
When the component ended.
- Returns:
- When the component ended.
-
creationTime
public final Instant creationTime()
When the component was created.
- Returns:
- When the component was created.
-
createdBy
public final UserContext createdBy()
Who created the trial component.
- Returns:
- Who created the trial component.
-
lastModifiedTime
public final Instant lastModifiedTime()
When the component was last modified.
- Returns:
- When the component was last modified.
-
lastModifiedBy
public final UserContext lastModifiedBy()
Returns the value of the LastModifiedBy property for this object.- Returns:
- The value of the LastModifiedBy property for this object.
-
hasParameters
public final boolean hasParameters()
For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
parameters
public final Map<String,TrialComponentParameterValue> parameters()
The hyperparameters of the component.
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
hasParameters()
method.- Returns:
- The hyperparameters of the component.
-
hasInputArtifacts
public final boolean hasInputArtifacts()
For responses, this returns true if the service returned a value for the InputArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
inputArtifacts
public final Map<String,TrialComponentArtifact> inputArtifacts()
The input artifacts of the component.
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
hasInputArtifacts()
method.- Returns:
- The input artifacts of the component.
-
hasOutputArtifacts
public final boolean hasOutputArtifacts()
For responses, this returns true if the service returned a value for the OutputArtifacts property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
outputArtifacts
public final Map<String,TrialComponentArtifact> outputArtifacts()
The output artifacts of the component.
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
hasOutputArtifacts()
method.- Returns:
- The output artifacts of the component.
-
hasMetrics
public final boolean hasMetrics()
For responses, this returns true if the service returned a value for the Metrics property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
metrics
public final List<TrialComponentMetricSummary> metrics()
The metrics for the component.
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
hasMetrics()
method.- Returns:
- The metrics for the component.
-
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.
-
sourceDetail
public final TrialComponentSourceDetail sourceDetail()
Details of the source of the component.
- Returns:
- Details of the source of the component.
-
lineageGroupArn
public final String lineageGroupArn()
The Amazon Resource Name (ARN) of the lineage group resource.
- Returns:
- The Amazon Resource Name (ARN) of the lineage group resource.
-
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 theisEmpty()
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()
The list of tags that are associated with the component. 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:
- The list of tags that are associated with the component. You can use Search API to search on the tags.
-
hasParents
public final boolean hasParents()
For responses, this returns true if the service returned a value for the Parents property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
parents
public final List<Parent> parents()
An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
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
hasParents()
method.- Returns:
- An array of the parents of the component. A parent is a trial the component is associated with and the experiment the trial is part of. A component might not have any parents.
-
runName
public final String runName()
The name of the experiment run.
- Returns:
- The name of the experiment run.
-
toBuilder
public TrialComponent.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<TrialComponent.Builder,TrialComponent>
-
builder
public static TrialComponent.Builder builder()
-
serializableBuilderClass
public static Class<? extends TrialComponent.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-