StartMlDataProcessingJobRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.neptunedata.model.NeptunedataRequest
    - - software.amazon.awssdk.services.neptunedata.model.StartMlDataProcessingJobRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartMlDataProcessingJobRequest.Builder,StartMlDataProcessingJobRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartMlDataProcessingJobRequest
extends NeptunedataRequest
implements ToCopyableBuilder<StartMlDataProcessingJobRequest.Builder,StartMlDataProcessingJobRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartMlDataProcessingJobRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartMlDataProcessingJobRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartMlDataProcessingJobRequest.Builder`	`builder()`
`String`	`configFileName()` A data specification file that describes how to load the exported graph data for training.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSecurityGroupIds()` For responses, this returns true if the service returned a value for the SecurityGroupIds property.
`boolean`	`hasSubnets()` For responses, this returns true if the service returned a value for the Subnets property.
`String`	`id()` A unique identifier for the new job.
`String`	`inputDataS3Location()` The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.
`String`	`modelType()` One of the two model types that Neptune ML currently supports: heterogeneous graph models ( `heterogeneous`), and knowledge graph (`kge`).
`String`	`neptuneIamRoleArn()` The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf.
`String`	`previousDataProcessingJobId()` The job ID of a completed data processing job run on an earlier version of the data.
`String`	`processedDataS3Location()` The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.
`String`	`processingInstanceType()` The type of ML instance used during data processing.
`Integer`	`processingInstanceVolumeSizeInGB()` The disk volume size of the processing instance.
`Integer`	`processingTimeOutInSeconds()` Timeout in seconds for the data processing job.
`String`	`s3OutputEncryptionKMSKey()` The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job.
`String`	`sagemakerIamRoleArn()` The ARN of an IAM role for SageMaker execution.
`List<SdkField<?>>`	`sdkFields()`
`List<String>`	`securityGroupIds()` The VPC security group IDs.
`static Class<? extends StartMlDataProcessingJobRequest.Builder>`	`serializableBuilderClass()`
`List<String>`	`subnets()` The IDs of the subnets in the Neptune VPC.
`StartMlDataProcessingJobRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`volumeEncryptionKMSKey()` The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job.

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
  - id
```
public final String id()
```
    A unique identifier for the new job. The default is an autogenerated UUID.
    
    Returns:
    
    A unique identifier for the new job. The default is an autogenerated UUID.
  - previousDataProcessingJobId
```
public final String previousDataProcessingJobId()
```
    The job ID of a completed data processing job run on an earlier version of the data.
    
    Returns:
    
    The job ID of a completed data processing job run on an earlier version of the data.
  - inputDataS3Location
```
public final String inputDataS3Location()
```
    The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.
    
    Returns:
    
    The URI of the Amazon S3 location where you want SageMaker to download the data needed to run the data processing job.
  - processedDataS3Location
```
public final String processedDataS3Location()
```
    The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.
    
    Returns:
    
    The URI of the Amazon S3 location where you want SageMaker to save the results of a data processing job.
  - sagemakerIamRoleArn
```
public final String sagemakerIamRoleArn()
```
    The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.
    
    Returns:
    
    The ARN of an IAM role for SageMaker execution. This must be listed in your DB cluster parameter group or an error will occur.
  - neptuneIamRoleArn
```
public final String neptuneIamRoleArn()
```
    The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role that SageMaker can assume to perform tasks on your behalf. This must be listed in your DB cluster parameter group or an error will occur.
  - processingInstanceType
```
public final String processingInstanceType()
```
    The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.
    
    Returns:
    
    The type of ML instance used during data processing. Its memory should be large enough to hold the processed dataset. The default is the smallest ml.r5 type whose memory is ten times larger than the size of the exported graph data on disk.
  - processingInstanceVolumeSizeInGB
```
public final Integer processingInstanceVolumeSizeInGB()
```
    The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.
    
    Returns:
    
    The disk volume size of the processing instance. Both input data and processed data are stored on disk, so the volume size must be large enough to hold both data sets. The default is 0. If not specified or 0, Neptune ML chooses the volume size automatically based on the data size.
  - processingTimeOutInSeconds
```
public final Integer processingTimeOutInSeconds()
```
    Timeout in seconds for the data processing job. The default is 86,400 (1 day).
    
    Returns:
    
    Timeout in seconds for the data processing job. The default is 86,400 (1 day).
  - modelType
```
public final String modelType()
```
    One of the two model types that Neptune ML currently supports: heterogeneous graph models ( heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.
    
    Returns:
    
    One of the two model types that Neptune ML currently supports: heterogeneous graph models ( heterogeneous), and knowledge graph (kge). The default is none. If not specified, Neptune ML chooses the model type automatically based on the data.
  - configFileName
```
public final String configFileName()
```
    A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.
    
    Returns:
    
    A data specification file that describes how to load the exported graph data for training. The file is automatically generated by the Neptune export toolkit. The default is training-data-configuration.json.
  - hasSubnets
```
public final boolean hasSubnets()
```
    For responses, this returns true if the service returned a value for the Subnets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - subnets
```
public final List<String> subnets()
```
    The IDs of the subnets in the Neptune VPC. The default is None.
    
    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 hasSubnets() method.
    
    Returns:
    
    The IDs of the subnets in the Neptune VPC. The default is None.
  - hasSecurityGroupIds
```
public final boolean hasSecurityGroupIds()
```
    For responses, this returns true if the service returned a value for the SecurityGroupIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - securityGroupIds
```
public final List<String> securityGroupIds()
```
    The VPC security group IDs. The default is None.
    
    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 hasSecurityGroupIds() method.
    
    Returns:
    
    The VPC security group IDs. The default is None.
  - volumeEncryptionKMSKey
```
public final String volumeEncryptionKMSKey()
```
    The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.
    
    Returns:
    
    The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt data on the storage volume attached to the ML compute instances that run the training job. The default is None.
  - s3OutputEncryptionKMSKey
```
public final String s3OutputEncryptionKMSKey()
```
    The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.
    
    Returns:
    
    The Amazon Key Management Service (Amazon KMS) key that SageMaker uses to encrypt the output of the processing job. The default is none.
  - toBuilder
```
public StartMlDataProcessingJobRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartMlDataProcessingJobRequest.Builder,StartMlDataProcessingJobRequest>
    
    Specified by:
    
    toBuilder in class NeptunedataRequest
  - builder
```
public static StartMlDataProcessingJobRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartMlDataProcessingJobRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartMlDataProcessingJobRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

id

previousDataProcessingJobId

inputDataS3Location

processedDataS3Location

sagemakerIamRoleArn

neptuneIamRoleArn

processingInstanceType

processingInstanceVolumeSizeInGB

processingTimeOutInSeconds

modelType

configFileName

hasSubnets

subnets

hasSecurityGroupIds

securityGroupIds

volumeEncryptionKMSKey

s3OutputEncryptionKMSKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields