Class CreateProcessingJobRequest
- 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.CreateProcessingJobRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateProcessingJobRequest.Builder,CreateProcessingJobRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateProcessingJobRequest extends SageMakerRequest implements ToCopyableBuilder<CreateProcessingJobRequest.Builder,CreateProcessingJobRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateProcessingJobRequest.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 Docker container image.static CreateProcessingJobRequest.Builder
builder()
Map<String,String>
environment()
The environment variables to set in the Docker container.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
ExperimentConfig
experimentConfig()
Returns the value of the ExperimentConfig property for this object.<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.NetworkConfig
networkConfig()
Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.List<ProcessingInput>
processingInputs()
An array of inputs configuring the data to download into the processing container.String
processingJobName()
The name of the 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.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 CreateProcessingJobRequest.Builder>
serializableBuilderClass()
ProcessingStoppingCondition
stoppingCondition()
The time limit for how long the processing job is allowed to run.List<Tag>
tags()
(Optional) An array of key-value pairs.CreateProcessingJobRequest.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
-
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()
An array of inputs configuring the data to download into the processing 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
hasProcessingInputs()
method.- Returns:
- An array of inputs configuring the data to download into the processing container.
-
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 Docker container image.
- Returns:
- Configures the processing job to run a specified Docker 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 to set in the Docker container. Up to 100 key and values entries in the map are supported.
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 to set in the Docker container. Up to 100 key and values entries in the map are supported.
-
networkConfig
public final NetworkConfig networkConfig()
Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
- Returns:
- Networking options for a processing job, such as whether to allow inbound and outbound network calls to and from processing containers, and the VPC subnets and security groups to use for VPC-enabled processing jobs.
-
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.
-
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()
(Optional) 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:
- (Optional) 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.
-
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.
-
toBuilder
public CreateProcessingJobRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateProcessingJobRequest.Builder,CreateProcessingJobRequest>
- Specified by:
toBuilder
in classSageMakerRequest
-
builder
public static CreateProcessingJobRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateProcessingJobRequest.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
-
-