Class CreateGraphUsingImportTaskRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateGraphUsingImportTaskRequest.Builder,
CreateGraphUsingImportTaskRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
Indicates whether or not to enable deletion protection on the graph.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Boolean
If set totrue
, the task halts when an import error is encountered.final Format
format()
Specifies the format of S3 data to be imported.final String
Specifies the format of S3 data to be imported.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final String
A name for the new Neptune Analytics graph to be created.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final ImportOptions
Contains options for controlling the import process.final String
Specifies a KMS key to use to encrypt data imported into the new graph.final Integer
The maximum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.final Integer
The minimum provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph.final Boolean
Specifies whether or not the graph can be reachable over the internet.final Integer
The number of replicas in other AZs to provision on the new graph after import.final String
roleArn()
The ARN of the IAM role that will allow access to the data that is to be imported.static Class
<? extends CreateGraphUsingImportTaskRequest.Builder> final String
source()
A URL identifying to the location of the data to be imported.tags()
Adds metadata tags to the new graph.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theisEmpty()
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
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
Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated. (
true
to enable, orfalse
to disable).- Returns:
- Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM
authenticated. (
true
to enable, orfalse
to disable).
-
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
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
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:
- 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.
-
deletionProtection
Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when deletion protection is enabled. (
true
orfalse
).- Returns:
- Indicates whether or not to enable deletion protection on the graph. The graph can’t be deleted when
deletion protection is enabled. (
true
orfalse
).
-
importOptions
Contains options for controlling the import process. For example, if the
failOnError
key is set tofalse
, the import skips problem data and attempts to continue (whereas if set totrue
, 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 tofalse
, the import skips problem data and attempts to continue (whereas if set totrue
, the default, or if omitted, the import operation halts immediately when an error is encountered.
-
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
andmax-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
andmax-provisioned memory
is used to create the graph. If neither value is specified 128 m-NCUs are used.
-
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
If set to
true
, the task halts when an import error is encountered. If set tofalse
, 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 tofalse
, the task skips the data that caused the error and continues if possible.
-
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
Specifies the format of S3 data to be imported. Valid values are
CSV
, which identifies the Gremlin CSV format orOPENCYPHER
, which identies the openCypher load format.If the service returns an enum value that is not available in the current SDK version,
format
will returnFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- Specifies the format of S3 data to be imported. Valid values are
CSV
, which identifies the Gremlin CSV format orOPENCYPHER
, which identies the openCypher load format. - See Also:
-
formatAsString
Specifies the format of S3 data to be imported. Valid values are
CSV
, which identifies the Gremlin CSV format orOPENCYPHER
, which identies the openCypher load format.If the service returns an enum value that is not available in the current SDK version,
format
will returnFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromformatAsString()
.- Returns:
- Specifies the format of S3 data to be imported. Valid values are
CSV
, which identifies the Gremlin CSV format orOPENCYPHER
, which identies the openCypher load format. - See Also:
-
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
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 interfaceToCopyableBuilder<CreateGraphUsingImportTaskRequest.Builder,
CreateGraphUsingImportTaskRequest> - Specified by:
toBuilder
in classNeptuneGraphRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-