Class UpdateTrialComponentRequest
- 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.UpdateTrialComponentRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateTrialComponentRequest.Builder,UpdateTrialComponentRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateTrialComponentRequest extends SageMakerRequest implements ToCopyableBuilder<UpdateTrialComponentRequest.Builder,UpdateTrialComponentRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
UpdateTrialComponentRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static UpdateTrialComponentRequest.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
hasInputArtifactsToRemove()
For responses, this returns true if the service returned a value for the InputArtifactsToRemove property.boolean
hasOutputArtifacts()
For responses, this returns true if the service returned a value for the OutputArtifacts property.boolean
hasOutputArtifactsToRemove()
For responses, this returns true if the service returned a value for the OutputArtifactsToRemove property.boolean
hasParameters()
For responses, this returns true if the service returned a value for the Parameters property.boolean
hasParametersToRemove()
For responses, this returns true if the service returned a value for the ParametersToRemove property.Map<String,TrialComponentArtifact>
inputArtifacts()
Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts.List<String>
inputArtifactsToRemove()
The input artifacts to remove from the component.Map<String,TrialComponentArtifact>
outputArtifacts()
Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts.List<String>
outputArtifactsToRemove()
The output artifacts to remove from the component.Map<String,TrialComponentParameterValue>
parameters()
Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters.List<String>
parametersToRemove()
The hyperparameters to remove from the component.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends UpdateTrialComponentRequest.Builder>
serializableBuilderClass()
Instant
startTime()
When the component started.TrialComponentStatus
status()
The new status of the component.UpdateTrialComponentRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
trialComponentName()
The name of the component to update.-
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 to update.
- Returns:
- The name of the component to update.
-
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 new status of the component.
- Returns:
- The new status of the component.
-
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 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()
Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
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:
- Replaces all of the component's hyperparameters with the specified hyperparameters or add new hyperparameters. Existing hyperparameters are replaced if the trial component is updated with an identical hyperparameter key.
-
hasParametersToRemove
public final boolean hasParametersToRemove()
For responses, this returns true if the service returned a value for the ParametersToRemove 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.
-
parametersToRemove
public final List<String> parametersToRemove()
The hyperparameters to remove from 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
hasParametersToRemove()
method.- Returns:
- The hyperparameters to remove from 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()
Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
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:
- Replaces all of the component's input artifacts with the specified artifacts or adds new input artifacts. Existing input artifacts are replaced if the trial component is updated with an identical input artifact key.
-
hasInputArtifactsToRemove
public final boolean hasInputArtifactsToRemove()
For responses, this returns true if the service returned a value for the InputArtifactsToRemove 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.
-
inputArtifactsToRemove
public final List<String> inputArtifactsToRemove()
The input artifacts to remove from 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
hasInputArtifactsToRemove()
method.- Returns:
- The input artifacts to remove from 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()
Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
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:
- Replaces all of the component's output artifacts with the specified artifacts or adds new output artifacts. Existing output artifacts are replaced if the trial component is updated with an identical output artifact key.
-
hasOutputArtifactsToRemove
public final boolean hasOutputArtifactsToRemove()
For responses, this returns true if the service returned a value for the OutputArtifactsToRemove 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.
-
outputArtifactsToRemove
public final List<String> outputArtifactsToRemove()
The output artifacts to remove from 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
hasOutputArtifactsToRemove()
method.- Returns:
- The output artifacts to remove from the component.
-
toBuilder
public UpdateTrialComponentRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateTrialComponentRequest.Builder,UpdateTrialComponentRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static UpdateTrialComponentRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends UpdateTrialComponentRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-