Class CreateGraphRequest

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.CreateGraphRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateGraphRequest.Builder,CreateGraphRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateGraphRequest extends NeptuneGraphRequest implements ToCopyableBuilder<CreateGraphRequest.Builder,CreateGraphRequest>

  • Method Details

    • 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. Only lowercase letters are allowed.

      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. Only lowercase letters are allowed.

    • 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 is 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 is IAM authenticated. (true to enable, or false to disable.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

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

      Returns:
      Specifies a KMS key to use to encrypt data in 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. Min =0, Max = 2, Default = 1.

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

      Returns:
      The number of replicas in other AZs. Min =0, Max = 2, Default = 1.

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

    • 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).

    • provisionedMemory

      public final Integer provisionedMemory()

      The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16

      Returns:
      The provisioned memory-optimized Neptune Capacity Units (m-NCUs) to use for the graph. Min = 16

    • toBuilder

      public CreateGraphRequest.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<CreateGraphRequest.Builder,CreateGraphRequest>
      Specified by:
      toBuilder in class NeptuneGraphRequest
      Returns:
      a builder for type T

    • builder

      public static CreateGraphRequest.Builder builder()

    • serializableBuilderClass

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