CreateTrialComponentRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class CreateTrialComponentRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemaker.model.CreateTrialComponentRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateTrialComponentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateTrialComponentRequest ()

Constructors
Constructor and Description
`CreateTrialComponentRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateTrialComponentRequest`	`addInputArtifactsEntry (String key, TrialComponentArtifact value)` Add a single InputArtifacts entry
`CreateTrialComponentRequest`	`addOutputArtifactsEntry (String key, TrialComponentArtifact value)` Add a single OutputArtifacts entry
`CreateTrialComponentRequest`	`addParametersEntry (String key, TrialComponentParameterValue value)` Add a single Parameters entry
`CreateTrialComponentRequest`	`clearInputArtifactsEntries ()` Removes all the entries added into InputArtifacts.
`CreateTrialComponentRequest`	`clearOutputArtifactsEntries ()` Removes all the entries added into OutputArtifacts.
`CreateTrialComponentRequest`	`clearParametersEntries ()` Removes all the entries added into Parameters.
`CreateTrialComponentRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getDisplayName ()` The name of the component as displayed.
`Date`	`getEndTime ()` When the component ended.
`Map<String,TrialComponentArtifact>`	`getInputArtifacts ()` The input artifacts for the component.
`MetadataProperties`	`getMetadataProperties ()`
`Map<String,TrialComponentArtifact>`	`getOutputArtifacts ()` The output artifacts for the component.
`Map<String,TrialComponentParameterValue>`	`getParameters ()` The hyperparameters for the component.
`Date`	`getStartTime ()` When the component started.
`TrialComponentStatus`	`getStatus ()` The status of the component.
`List<Tag>`	`getTags ()` A list of tags to associate with the component.
`String`	`getTrialComponentName ()` The name of the component.
`int`	`hashCode ()`
`void`	`setDisplayName (String displayName)` The name of the component as displayed.
`void`	`setEndTime (Date endTime)` When the component ended.
`void`	`setInputArtifacts (Map<String,TrialComponentArtifact> inputArtifacts)` The input artifacts for the component.
`void`	`setMetadataProperties (MetadataProperties metadataProperties)`
`void`	`setOutputArtifacts (Map<String,TrialComponentArtifact> outputArtifacts)` The output artifacts for the component.
`void`	`setParameters (Map<String,TrialComponentParameterValue> parameters)` The hyperparameters for the component.
`void`	`setStartTime (Date startTime)` When the component started.
`void`	`setStatus (TrialComponentStatus status)` The status of the component.
`void`	`setTags (Collection<Tag> tags)` A list of tags to associate with the component.
`void`	`setTrialComponentName (String trialComponentName)` The name of the component.
`String`	`toString ()` Returns a string representation of this object.
`CreateTrialComponentRequest`	`withDisplayName (String displayName)` The name of the component as displayed.
`CreateTrialComponentRequest`	`withEndTime (Date endTime)` When the component ended.
`CreateTrialComponentRequest`	`withInputArtifacts (Map<String,TrialComponentArtifact> inputArtifacts)` The input artifacts for the component.
`CreateTrialComponentRequest`	`withMetadataProperties (MetadataProperties metadataProperties)`
`CreateTrialComponentRequest`	`withOutputArtifacts (Map<String,TrialComponentArtifact> outputArtifacts)` The output artifacts for the component.
`CreateTrialComponentRequest`	`withParameters (Map<String,TrialComponentParameterValue> parameters)` The hyperparameters for the component.
`CreateTrialComponentRequest`	`withStartTime (Date startTime)` When the component started.
`CreateTrialComponentRequest`	`withStatus (TrialComponentStatus status)` The status of the component.
`CreateTrialComponentRequest`	`withTags (Collection<Tag> tags)` A list of tags to associate with the component.
`CreateTrialComponentRequest`	`withTags (Tag... tags)` A list of tags to associate with the component.
`CreateTrialComponentRequest`	`withTrialComponentName (String trialComponentName)` The name of the component.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateTrialComponentRequest
```
public CreateTrialComponentRequest()
```
- Method Detail
  - setTrialComponentName
```
public void setTrialComponentName(String trialComponentName)
```
    The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
    
    Parameters:
    
    trialComponentName - The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
  - getTrialComponentName
```
public String getTrialComponentName()
```
    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.
  - withTrialComponentName
