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

Interface CreateGraphUsingImportTaskRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateGraphUsingImportTaskRequest.Builder,CreateGraphUsingImportTaskRequest>, NeptuneGraphRequest.Builder, SdkBuilder<CreateGraphUsingImportTaskRequest.Builder,CreateGraphUsingImportTaskRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateGraphUsingImportTaskRequest
public static interface CreateGraphUsingImportTaskRequest.Builder extends NeptuneGraphRequest.Builder, SdkPojo, CopyableBuilder<CreateGraphUsingImportTaskRequest.Builder,CreateGraphUsingImportTaskRequest>

  • Method Details

    • graphName

      CreateGraphUsingImportTaskRequest.Builder graphName(String graphName)

      A name for the new Neptune Analytics graph to be created.

      The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

      Parameters:
      graphName - A name for the new Neptune Analytics graph to be created.

      The name must contain from 1 to 63 letters, numbers, or hyphens, and its first character must be a letter. It cannot end with a hyphen or contain two consecutive hyphens.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateGraphUsingImportTaskRequest.Builder tags(Map<String,String> tags)

      Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.

      Parameters:
      tags - Adds metadata tags to the new graph. These tags can also be used with cost allocation reporting, or used in a Condition statement in an IAM policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • publicConnectivity

      CreateGraphUsingImportTaskRequest.Builder publicConnectivity(Boolean publicConnectivity)

      Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).

      Parameters:
      publicConnectivity - Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (true to enable, or false to disable).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyIdentifier

      CreateGraphUsingImportTaskRequest.Builder kmsKeyIdentifier(String kmsKeyIdentifier)

      Specifies a KMS key to use to encrypt data imported into the new graph.

      Parameters:
      kmsKeyIdentifier - Specifies a KMS key to use to encrypt data imported into the new graph.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectorSearchConfiguration

      CreateGraphUsingImportTaskRequest.Builder vectorSearchConfiguration(VectorSearchConfiguration vectorSearchConfiguration)

      Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension=value. Max = 65,535

      Parameters:
      vectorSearchConfiguration - Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension=value. Max = 65,535
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • vectorSearchConfiguration

      default CreateGraphUsingImportTaskRequest.Builder vectorSearchConfiguration(Consumer<VectorSearchConfiguration.Builder> vectorSearchConfiguration)

      Specifies the number of dimensions for vector embeddings that will be loaded into the graph. The value is specified as dimension=value. Max = 65,535

      This is a convenience method that creates an instance of the VectorSearchConfiguration.Builder avoiding the need to create one manually via VectorSearchConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to vectorSearchConfiguration(VectorSearchConfiguration).

      Parameters:
      vectorSearchConfiguration - a consumer that will call methods on VectorSearchConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • replicaCount

      CreateGraphUsingImportTaskRequest.Builder replicaCount(Integer replicaCount)

      The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

      Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

      Parameters:
      replicaCount - The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.

      Additional charges equivalent to the m-NCUs selected for the graph apply for each replica.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deletionProtection

      CreateGraphUsingImportTaskRequest.Builder deletionProtection(Boolean deletionProtection)

      Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).

      Parameters:
      deletionProtection - Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (true or false).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importOptions

      CreateGraphUsingImportTaskRequest.Builder importOptions(ImportOptions importOptions)

      Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

      Parameters:
      importOptions - Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • importOptions

      default CreateGraphUsingImportTaskRequest.Builder importOptions(Consumer<ImportOptions.Builder> importOptions)

      Contains options for controlling the import process. For example, if the failOnError key is set to false, the import skips problem data and attempts to continue (whereas if set to true, the default, or if omitted, the import operation halts immediately when an error is encountered.

      This is a convenience method that creates an instance of the ImportOptions.Builder avoiding the need to create one manually via ImportOptions.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to importOptions(ImportOptions).

      Parameters:
      importOptions - a consumer that will call methods on ImportOptions.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxProvisionedMemory

      CreateGraphUsingImportTaskRequest.Builder maxProvisionedMemory(Integer maxProvisionedMemory)

      The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.

      If both the minimum and maximum values are specified, the max of the min-provisioned-memory and max-provisioned memory is used to create the graph. If neither value is specified 128 m-NCUs are used.

      Parameters:
      maxProvisionedMemory - The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 1024, or the approved upper limit for your account.

      If both the minimum and maximum values are specified, the max of the min-provisioned-memory and max-provisioned memory is used to create the graph. If neither value is specified 128 m-NCUs are used.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • minProvisionedMemory

      CreateGraphUsingImportTaskRequest.Builder minProvisionedMemory(Integer minProvisionedMemory)

      The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128

      Parameters:
      minProvisionedMemory - The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failOnError

      CreateGraphUsingImportTaskRequest.Builder failOnError(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • source

      CreateGraphUsingImportTaskRequest.Builder source(String source)

      A URL identifying to 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.

      Parameters:
      source - A URL identifying to 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:
      Returns a reference to this object so that method calls can be chained together.

    • format

      CreateGraphUsingImportTaskRequest.Builder format(String format)

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

      Parameters:
      format - Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      CreateGraphUsingImportTaskRequest.Builder format(Format format)

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

      Parameters:
      format - Specifies the format of S3 data to be imported. Valid values are CSV, which identifies the Gremlin CSV format or OPENCYPHER, which identies the openCypher load format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blankNodeHandling

      CreateGraphUsingImportTaskRequest.Builder blankNodeHandling(String 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • blankNodeHandling

      CreateGraphUsingImportTaskRequest.Builder blankNodeHandling(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • roleArn

      CreateGraphUsingImportTaskRequest.Builder roleArn(String roleArn)

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

      Parameters:
      roleArn - The ARN of the IAM role that will allow access to the data that is to be imported.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateGraphUsingImportTaskRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateGraphUsingImportTaskRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.