Class StartPipelineExecutionRequest
- 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.StartPipelineExecutionRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartPipelineExecutionRequest extends SageMakerRequest implements ToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
StartPipelineExecutionRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static StartPipelineExecutionRequest.Builder
builder()
String
clientRequestToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasPipelineParameters()
For responses, this returns true if the service returned a value for the PipelineParameters property.ParallelismConfiguration
parallelismConfiguration()
This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.String
pipelineExecutionDescription()
The description of the pipeline execution.String
pipelineExecutionDisplayName()
The display name of the pipeline execution.String
pipelineName()
The name or Amazon Resource Name (ARN) of the pipeline.List<Parameter>
pipelineParameters()
Contains a list of pipeline parameters.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
SelectiveExecutionConfig
selectiveExecutionConfig()
The selective execution configuration applied to the pipeline run.static Class<? extends StartPipelineExecutionRequest.Builder>
serializableBuilderClass()
StartPipelineExecutionRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
pipelineName
public final String pipelineName()
The name or Amazon Resource Name (ARN) of the pipeline.
- Returns:
- The name or Amazon Resource Name (ARN) of the pipeline.
-
pipelineExecutionDisplayName
public final String pipelineExecutionDisplayName()
The display name of the pipeline execution.
- Returns:
- The display name of the pipeline execution.
-
hasPipelineParameters
public final boolean hasPipelineParameters()
For responses, this returns true if the service returned a value for the PipelineParameters 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.
-
pipelineParameters
public final List<Parameter> pipelineParameters()
Contains a list of pipeline parameters. This list can be empty.
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
hasPipelineParameters()
method.- Returns:
- Contains a list of pipeline parameters. This list can be empty.
-
pipelineExecutionDescription
public final String pipelineExecutionDescription()
The description of the pipeline execution.
- Returns:
- The description of the pipeline execution.
-
clientRequestToken
public final String clientRequestToken()
A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
- Returns:
- A unique, case-sensitive identifier that you provide to ensure the idempotency of the operation. An idempotent operation completes no more than once.
-
parallelismConfiguration
public final ParallelismConfiguration parallelismConfiguration()
This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
- Returns:
- This configuration, if specified, overrides the parallelism configuration of the parent pipeline for this specific run.
-
selectiveExecutionConfig
public final SelectiveExecutionConfig selectiveExecutionConfig()
The selective execution configuration applied to the pipeline run.
- Returns:
- The selective execution configuration applied to the pipeline run.
-
toBuilder
public StartPipelineExecutionRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<StartPipelineExecutionRequest.Builder,StartPipelineExecutionRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static StartPipelineExecutionRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends StartPipelineExecutionRequest.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
-
-