DescribeTrialComponentResponse (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeTrialComponentResponse.Builder,DescribeTrialComponentResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeTrialComponentResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeTrialComponentResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeTrialComponentResponse.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`	`hasSources()` For responses, this returns true if the service returned a value for the Sources property.
`Map<String,TrialComponentArtifact>`	`inputArtifacts()` The input artifacts of the component.
`UserContext`	`lastModifiedBy()` Who last modified the component.
`Instant`	`lastModifiedTime()` When the component was last modified.
`String`	`lineageGroupArn()` The Amazon Resource Name (ARN) of the lineage group.
`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<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeTrialComponentResponse.Builder>`	`serializableBuilderClass()`
`TrialComponentSource`	`source()` The Amazon Resource Name (ARN) of the source and, optionally, the job type.
`List<TrialComponentSource>`	`sources()` A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
`Instant`	`startTime()` When the component started.
`TrialComponentStatus`	`status()` The status of the component.
`DescribeTrialComponentResponse.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 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
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.
  - trialComponentArn
```
public final String trialComponentArn()
```
    The Amazon Resource Name (ARN) of the trial component.
    
    Returns:
    
    The Amazon Resource Name (ARN) 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.
  - source
```
public final TrialComponentSource 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.
  - status
```
public final TrialComponentStatus status()
```
    The status of the component. States include:
    - InProgress
    - Completed
    - Failed
    Returns:
    The status of the component. States include:
    
    InProgress
    
    Completed
    
    Failed
  - 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()
```
    Who last modified the component.
    
    Returns:
    
    Who last modified the component.
  - 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 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.
  - 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 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.
  - 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 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.
  - 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.
  - 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.
  - 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 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.
  - 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.
  - lineageGroupArn
```
public final String lineageGroupArn()
```
    The Amazon Resource Name (ARN) of the lineage group.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the lineage group.
  - hasSources
```
public final boolean hasSources()
```
    For responses, this returns true if the service returned a value for the Sources 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.
  - sources
```
public final List<TrialComponentSource> sources()
```
    A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
    
    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 hasSources() method.
    
    Returns:
    
    A list of ARNs and, if applicable, job types for multiple sources of an experiment run.
  - toBuilder
```
public DescribeTrialComponentResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeTrialComponentResponse.Builder,DescribeTrialComponentResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeTrialComponentResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeTrialComponentResponse.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)
```
    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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeTrialComponentResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

trialComponentName

trialComponentArn

displayName

source

status

startTime

endTime

creationTime

createdBy

lastModifiedTime

lastModifiedBy

hasParameters

parameters

hasInputArtifacts

inputArtifacts

hasOutputArtifacts

outputArtifacts

metadataProperties

hasMetrics

metrics

lineageGroupArn

hasSources

sources

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields