CreateCompilationJobRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.sagemaker.model

Class CreateCompilationJobRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemaker.model.CreateCompilationJobRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCompilationJobRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

CreateCompilationJobRequest ()

Constructors
Constructor and Description
`CreateCompilationJobRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`CreateCompilationJobRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getCompilationJobName ()` A name for the model compilation job.
`InputConfig`	`getInputConfig ()` Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
`String`	`getModelPackageVersionArn ()` The Amazon Resource Name (ARN) of a versioned model package.
`OutputConfig`	`getOutputConfig ()` Provides information about the output location for the compiled model and the target device the model runs on.
`String`	`getRoleArn ()` The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
`StoppingCondition`	`getStoppingCondition ()` Specifies a limit to how long a model compilation job can run.
`List<Tag>`	`getTags ()` An array of key-value pairs.
`NeoVpcConfig`	`getVpcConfig ()` A VpcConfig object that specifies the VPC that you want your compilation job to connect to.
`int`	`hashCode ()`
`void`	`setCompilationJobName (String compilationJobName)` A name for the model compilation job.
`void`	`setInputConfig (InputConfig inputConfig)` Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
`void`	`setModelPackageVersionArn (String modelPackageVersionArn)` The Amazon Resource Name (ARN) of a versioned model package.
`void`	`setOutputConfig (OutputConfig outputConfig)` Provides information about the output location for the compiled model and the target device the model runs on.
`void`	`setRoleArn (String roleArn)` The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
`void`	`setStoppingCondition (StoppingCondition stoppingCondition)` Specifies a limit to how long a model compilation job can run.
`void`	`setTags (Collection<Tag> tags)` An array of key-value pairs.
`void`	`setVpcConfig (NeoVpcConfig vpcConfig)` A VpcConfig object that specifies the VPC that you want your compilation job to connect to.
`String`	`toString ()` Returns a string representation of this object.
`CreateCompilationJobRequest`	`withCompilationJobName (String compilationJobName)` A name for the model compilation job.
`CreateCompilationJobRequest`	`withInputConfig (InputConfig inputConfig)` Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
`CreateCompilationJobRequest`	`withModelPackageVersionArn (String modelPackageVersionArn)` The Amazon Resource Name (ARN) of a versioned model package.
`CreateCompilationJobRequest`	`withOutputConfig (OutputConfig outputConfig)` Provides information about the output location for the compiled model and the target device the model runs on.
`CreateCompilationJobRequest`	`withRoleArn (String roleArn)` The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
`CreateCompilationJobRequest`	`withStoppingCondition (StoppingCondition stoppingCondition)` Specifies a limit to how long a model compilation job can run.
`CreateCompilationJobRequest`	`withTags (Collection<Tag> tags)` An array of key-value pairs.
`CreateCompilationJobRequest`	`withTags (Tag... tags)` An array of key-value pairs.
`CreateCompilationJobRequest`	`withVpcConfig (NeoVpcConfig vpcConfig)` A VpcConfig object that specifies the VPC that you want your compilation job to connect to.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreateCompilationJobRequest
```
public CreateCompilationJobRequest()
```
- Method Detail
  - setCompilationJobName
```
public void setCompilationJobName(String compilationJobName)
```
    A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
    
    Parameters:
    
    compilationJobName - A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
  - getCompilationJobName
```
public String getCompilationJobName()
```
    A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
    
    Returns:
    
    A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
  - withCompilationJobName
```
public CreateCompilationJobRequest withCompilationJobName(String compilationJobName)
```
    A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
    
    Parameters:
    
    compilationJobName - A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    - Read input data from an S3 bucket
    - Write model artifacts to an S3 bucket
    - Write logs to Amazon CloudWatch Logs
    - Publish metrics to Amazon CloudWatch
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
    Parameters:
    roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    
    Read input data from an S3 bucket
    
    Write model artifacts to an S3 bucket
    
    Write logs to Amazon CloudWatch Logs
    
    Publish metrics to Amazon CloudWatch
    
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
  - getRoleArn
```
public String getRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    - Read input data from an S3 bucket
    - Write model artifacts to an S3 bucket
    - Write logs to Amazon CloudWatch Logs
    - Publish metrics to Amazon CloudWatch
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
    Returns:
    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    
    Read input data from an S3 bucket
    
    Write model artifacts to an S3 bucket
    
    Write logs to Amazon CloudWatch Logs
    
    Publish metrics to Amazon CloudWatch
    
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
  - withRoleArn
