Class ProcessingJob
- java.lang.Object
-
- software.amazon.awssdk.services.sagemaker.model.ProcessingJob
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ProcessingJob.Builder,ProcessingJob>
@Generated("software.amazon.awssdk:codegen") public final class ProcessingJob extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProcessingJob.Builder,ProcessingJob>
An Amazon SageMaker processing job that is used to analyze data and evaluate models. For more information, see Process Data and Evaluate Models.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ProcessingJob.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AppSpecification
appSpecification()
Returns the value of the AppSpecification property for this object.String
autoMLJobArn()
The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.static ProcessingJob.Builder
builder()
Instant
creationTime()
The time the processing job was created.Map<String,String>
environment()
Sets the environment variables in the Docker container.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
exitMessage()
A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.ExperimentConfig
experimentConfig()
Returns the value of the ExperimentConfig property for this object.String
failureReason()
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasEnvironment()
For responses, this returns true if the service returned a value for the Environment property.int
hashCode()
boolean
hasProcessingInputs()
For responses, this returns true if the service returned a value for the ProcessingInputs property.boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.Instant
lastModifiedTime()
The time the processing job was last modified.String
monitoringScheduleArn()
The ARN of a monitoring schedule for an endpoint associated with this processing job.NetworkConfig
networkConfig()
Returns the value of the NetworkConfig property for this object.Instant
processingEndTime()
The time that the processing job ended.List<ProcessingInput>
processingInputs()
List of input configurations for the processing job.String
processingJobArn()
The ARN of the processing job.String
processingJobName()
The name of the processing job.ProcessingJobStatus
processingJobStatus()
The status of the processing job.String
processingJobStatusAsString()
The status of the processing job.ProcessingOutputConfig
processingOutputConfig()
Returns the value of the ProcessingOutputConfig property for this object.ProcessingResources
processingResources()
Returns the value of the ProcessingResources property for this object.Instant
processingStartTime()
The time that the processing job started.String
roleArn()
The ARN of the role used to create the processing job.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends ProcessingJob.Builder>
serializableBuilderClass()
ProcessingStoppingCondition
stoppingCondition()
Returns the value of the StoppingCondition property for this object.List<Tag>
tags()
An array of key-value pairs.ProcessingJob.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
trainingJobArn()
The ARN of the training job associated with this processing job.-
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
-
hasProcessingInputs
public final boolean hasProcessingInputs()
For responses, this returns true if the service returned a value for the ProcessingInputs 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.
-
processingInputs
public final List<ProcessingInput> processingInputs()
List of input configurations for the processing job.
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
hasProcessingInputs()
method.- Returns:
- List of input configurations for the processing job.
-
processingOutputConfig
public final ProcessingOutputConfig processingOutputConfig()
Returns the value of the ProcessingOutputConfig property for this object.- Returns:
- The value of the ProcessingOutputConfig property for this object.
-
processingJobName
public final String processingJobName()
The name of the processing job.
- Returns:
- The name of the processing job.
-
processingResources
public final ProcessingResources processingResources()
Returns the value of the ProcessingResources property for this object.- Returns:
- The value of the ProcessingResources property for this object.
-
stoppingCondition
public final ProcessingStoppingCondition stoppingCondition()
Returns the value of the StoppingCondition property for this object.- Returns:
- The value of the StoppingCondition property for this object.
-
appSpecification
public final AppSpecification appSpecification()
Returns the value of the AppSpecification property for this object.- Returns:
- The value of the AppSpecification property for this object.
-
hasEnvironment
public final boolean hasEnvironment()
For responses, this returns true if the service returned a value for the Environment 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.
-
environment
public final Map<String,String> environment()
Sets the environment variables in the Docker container.
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
hasEnvironment()
method.- Returns:
- Sets the environment variables in the Docker container.
-
networkConfig
public final NetworkConfig networkConfig()
Returns the value of the NetworkConfig property for this object.- Returns:
- The value of the NetworkConfig property for this object.
-
roleArn
public final String roleArn()
The ARN of the role used to create the processing job.
- Returns:
- The ARN of the role used to create the processing job.
-
experimentConfig
public final ExperimentConfig experimentConfig()
Returns the value of the ExperimentConfig property for this object.- Returns:
- The value of the ExperimentConfig property for this object.
-
processingJobArn
public final String processingJobArn()
The ARN of the processing job.
- Returns:
- The ARN of the processing job.
-
processingJobStatus
public final ProcessingJobStatus processingJobStatus()
The status of the processing job.
If the service returns an enum value that is not available in the current SDK version,
processingJobStatus
will returnProcessingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprocessingJobStatusAsString()
.- Returns:
- The status of the processing job.
- See Also:
ProcessingJobStatus
-
processingJobStatusAsString
public final String processingJobStatusAsString()
The status of the processing job.
If the service returns an enum value that is not available in the current SDK version,
processingJobStatus
will returnProcessingJobStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromprocessingJobStatusAsString()
.- Returns:
- The status of the processing job.
- See Also:
ProcessingJobStatus
-
exitMessage
public final String exitMessage()
A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
- Returns:
- A string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
-
failureReason
public final String failureReason()
A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
- Returns:
- A string, up to one KB in size, that contains the reason a processing job failed, if it failed.
-
processingEndTime
public final Instant processingEndTime()
The time that the processing job ended.
- Returns:
- The time that the processing job ended.
-
processingStartTime
public final Instant processingStartTime()
The time that the processing job started.
- Returns:
- The time that the processing job started.
-
lastModifiedTime
public final Instant lastModifiedTime()
The time the processing job was last modified.
- Returns:
- The time the processing job was last modified.
-
creationTime
public final Instant creationTime()
The time the processing job was created.
- Returns:
- The time the processing job was created.
-
monitoringScheduleArn
public final String monitoringScheduleArn()
The ARN of a monitoring schedule for an endpoint associated with this processing job.
- Returns:
- The ARN of a monitoring schedule for an endpoint associated with this processing job.
-
autoMLJobArn
public final String autoMLJobArn()
The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
- Returns:
- The Amazon Resource Name (ARN) of the AutoML job associated with this processing job.
-
trainingJobArn
public final String trainingJobArn()
The ARN of the training job associated with this processing job.
- Returns:
- The ARN of the training job associated with this processing job.
-
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
public final List<Tag> tags()
An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
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:
- An array of key-value pairs. For more information, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide.
-
toBuilder
public ProcessingJob.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProcessingJob.Builder,ProcessingJob>
-
builder
public static ProcessingJob.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProcessingJob.Builder> serializableBuilderClass()
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-