StartLoaderJobRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.neptunedata.model.StartLoaderJobRequest

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

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartLoaderJobRequest
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

StartLoaderJobRequest()

Constructors
Constructor and Description
`StartLoaderJobRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StartLoaderJobRequest`	`addParserConfigurationEntry(String key, String value)` Add a single ParserConfiguration entry
`StartLoaderJobRequest`	`clearParserConfigurationEntries()` Removes all the entries added into ParserConfiguration.
`StartLoaderJobRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`List<String>`	`getDependencies()` This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
`Boolean`	`getFailOnError()` `failOnError` – A flag to toggle a complete stop on an error.
`String`	`getFormat()` The format of the data.
`String`	`getIamRoleArn()` The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket.
`String`	`getMode()` The load job mode.
`String`	`getParallelism()` The optional `parallelism` parameter can be set to reduce the number of threads used by the bulk load process.
`Map<String,String>`	`getParserConfiguration()` `parserConfiguration` – An optional object with additional parser configuration values.
`Boolean`	`getQueueRequest()` This is an optional flag parameter that indicates whether the load request can be queued up or not.
`String`	`getS3BucketRegion()` The Amazon region of the S3 bucket.
`String`	`getSource()` The `source` parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders.
`Boolean`	`getUpdateSingleCardinalityProperties()` `updateSingleCardinalityProperties` is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties.
`Boolean`	`getUserProvidedEdgeIds()` This parameter is required only when loading openCypher data that contains relationship IDs.
`int`	`hashCode()`
`Boolean`	`isFailOnError()` `failOnError` – A flag to toggle a complete stop on an error.
`Boolean`	`isQueueRequest()` This is an optional flag parameter that indicates whether the load request can be queued up or not.
`Boolean`	`isUpdateSingleCardinalityProperties()` `updateSingleCardinalityProperties` is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties.
`Boolean`	`isUserProvidedEdgeIds()` This parameter is required only when loading openCypher data that contains relationship IDs.
`void`	`setDependencies(Collection<String> dependencies)` This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
`void`	`setFailOnError(Boolean failOnError)` `failOnError` – A flag to toggle a complete stop on an error.
`void`	`setFormat(String format)` The format of the data.
`void`	`setIamRoleArn(String iamRoleArn)` The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket.
`void`	`setMode(String mode)` The load job mode.
`void`	`setParallelism(String parallelism)` The optional `parallelism` parameter can be set to reduce the number of threads used by the bulk load process.
`void`	`setParserConfiguration(Map<String,String> parserConfiguration)` `parserConfiguration` – An optional object with additional parser configuration values.
`void`	`setQueueRequest(Boolean queueRequest)` This is an optional flag parameter that indicates whether the load request can be queued up or not.
`void`	`setS3BucketRegion(String s3BucketRegion)` The Amazon region of the S3 bucket.
`void`	`setSource(String source)` The `source` parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders.
`void`	`setUpdateSingleCardinalityProperties(Boolean updateSingleCardinalityProperties)` `updateSingleCardinalityProperties` is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties.
`void`	`setUserProvidedEdgeIds(Boolean userProvidedEdgeIds)` This parameter is required only when loading openCypher data that contains relationship IDs.
`String`	`toString()` Returns a string representation of this object.
`StartLoaderJobRequest`	`withDependencies(Collection<String> dependencies)` This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
`StartLoaderJobRequest`	`withDependencies(String... dependencies)` This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
`StartLoaderJobRequest`	`withFailOnError(Boolean failOnError)` `failOnError` – A flag to toggle a complete stop on an error.
`StartLoaderJobRequest`	`withFormat(Format format)` The format of the data.
`StartLoaderJobRequest`	`withFormat(String format)` The format of the data.
`StartLoaderJobRequest`	`withIamRoleArn(String iamRoleArn)` The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket.
`StartLoaderJobRequest`	`withMode(Mode mode)` The load job mode.
`StartLoaderJobRequest`	`withMode(String mode)` The load job mode.
`StartLoaderJobRequest`	`withParallelism(Parallelism parallelism)` The optional `parallelism` parameter can be set to reduce the number of threads used by the bulk load process.
`StartLoaderJobRequest`	`withParallelism(String parallelism)` The optional `parallelism` parameter can be set to reduce the number of threads used by the bulk load process.
`StartLoaderJobRequest`	`withParserConfiguration(Map<String,String> parserConfiguration)` `parserConfiguration` – An optional object with additional parser configuration values.
`StartLoaderJobRequest`	`withQueueRequest(Boolean queueRequest)` This is an optional flag parameter that indicates whether the load request can be queued up or not.
`StartLoaderJobRequest`	`withS3BucketRegion(S3BucketRegion s3BucketRegion)` The Amazon region of the S3 bucket.
`StartLoaderJobRequest`	`withS3BucketRegion(String s3BucketRegion)` The Amazon region of the S3 bucket.
`StartLoaderJobRequest`	`withSource(String source)` The `source` parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders.
`StartLoaderJobRequest`	`withUpdateSingleCardinalityProperties(Boolean updateSingleCardinalityProperties)` `updateSingleCardinalityProperties` is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties.
`StartLoaderJobRequest`	`withUserProvidedEdgeIds(Boolean userProvidedEdgeIds)` This parameter is required only when loading openCypher data that contains relationship IDs.

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

- Constructor Detail
  - StartLoaderJobRequest
```
public StartLoaderJobRequest()
```
- Method Detail
  - setSource
```
public void setSource(String source)
```
    The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    - s3://(bucket_name)/(object-key-name)
    - https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    - https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
    Parameters:
    source - The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    
    s3://(bucket_name)/(object-key-name)
    
    https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    
    https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
  - getSource
```
public String getSource()
```
    The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    - s3://(bucket_name)/(object-key-name)
    - https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    - https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
    Returns:
    The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    
    s3://(bucket_name)/(object-key-name)
    
    https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    
    https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
  - withSource
```
public StartLoaderJobRequest withSource(String source)
```
    The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    - s3://(bucket_name)/(object-key-name)
    - https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    - https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
    Parameters:
    source - The source parameter accepts an S3 URI that identifies a single file, multiple files, a folder, or multiple folders. Neptune loads every data file in any folder that is specified.
    
    The URI can be in any of the following formats.
    
    s3://(bucket_name)/(object-key-name)
    
    https://s3.amazonaws.com/(bucket_name)/(object-key-name)
    
    https://s3.us-east-1.amazonaws.com/(bucket_name)/(object-key-name)
    
    The object-key-name element of the URI is equivalent to the prefix parameter in an S3 ListObjects API call. It identifies all the objects in the specified S3 bucket whose names begin with that prefix. That can be a single file or folder, or multiple files and/or folders.
    
    The specified folder or folders can contain multiple vertex files and multiple edge files.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFormat
```
public void setFormat(String format)
```
    The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    - csv for the Gremlin CSV data format.
    - opencypher for the openCypher CSV data format.
    - ntriples for the N-Triples RDF data format.
    - nquads for the N-Quads RDF data format.
    - rdfxml for the RDF\XML RDF data format.
    - turtle for the Turtle RDF data format.
    Parameters:
    format - The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    
    csv for the Gremlin CSV data format.
    
    opencypher for the openCypher CSV data format.
    
    ntriples for the N-Triples RDF data format.
    
    nquads for the N-Quads RDF data format.
    
    rdfxml for the RDF\XML RDF data format.
    
    turtle for the Turtle RDF data format.
    See Also:
    
    Format
  - getFormat
```
public String getFormat()
```
    The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    - csv for the Gremlin CSV data format.
    - opencypher for the openCypher CSV data format.
    - ntriples for the N-Triples RDF data format.
    - nquads for the N-Quads RDF data format.
    - rdfxml for the RDF\XML RDF data format.
    - turtle for the Turtle RDF data format.
    Returns:
    The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    
    csv for the Gremlin CSV data format.
    
    opencypher for the openCypher CSV data format.
    
    ntriples for the N-Triples RDF data format.
    
    nquads for the N-Quads RDF data format.
    
    rdfxml for the RDF\XML RDF data format.
    
    turtle for the Turtle RDF data format.
    See Also:
    
    Format
  - withFormat
```
public StartLoaderJobRequest withFormat(String format)
```
    The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    - csv for the Gremlin CSV data format.
    - opencypher for the openCypher CSV data format.
    - ntriples for the N-Triples RDF data format.
    - nquads for the N-Quads RDF data format.
    - rdfxml for the RDF\XML RDF data format.
    - turtle for the Turtle RDF data format.
    Parameters:
    format - The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    
    csv for the Gremlin CSV data format.
    
    opencypher for the openCypher CSV data format.
    
    ntriples for the N-Triples RDF data format.
    
    nquads for the N-Quads RDF data format.
    
    rdfxml for the RDF\XML RDF data format.
    
    turtle for the Turtle RDF data format.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Format
  - withFormat
```
public StartLoaderJobRequest withFormat(Format format)
```
    The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    - csv for the Gremlin CSV data format.
    - opencypher for the openCypher CSV data format.
    - ntriples for the N-Triples RDF data format.
    - nquads for the N-Quads RDF data format.
    - rdfxml for the RDF\XML RDF data format.
    - turtle for the Turtle RDF data format.
    Parameters:
    format - The format of the data. For more information about data formats for the Neptune Loader command, see Load Data Formats.
    
    Allowed values
    
    csv for the Gremlin CSV data format.
    
    opencypher for the openCypher CSV data format.
    
    ntriples for the N-Triples RDF data format.
    
    nquads for the N-Quads RDF data format.
    
    rdfxml for the RDF\XML RDF data format.
    
    turtle for the Turtle RDF data format.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Format
  - setS3BucketRegion
```
public void setS3BucketRegion(String s3BucketRegion)
```
    The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Parameters:
    
    s3BucketRegion - The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    See Also:
    
    S3BucketRegion
  - getS3BucketRegion
```
public String getS3BucketRegion()
```
    The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Returns:
    
    The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    See Also:
    
    S3BucketRegion
  - withS3BucketRegion
```
public StartLoaderJobRequest withS3BucketRegion(String s3BucketRegion)
```
    The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Parameters:
    
    s3BucketRegion - The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3BucketRegion
  - withS3BucketRegion
```
public StartLoaderJobRequest withS3BucketRegion(S3BucketRegion s3BucketRegion)
```
    The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Parameters:
    
    s3BucketRegion - The Amazon region of the S3 bucket. This must match the Amazon Region of the DB cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3BucketRegion
  - setIamRoleArn
```
public void setIamRoleArn(String iamRoleArn)
```
    The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
    
    Parameters:
    
    iamRoleArn - The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
  - getIamRoleArn
```
public String getIamRoleArn()
```
    The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
    
    Returns:
    
    The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
  - withIamRoleArn
```
public StartLoaderJobRequest withIamRoleArn(String iamRoleArn)
```
    The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
    
    Parameters:
    
    iamRoleArn - The Amazon Resource Name (ARN) for an IAM role to be assumed by the Neptune DB instance for access to the S3 bucket. The IAM role ARN provided here should be attached to the DB cluster (see Adding the IAM Role to an Amazon Neptune Cluster.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMode
```
public void setMode(String mode)
```
    The load job mode.
    
    Allowed values: RESUME, NEW, AUTO.
    
    Default value: AUTO.
    
    RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
    
    The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
    
    NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
    
    AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
    
    If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
    Parameters:
    
    mode - The load job mode.
    
    Allowed values: RESUME, NEW, AUTO.
    
    Default value: AUTO.
    
    RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
    
    The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
    
    NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
    
    AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
    
    If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
    
    See Also:
    
    Mode
  getMode
  
  public String getMode()
  
  The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  Returns:
  
  The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  See Also:
  
  Mode
  
  withMode
  
  public StartLoaderJobRequest withMode(String mode)
  
  The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  Parameters:
  
  mode - The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  See Also:
  
  Mode
  
  withMode
  
  public StartLoaderJobRequest withMode(Mode mode)
  
  The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  Parameters:
  
  mode - The load job mode.
  
  Allowed values: RESUME, NEW, AUTO.
  
  Default value: AUTO.
  
  RESUME – In RESUME mode, the loader looks for a previous load from this source, and if it finds one, resumes that load job. If no previous load job is found, the loader stops.
  
  The loader avoids reloading files that were successfully loaded in a previous job. It only tries to process failed files. If you dropped previously loaded data from your Neptune cluster, that data is not reloaded in this mode. If a previous load job loaded all files from the same source successfully, nothing is reloaded, and the loader returns success.
  
  NEW – In NEW mode, the creates a new load request regardless of any previous loads. You can use this mode to reload all the data from a source after dropping previously loaded data from your Neptune cluster, or to load new data available at the same source.
  
  AUTO – In AUTO mode, the loader looks for a previous load job from the same source, and if it finds one, resumes that job, just as in RESUME mode.
  
  If the loader doesn't find a previous load job from the same source, it loads all data from the source, just as in NEW mode.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  See Also:
  
  Mode
  
  setFailOnError
  
  public void setFailOnError(Boolean failOnError)
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  Parameters:
  
  failOnError - failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  getFailOnError
  
  public Boolean getFailOnError()
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  Returns:
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  withFailOnError
  
  public StartLoaderJobRequest withFailOnError(Boolean failOnError)
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  Parameters:
  
  failOnError - failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  isFailOnError
  
  public Boolean isFailOnError()
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  Returns:
  
  failOnError – A flag to toggle a complete stop on an error.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "TRUE".
  
  When this parameter is set to "FALSE", the loader tries to load all the data in the location specified, skipping any entries with errors.
  
  When this parameter is set to "TRUE", the loader stops as soon as it encounters an error. Data loaded up to that point persists.
  
  setParallelism
  
  public void setParallelism(String parallelism)
  
  The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Parameters:
  
  parallelism - The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  See Also:
  
  Parallelism
  
  getParallelism
  
  public String getParallelism()
  
  The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Returns:
  
  The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  See Also:
  
  Parallelism
  
  withParallelism
  
  public StartLoaderJobRequest withParallelism(String parallelism)
  
  The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Parameters:
  
  parallelism - The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  See Also:
  
  Parallelism
  
  withParallelism
  
  public StartLoaderJobRequest withParallelism(Parallelism parallelism)
  
  The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Parameters:
  
  parallelism - The optional parallelism parameter can be set to reduce the number of threads used by the bulk load process.
  
  Allowed values:
  
  LOW – The number of threads used is the number of available vCPUs divided by 8.
  
  MEDIUM – The number of threads used is the number of available vCPUs divided by 2.
  
  HIGH – The number of threads used is the same as the number of available vCPUs.
  
  OVERSUBSCRIBE – The number of threads used is the number of available vCPUs multiplied by 2. If this value is used, the bulk loader takes up all available resources.
  
  This does not mean, however, that the OVERSUBSCRIBE setting results in 100% CPU utilization. Because the load operation is I/O bound, the highest CPU utilization to expect is in the 60% to 70% range.
  
  Default value: HIGH
  
  The parallelism setting can sometimes result in a deadlock between threads when loading openCypher data. When this happens, Neptune returns the LOAD_DATA_DEADLOCK error. You can generally fix the issue by setting parallelism to a lower setting and retrying the load command.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  See Also:
  
  Parallelism
  
  getParserConfiguration
  
  public Map<String,String> getParserConfiguration()
  
  parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  Returns:
  
  parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  setParserConfiguration
  
  public void setParserConfiguration(Map<String,String> parserConfiguration)
  
  parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  Parameters:
  
  parserConfiguration - parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  withParserConfiguration
  
  public StartLoaderJobRequest withParserConfiguration(Map<String,String> parserConfiguration)
  
  parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  Parameters:
  
  parserConfiguration - parserConfiguration – An optional object with additional parser configuration values. Each of the child parameters is also optional:
  
  namedGraphUri – The default graph for all RDF formats when no graph is specified (for non-quads formats and NQUAD entries with no graph).
  
  The default is https://aws.amazon.com/neptune/vocab/v01/DefaultNamedGraph.
  
  baseUri – The base URI for RDF/XML and Turtle formats.
  
  The default is https://aws.amazon.com/neptune/default.
  
  allowEmptyStrings – Gremlin users need to be able to pass empty string values("") as node and edge properties when loading CSV data. If allowEmptyStrings is set to false (the default), such empty strings are treated as nulls and are not loaded.
  
  If allowEmptyStrings is set to true, the loader treats empty strings as valid property values and loads them accordingly.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  addParserConfigurationEntry
  
  public StartLoaderJobRequest addParserConfigurationEntry(String key, String value)
  
  Add a single ParserConfiguration entry
  
  See Also:
  
  withParserConfiguration(java.util.Map<java.lang.String, java.lang.String>)
  
  clearParserConfigurationEntries
  
  public StartLoaderJobRequest clearParserConfigurationEntries()
  
  Removes all the entries added into ParserConfiguration.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  setUpdateSingleCardinalityProperties
  
  public void setUpdateSingleCardinalityProperties(Boolean updateSingleCardinalityProperties)
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  Parameters:
  
  updateSingleCardinalityProperties - updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  getUpdateSingleCardinalityProperties
  
  public Boolean getUpdateSingleCardinalityProperties()
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  Returns:
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  withUpdateSingleCardinalityProperties
  
  public StartLoaderJobRequest withUpdateSingleCardinalityProperties(Boolean updateSingleCardinalityProperties)
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  Parameters:
  
  updateSingleCardinalityProperties - updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  isUpdateSingleCardinalityProperties
  
  public Boolean isUpdateSingleCardinalityProperties()
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  Returns:
  
  updateSingleCardinalityProperties is an optional parameter that controls how the bulk loader treats a new value for single-cardinality vertex or edge properties. This is not supported for loading openCypher data.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  By default, or when updateSingleCardinalityProperties is explicitly set to "FALSE", the loader treats a new value as an error, because it violates single cardinality.
  
  When updateSingleCardinalityProperties is set to "TRUE", on the other hand, the bulk loader replaces the existing value with the new one. If multiple edge or single-cardinality vertex property values are provided in the source file(s) being loaded, the final value at the end of the bulk load could be any one of those new values. The loader only guarantees that the existing value has been replaced by one of the new ones.
  
  setQueueRequest
  
  public void setQueueRequest(Boolean queueRequest)
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  Parameters:
  
  queueRequest - This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  getQueueRequest
  
  public Boolean getQueueRequest()
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  Returns:
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  withQueueRequest
  
  public StartLoaderJobRequest withQueueRequest(Boolean queueRequest)
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  Parameters:
  
  queueRequest - This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  isQueueRequest
  
  public Boolean isQueueRequest()
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  Returns:
  
  This is an optional flag parameter that indicates whether the load request can be queued up or not.
  
  You don't have to wait for one load job to complete before issuing the next one, because Neptune can queue up as many as 64 jobs at a time, provided that their queueRequest parameters are all set to "TRUE". The queue order of the jobs will be first-in-first-out (FIFO).
  
  If the queueRequest parameter is omitted or set to "FALSE", the load request will fail if another load job is already running.
  
  Allowed values: "TRUE", "FALSE".
  
  Default value: "FALSE".
  
  getDependencies
  
  public List<String> getDependencies()
  
  This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  Returns:
  
  This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  setDependencies
  
  public void setDependencies(Collection<String> dependencies)
  
  This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  Parameters:
  
  dependencies - This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  withDependencies
  
  public StartLoaderJobRequest withDependencies(String... dependencies)
  
  This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  NOTE: This method appends the values to the existing list (if any). Use setDependencies(java.util.Collection) or withDependencies(java.util.Collection) if you want to override the existing values.
  
  Parameters:
  
  dependencies - This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  withDependencies
  
  public StartLoaderJobRequest withDependencies(Collection<String> dependencies)
  
  This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  Parameters:
  
  dependencies - This is an optional parameter that can make a queued load request contingent on the successful completion of one or more previous jobs in the queue.
  
  Neptune can queue up as many as 64 load requests at a time, if their queueRequest parameters are set to "TRUE". The dependencies parameter lets you make execution of such a queued request dependent on the successful completion of one or more specified previous requests in the queue.
  
  For example, if load Job-A and Job-B are independent of each other, but load Job-C needs Job-A and Job-B to be finished before it begins, proceed as follows:
  
  Submit load-job-A and load-job-B one after another in any order, and save their load-ids.
  
  Submit load-job-C with the load-ids of the two jobs in its dependencies field:
  
  Because of the dependencies parameter, the bulk loader will not start Job-C until Job-A and Job-B have completed successfully. If either one of them fails, Job-C will not be executed, and its status will be set to LOAD_FAILED_BECAUSE_DEPENDENCY_NOT_SATISFIED.
  
  You can set up multiple levels of dependency in this way, so that the failure of one job will cause all requests that are directly or indirectly dependent on it to be cancelled.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  setUserProvidedEdgeIds
  
  public void setUserProvidedEdgeIds(Boolean userProvidedEdgeIds)
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  Parameters:
  
  userProvidedEdgeIds - This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  getUserProvidedEdgeIds
  
  public Boolean getUserProvidedEdgeIds()
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  Returns:
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  withUserProvidedEdgeIds
  
  public StartLoaderJobRequest withUserProvidedEdgeIds(Boolean userProvidedEdgeIds)
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  Parameters:
  
  userProvidedEdgeIds - This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  Returns:
  
  Returns a reference to this object so that method calls can be chained together.
  
  isUserProvidedEdgeIds
  
  public Boolean isUserProvidedEdgeIds()
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  Returns:
  
  This parameter is required only when loading openCypher data that contains relationship IDs. It must be included and set to True when openCypher relationship IDs are explicitly provided in the load data (recommended).
  
  When userProvidedEdgeIds is absent or set to True, an :ID column must be present in every relationship file in the load.
  
  When userProvidedEdgeIds is present and set to False, relationship files in the load must not contain an :ID column. Instead, the Neptune loader automatically generates an ID for each relationship.
  
  It's useful to provide relationship IDs explicitly so that the loader can resume loading after error in the CSV data have been fixed, without having to reload any relationships that have already been loaded. If relationship IDs have not been explicitly assigned, the loader cannot resume a failed load if any relationship file has had to be corrected, and must instead reload all the relationships.
  
  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 StartLoaderJobRequest 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()

AWS SDK for Java 1.x API Reference - 1.12.771

Class StartLoaderJobRequest

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

StartLoaderJobRequest

Method Detail

setSource

getSource

withSource

setFormat

getFormat

withFormat

withFormat

setS3BucketRegion

getS3BucketRegion

withS3BucketRegion

withS3BucketRegion

setIamRoleArn

getIamRoleArn

withIamRoleArn

setMode

getMode

withMode

withMode

setFailOnError

getFailOnError

withFailOnError

isFailOnError

setParallelism

getParallelism

withParallelism

withParallelism

getParserConfiguration

setParserConfiguration

withParserConfiguration

addParserConfigurationEntry

clearParserConfigurationEntries

setUpdateSingleCardinalityProperties

getUpdateSingleCardinalityProperties

withUpdateSingleCardinalityProperties

isUpdateSingleCardinalityProperties

setQueueRequest

getQueueRequest

withQueueRequest

isQueueRequest

getDependencies

setDependencies

withDependencies

withDependencies

setUserProvidedEdgeIds

getUserProvidedEdgeIds

withUserProvidedEdgeIds

isUserProvidedEdgeIds

toString

equals

hashCode

clone