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.CreateGraphUsingImportTaskRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateGraphUsingImportTaskRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateGraphUsingImportTaskRequest.Builder`	`builder()`
`Boolean`	`deletionProtection()`	Indicates whether or not to enable deletion protection on the graph.
`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 S3 data to be imported.
`String`	`formatAsString()`	Specifies the format of S3 data to be imported.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`String`	`graphName()`	A name for the new Neptune Analytics graph to be created.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`ImportOptions`	`importOptions()`	Contains options for controlling the import process.
`String`	`kmsKeyIdentifier()`	Specifies a KMS key to use to encrypt data imported into the new graph.
`Integer`	`maxProvisionedMemory()`	The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
`Integer`	`minProvisionedMemory()`	The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.
`Boolean`	`publicConnectivity()`	Specifies whether or not the graph can be reachable over the internet.
`Integer`	`replicaCount()`	The number of replicas in other AZs to provision on the new graph after import.
`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 CreateGraphUsingImportTaskRequest.Builder>`	`serializableBuilderClass()`
`String`	`source()`	A URL identifying to the location of the data to be imported.
`Map<String,String>`	`tags()`	Adds metadata tags to the new graph.
`CreateGraphUsingImportTaskRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VectorSearchConfiguration`	`vectorSearchConfiguration()`	Specifies the number of dimensions for vector embeddings that will be loaded into the graph.

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
  - graphName
```
public final 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.
    
    Returns:
    
    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.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - tags
```
public final 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.
    
    Returns:
    
    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.
  - publicConnectivity
```
public final Boolean publicConnectivity()
```
    Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. ( true to enable, or false to disable.
    
    Returns:
    
    Specifies whether or not the graph can be reachable over the internet. All access to graphs IAM authenticated. (true to enable, or false to disable.
  - kmsKeyIdentifier
```
public final String kmsKeyIdentifier()
```
    Specifies a KMS key to use to encrypt data imported into the new graph.
    
    Returns:
    
    Specifies a KMS key to use to encrypt data imported into the new graph.
  - vectorSearchConfiguration
```
public final 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
    
    Returns:
    
    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
  - replicaCount
```
public final Integer replicaCount()
```
    The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.
    
    Returns:
    
    The number of replicas in other AZs to provision on the new graph after import. Default = 0, Min = 0, Max = 2.
  - deletionProtection
```
public final 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).
    
    Returns:
    
    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).
  - importOptions
```
public final 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.
    
    Returns:
    
    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.
  - maxProvisionedMemory
```
public final 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.
    
    Returns:
    
    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.
  - minProvisionedMemory
```
public final Integer minProvisionedMemory()
```
    The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128
    
    Returns:
    
    The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Default: 128
  - 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 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:
    
    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.
  - format
```
public final 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.
    
    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 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 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 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
  - 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 CreateGraphUsingImportTaskRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateGraphUsingImportTaskRequest.Builder,CreateGraphUsingImportTaskRequest>
    
    Specified by:
    
    toBuilder in class NeptuneGraphRequest
  - builder
```
public static CreateGraphUsingImportTaskRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateGraphUsingImportTaskRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateGraphUsingImportTaskRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

graphName

hasTags

tags

publicConnectivity

kmsKeyIdentifier

vectorSearchConfiguration

replicaCount

deletionProtection

importOptions

maxProvisionedMemory

minProvisionedMemory

failOnError

source

format

formatAsString

roleArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields