Class CreateTrialComponentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateTrialComponentRequest.Builder,
CreateTrialComponentRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
The name of the component as displayed.final Instant
endTime()
When the component ended.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputArtifacts property.final boolean
For responses, this returns true if the service returned a value for the OutputArtifacts property.final boolean
For responses, this returns true if the service returned a value for the Parameters property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Map
<String, TrialComponentArtifact> The input artifacts for the component.final MetadataProperties
Returns the value of the MetadataProperties property for this object.final Map
<String, TrialComponentArtifact> The output artifacts for the component.The hyperparameters for the component.static Class
<? extends CreateTrialComponentRequest.Builder> final Instant
When the component started.final TrialComponentStatus
status()
The status of the component.tags()
A list of tags to associate with the component.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The name of the component.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The status of the component. States include:
-
InProgress
-
Completed
-
Failed
- Returns:
- The status of the component. States include:
-
InProgress
-
Completed
-
Failed
-
-
-
startTime
When the component started.
- Returns:
- When the component started.
-
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 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
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 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
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 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
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
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 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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateTrialComponentRequest.Builder,
CreateTrialComponentRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-