Class DescribeProcessingJobResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
-
- software.amazon.awssdk.services.sagemaker.model.DescribeProcessingJobResponse
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeProcessingJobResponse.Builder,DescribeProcessingJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeProcessingJobResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeProcessingJobResponse.Builder,DescribeProcessingJobResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
DescribeProcessingJobResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AppSpecification
appSpecification()
Configures the processing job to run a specified container image.String
autoMLJobArn()
The ARN of an AutoML job associated with this processing job.static DescribeProcessingJobResponse.Builder
builder()
Instant
creationTime()
The time at which the processing job was created.Map<String,String>
environment()
The environment variables set in the Docker container.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
exitMessage()
An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.ExperimentConfig
experimentConfig()
The configuration information used to create an experiment.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.Instant
lastModifiedTime()
The time at which the processing job was last modified.String
monitoringScheduleArn()
The ARN of a monitoring schedule for an endpoint associated with this processing job.NetworkConfig
networkConfig()
Networking options for a processing job.Instant
processingEndTime()
The time at which the processing job completed.List<ProcessingInput>
processingInputs()
The inputs for a processing job.String
processingJobArn()
The Amazon Resource Name (ARN) of the processing job.String
processingJobName()
The name of the processing job.ProcessingJobStatus
processingJobStatus()
Provides the status of a processing job.String
processingJobStatusAsString()
Provides the status of a processing job.ProcessingOutputConfig
processingOutputConfig()
Output configuration for the processing job.ProcessingResources
processingResources()
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job.Instant
processingStartTime()
The time at which the processing job started.String
roleArn()
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends DescribeProcessingJobResponse.Builder>
serializableBuilderClass()
ProcessingStoppingCondition
stoppingCondition()
The time limit for how long the processing job is allowed to run.DescribeProcessingJobResponse.Builder
toBuilder()
String
toString()
Returns a string representation of this object.String
trainingJobArn()
The ARN of a training job associated with this processing job.-
Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
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()
The inputs for a 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:
- The inputs for a processing job.
-
processingOutputConfig
public final ProcessingOutputConfig processingOutputConfig()
Output configuration for the processing job.
- Returns:
- Output configuration for the processing job.
-
processingJobName
public final String processingJobName()
The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
- Returns:
- The name of the processing job. The name must be unique within an Amazon Web Services Region in the Amazon Web Services account.
-
processingResources
public final ProcessingResources processingResources()
Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
- Returns:
- Identifies the resources, ML compute instances, and ML storage volumes to deploy for a processing job. In distributed training, you specify more than one instance.
-
stoppingCondition
public final ProcessingStoppingCondition stoppingCondition()
The time limit for how long the processing job is allowed to run.
- Returns:
- The time limit for how long the processing job is allowed to run.
-
appSpecification
public final AppSpecification appSpecification()
Configures the processing job to run a specified container image.
- Returns:
- Configures the processing job to run a specified container image.
-
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()
The environment variables set 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:
- The environment variables set in the Docker container.
-
networkConfig
public final NetworkConfig networkConfig()
Networking options for a processing job.
- Returns:
- Networking options for a processing job.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
- Returns:
- The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker can assume to perform tasks on your behalf.
-
experimentConfig
public final ExperimentConfig experimentConfig()
The configuration information used to create an experiment.
- Returns:
- The configuration information used to create an experiment.
-
processingJobArn
public final String processingJobArn()
The Amazon Resource Name (ARN) of the processing job.
- Returns:
- The Amazon Resource Name (ARN) of the processing job.
-
processingJobStatus
public final ProcessingJobStatus processingJobStatus()
Provides the status of a 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:
- Provides the status of a processing job.
- See Also:
ProcessingJobStatus
-
processingJobStatusAsString
public final String processingJobStatusAsString()
Provides the status of a 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:
- Provides the status of a processing job.
- See Also:
ProcessingJobStatus
-
exitMessage
public final String exitMessage()
An optional string, up to one KB in size, that contains metadata from the processing container when the processing job exits.
- Returns:
- An optional 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 at which the processing job completed.
- Returns:
- The time at which the processing job completed.
-
processingStartTime
public final Instant processingStartTime()
The time at which the processing job started.
- Returns:
- The time at which the processing job started.
-
lastModifiedTime
public final Instant lastModifiedTime()
The time at which the processing job was last modified.
- Returns:
- The time at which the processing job was last modified.
-
creationTime
public final Instant creationTime()
The time at which the processing job was created.
- Returns:
- The time at which 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 ARN of an AutoML job associated with this processing job.
- Returns:
- The ARN of an AutoML job associated with this processing job.
-
trainingJobArn
public final String trainingJobArn()
The ARN of a training job associated with this processing job.
- Returns:
- The ARN of a training job associated with this processing job.
-
toBuilder
public DescribeProcessingJobResponse.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeProcessingJobResponse.Builder,DescribeProcessingJobResponse>
- Specified by:
toBuilder
in classAwsResponse
-
builder
public static DescribeProcessingJobResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeProcessingJobResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsResponse
-
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 classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-