```
public CreateTrialComponentRequest withTrialComponentName(String trialComponentName)
```
    The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
    
    Parameters:
    
    trialComponentName - The name of the component. The name must be unique in your Amazon Web Services account and is not case-sensitive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(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.
    
    Parameters:
    
    displayName - The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.
  - getDisplayName
```
public String getDisplayName()
```
    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.
  - withDisplayName
```
public CreateTrialComponentRequest withDisplayName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(TrialComponentStatus status)
```
    The status of the component. States include:
    - InProgress
    - Completed
    - Failed
    Parameters:
    status - The status of the component. States include:
    
    InProgress
    
    Completed
    
    Failed
  - getStatus
```
public TrialComponentStatus getStatus()
```
    The status of the component. States include:
    - InProgress
    - Completed
    - Failed
    Returns:
    The status of the component. States include:
    
    InProgress
    
    Completed
    
    Failed
  - withStatus
```
public CreateTrialComponentRequest withStatus(TrialComponentStatus status)
```
    The status of the component. States include:
    - InProgress
    - Completed
    - Failed
    Parameters:
    status - The status of the component. States include:
    
    InProgress
    
    Completed
    
    Failed
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
public void setStartTime(Date startTime)
```
    When the component started.
    
    Parameters:
    
    startTime - When the component started.
  - getStartTime
```
public Date getStartTime()
```
    When the component started.
    
    Returns:
    
    When the component started.
  - withStartTime
```
public CreateTrialComponentRequest withStartTime(Date startTime)
```
    When the component started.
    
    Parameters:
    
    startTime - When the component started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    When the component ended.
    
    Parameters:
    
    endTime - When the component ended.
  - getEndTime
```
public Date getEndTime()
```
    When the component ended.
    
    Returns:
    
    When the component ended.
  - withEndTime
```
public CreateTrialComponentRequest withEndTime(Date endTime)
```
    When the component ended.
    
    Parameters:
    
    endTime - When the component ended.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getParameters
```
public Map<String,TrialComponentParameterValue> getParameters()
```
    The hyperparameters for the component.
    
    Returns:
    
    The hyperparameters for the component.
  - setParameters
```
public void setParameters(Map<String,TrialComponentParameterValue> parameters)
```
    The hyperparameters for the component.
    
    Parameters:
    
    parameters - The hyperparameters for the component.
  - withParameters
```
public CreateTrialComponentRequest withParameters(Map<String,TrialComponentParameterValue> parameters)
```
    The hyperparameters for the component.
    
    Parameters:
    
    parameters - The hyperparameters for the component.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addParametersEntry
```
public CreateTrialComponentRequest addParametersEntry(String key,
 TrialComponentParameterValue value)
```
    Add a single Parameters entry
    
    See Also:
    
    withParameters(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentParameterValue>)
  - clearParametersEntries
```
public CreateTrialComponentRequest clearParametersEntries()
```
    Removes all the entries added into Parameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInputArtifacts
```
public Map<String,TrialComponentArtifact> getInputArtifacts()
```
    The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
    
    Returns:
    
    The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
  - setInputArtifacts
```
public void setInputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)
```
    The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
    
    Parameters:
    
    inputArtifacts - The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
  - withInputArtifacts
```
public CreateTrialComponentRequest withInputArtifacts(Map<String,TrialComponentArtifact> inputArtifacts)
```
    The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
    
    Parameters:
    
    inputArtifacts - The input artifacts for the component. Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addInputArtifactsEntry
```
public CreateTrialComponentRequest addInputArtifactsEntry(String key,
 TrialComponentArtifact value)
```
    Add a single InputArtifacts entry
    
    See Also:
    
    withInputArtifacts(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentArtifact>)
  - clearInputArtifactsEntries
```
public CreateTrialComponentRequest clearInputArtifactsEntries()
```
    Removes all the entries added into InputArtifacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOutputArtifacts
```
public Map<String,TrialComponentArtifact> getOutputArtifacts()
```
    The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
    
    Returns:
    
    The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
  - setOutputArtifacts
```
public void setOutputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)
```
    The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
    
    Parameters:
    
    outputArtifacts - The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
  - withOutputArtifacts
```
public CreateTrialComponentRequest withOutputArtifacts(Map<String,TrialComponentArtifact> outputArtifacts)
```
    The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
    
    Parameters:
    
    outputArtifacts - The output artifacts for the component. Examples of output artifacts are metrics, snapshots, logs, and images.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOutputArtifactsEntry
```
public CreateTrialComponentRequest addOutputArtifactsEntry(String key,
 TrialComponentArtifact value)
```
    Add a single OutputArtifacts entry
    
    See Also:
    
    withOutputArtifacts(java.util.Map<java.lang.String, com.amazonaws.services.sagemaker.model.TrialComponentArtifact>)
  - clearOutputArtifactsEntries
```
public CreateTrialComponentRequest clearOutputArtifactsEntries()
```
    Removes all the entries added into OutputArtifacts.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadataProperties
```
public void setMetadataProperties(MetadataProperties metadataProperties)
```
    Parameters:
    
    metadataProperties -
  - getMetadataProperties
```
public MetadataProperties getMetadataProperties()
```
    Returns:
  - withMetadataProperties
```
public CreateTrialComponentRequest withMetadataProperties(MetadataProperties metadataProperties)
```
    Parameters:
    
    metadataProperties -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    A list of tags to associate with the component. You can use Search API to search on the tags.
    
    Returns:
    
    A list of tags to associate with the component. You can use Search API to search on the tags.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    A list of tags to associate with the component. You can use Search API to search on the tags.
    
    Parameters:
    
    tags - A list of tags to associate with the component. You can use Search API to search on the tags.
  - withTags
```
public CreateTrialComponentRequest withTags(Tag... tags)
```
    A list of tags to associate with the component. You can use Search API to search on the tags.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - A list of tags to associate with the component. You can use Search API to search on the tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateTrialComponentRequest withTags(Collection<Tag> tags)
```
    A list of tags to associate with the component. You can use Search API to search on the tags.
    
    Parameters:
    
    tags - A list of tags to associate with the component. You can use Search API to search on the tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateTrialComponentRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateTrialComponentRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateTrialComponentRequest

Method Detail

setTrialComponentName

getTrialComponentName

withTrialComponentName

setDisplayName

getDisplayName

withDisplayName

setStatus

getStatus

withStatus

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

getParameters

setParameters

withParameters

addParametersEntry

clearParametersEntries

getInputArtifacts

setInputArtifacts

withInputArtifacts

addInputArtifactsEntry

clearInputArtifactsEntries

getOutputArtifacts

setOutputArtifacts

withOutputArtifacts

addOutputArtifactsEntry

clearOutputArtifactsEntries

setMetadataProperties

getMetadataProperties

withMetadataProperties

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone