CreateTrialComponentRequest (AWS Java SDK :: Services

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateTrialComponentRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateTrialComponentRequest.Builder`	`builder()`
`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`	`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`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`Map<String,TrialComponentArtifact>`	`inputArtifacts()` The input artifacts for the component.
`MetadataProperties`	`metadataProperties()` Returns the value of the MetadataProperties property for this object.
`Map<String,TrialComponentArtifact>`	`outputArtifacts()` The output artifacts for the component.
`Map<String,TrialComponentParameterValue>`	`parameters()` The hyperparameters for the component.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateTrialComponentRequest.Builder>`	`serializableBuilderClass()`
`Instant`	`startTime()` When the component started.
`TrialComponentStatus`	`status()` The status of the component.
`List<Tag>`	`tags()` A list of tags to associate with the component.
`CreateTrialComponentRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`trialComponentName()` The name of the component.

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
  - trialComponentName
```
public final String trialComponentName()
```
    The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
    
    Returns:
    
    The name of the component. 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 component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
    
    Returns:
    
    The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
  - 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.
  - 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 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 hasParameters() method.
    
    Returns:
    
    The hyperparameters for 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 for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
    
    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 for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
  - 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 for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
    
    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 for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
  - 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 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:
    
    A list of tags to associate with the component. You can use Search API to search on the tags.
  - toBuilder
```
public CreateTrialComponentRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateTrialComponentRequest.Builder,CreateTrialComponentRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
  - builder
```
public static CreateTrialComponentRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateTrialComponentRequest.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

Class CreateTrialComponentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

trialComponentName

displayName

status

startTime

endTime

hasParameters

parameters

hasInputArtifacts

inputArtifacts

hasOutputArtifacts

outputArtifacts

metadataProperties

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields