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>

  • Method Details

    • 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:

    • 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:

    • parquetType

      public final ParquetType parquetType()

      The parquet type of the import task.

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

      Returns:
      The parquet type of the import task.
      See Also:

    • parquetTypeAsString

      public final String parquetTypeAsString()

      The parquet type of the import task.

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

      Returns:
      The parquet type of the import task.
      See Also:

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<StartImportTaskRequest.Builder,StartImportTaskRequest>
      Specified by:
      toBuilder in class NeptuneGraphRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.