Package software.amazon.awssdk.services.neptunegraph.model

Class StartImportTaskRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphRequest

software.amazon.awssdk.services.neptunegraph.model.StartImportTaskRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<StartImportTaskRequest.Builder,StartImportTaskRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartImportTaskRequest
extends NeptuneGraphRequest
implements ToCopyableBuilder<StartImportTaskRequest.Builder,StartImportTaskRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	StartImportTaskRequest.Builder

Method Summary

Modifier and Type	Method	Description
BlankNodeHandling	blankNodeHandling()	The method to handle blank nodes in the dataset.
String	blankNodeHandlingAsString()	The method to handle blank nodes in the dataset.
static StartImportTaskRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	failOnError()	If set to true, the task halts when an import error is encountered.
Format	format()	Specifies the format of Amazon S3 data to be imported.
String	formatAsString()	Specifies the format of Amazon S3 data to be imported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	graphIdentifier()	The unique identifier of the Neptune Analytics graph.
int	hashCode()
ImportOptions	importOptions()	Returns the value of the ImportOptions property for this object.
String	roleArn()	The ARN of the IAM role that will allow access to the data that is to be imported.
List<SdkField<?>>	sdkFields()
static Class<? extends StartImportTaskRequest.Builder>	serializableBuilderClass()
String	source()	A URL identifying the location of the data to be imported.
StartImportTaskRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

importOptions

public final ImportOptions importOptions()

Returns the value of the ImportOptions property for this object.

Returns:

The value of the ImportOptions property for this object.

failOnError

public final Boolean failOnError()

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

Returns:

If set to true, the task halts when an import error is encountered. If set to false, the task skips the data that caused the error and continues if possible.

source

public final String source()

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

Returns:

A URL identifying the location of the data to be imported. This can be an Amazon S3 path, or can point to a Neptune database endpoint or snapshot.

format

public final Format format()

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

See Also:

Format

formatAsString

public final String formatAsString()

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

If the service returns an enum value that is not available in the current SDK version, format will return Format.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

Specifies the format of Amazon S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.

See Also:

Format

blankNodeHandling

public final BlankNodeHandling blankNodeHandling()

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

If the service returns an enum value that is not available in the current SDK version, blankNodeHandling will return BlankNodeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blankNodeHandlingAsString().

Returns:

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

See Also:

BlankNodeHandling

blankNodeHandlingAsString

public final String blankNodeHandlingAsString()

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

If the service returns an enum value that is not available in the current SDK version, blankNodeHandling will return BlankNodeHandling.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from blankNodeHandlingAsString().

Returns:

The method to handle blank nodes in the dataset. Currently, only convertToIri is supported, meaning blank nodes are converted to unique IRIs at load time. Must be provided when format is ntriples. For more information, see Handling RDF values.

See Also:

BlankNodeHandling

graphIdentifier

public final String graphIdentifier()

The unique identifier of the Neptune Analytics graph.

Returns:

The unique identifier of the Neptune Analytics graph.

roleArn

public final String roleArn()

The ARN of the IAM role that will allow access to the data that is to be imported.

Returns:

The ARN of the IAM role that will allow access to the data that is to be imported.

toBuilder

public StartImportTaskRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<StartImportTaskRequest.Builder,StartImportTaskRequest>

Specified by:

toBuilder in class NeptuneGraphRequest

builder

public static StartImportTaskRequest.Builder builder()

serializableBuilderClass

public static Class<? extends StartImportTaskRequest.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