```
public CreateCompilationJobRequest withRoleArn(String roleArn)
```
    The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    - Read input data from an S3 bucket
    - Write model artifacts to an S3 bucket
    - Write logs to Amazon CloudWatch Logs
    - Publish metrics to Amazon CloudWatch
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
    Parameters:
    roleArn - The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
    
    During model compilation, Amazon SageMaker needs your permission to:
    
    Read input data from an S3 bucket
    
    Write model artifacts to an S3 bucket
    
    Write logs to Amazon CloudWatch Logs
    
    Publish metrics to Amazon CloudWatch
    
    You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setModelPackageVersionArn
```
public void setModelPackageVersionArn(String modelPackageVersionArn)
```
    The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
    
    Parameters:
    
    modelPackageVersionArn - The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
  - getModelPackageVersionArn
```
public String getModelPackageVersionArn()
```
    The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
  - withModelPackageVersionArn
```
public CreateCompilationJobRequest withModelPackageVersionArn(String modelPackageVersionArn)
```
    The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
    
    Parameters:
    
    modelPackageVersionArn - The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputConfig
```
public void setInputConfig(InputConfig inputConfig)
```
    Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
    
    Parameters:
    
    inputConfig - Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
  - getInputConfig
```
public InputConfig getInputConfig()
```
    Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
    
    Returns:
    
    Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
  - withInputConfig
```
public CreateCompilationJobRequest withInputConfig(InputConfig inputConfig)
```
    Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
    
    Parameters:
    
    inputConfig - Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOutputConfig
```
public void setOutputConfig(OutputConfig outputConfig)
```
    Provides information about the output location for the compiled model and the target device the model runs on.
    
    Parameters:
    
    outputConfig - Provides information about the output location for the compiled model and the target device the model runs on.
  - getOutputConfig
```
public OutputConfig getOutputConfig()
```
    Provides information about the output location for the compiled model and the target device the model runs on.
    
    Returns:
    
    Provides information about the output location for the compiled model and the target device the model runs on.
  - withOutputConfig
```
public CreateCompilationJobRequest withOutputConfig(OutputConfig outputConfig)
```
    Provides information about the output location for the compiled model and the target device the model runs on.
    
    Parameters:
    
    outputConfig - Provides information about the output location for the compiled model and the target device the model runs on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVpcConfig
```
public void setVpcConfig(NeoVpcConfig vpcConfig)
```
    A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
    
    Parameters:
    
    vpcConfig - A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
  - getVpcConfig
```
public NeoVpcConfig getVpcConfig()
```
    A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
    
    Returns:
    
    A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
  - withVpcConfig
```
public CreateCompilationJobRequest withVpcConfig(NeoVpcConfig vpcConfig)
```
    A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
    
    Parameters:
    
    vpcConfig - A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStoppingCondition
```
public void setStoppingCondition(StoppingCondition stoppingCondition)
```
    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
    
    Parameters:
    
    stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
  - getStoppingCondition
```
public StoppingCondition getStoppingCondition()
```
    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
    
    Returns:
    
    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
  - withStoppingCondition
```
public CreateCompilationJobRequest withStoppingCondition(StoppingCondition stoppingCondition)
```
    Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
    
    Parameters:
    
    stoppingCondition - Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    Returns:
    
    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    Parameters:
    
    tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
  - withTags
```
public CreateCompilationJobRequest withTags(Tag... tags)
```
    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreateCompilationJobRequest withTags(Collection<Tag> tags)
```
    An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    Parameters:
    
    tags - An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CreateCompilationJobRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class CreateCompilationJobRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

CreateCompilationJobRequest

Method Detail

setCompilationJobName

getCompilationJobName

withCompilationJobName

setRoleArn

getRoleArn

withRoleArn

setModelPackageVersionArn

getModelPackageVersionArn

withModelPackageVersionArn

setInputConfig

getInputConfig

withInputConfig

setOutputConfig

getOutputConfig

withOutputConfig

setVpcConfig

getVpcConfig

withVpcConfig

setStoppingCondition

getStoppingCondition

withStoppingCondition

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone