Class CreateGraphResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.neptunegraph.model.NeptuneGraphResponse
software.amazon.awssdk.services.neptunegraph.model.CreateGraphResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateGraphResponse.Builder,CreateGraphResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreateGraphResponse extends NeptuneGraphResponse implements ToCopyableBuilder<CreateGraphResponse.Builder,CreateGraphResponse>

  • Method Details

    • id

      public final String id()

      The ID of the graph.

      Returns:
      The ID of the graph.

    • name

      public final String name()

      The graph name. For example: my-graph-1.

      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:
      The graph name. For example: my-graph-1.

      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.

    • arn

      public final String arn()

      The ARN of the graph.

      Returns:
      The ARN of the graph.

    • status

      public final GraphStatus status()

      The current status of the graph.

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

      Returns:
      The current status of the graph.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the graph.

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

      Returns:
      The current status of the graph.
      See Also:

    • statusReason

      public final String statusReason()

      The reason the status was given.

      Returns:
      The reason the status was given.

    • createTime

      public final Instant createTime()

      The time when the graph was created.

      Returns:
      The time when the graph was created.

    • 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

    • endpoint

      public final String endpoint()

      The graph endpoint.

      Returns:
      The graph endpoint.

    • publicConnectivity

      public final Boolean publicConnectivity()

      Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

      If enabling public connectivity for the first time, there will be a delay while it is enabled.

      Returns:
      Specifies whether or not the graph can be reachable over the internet. All access to graphs is IAM authenticated.

      If enabling public connectivity for the first time, there will be a delay while it is enabled.

    • vectorSearchConfiguration

      public final VectorSearchConfiguration vectorSearchConfiguration()

      The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

      Returns:
      The vector-search configuration for the graph, which specifies the vector dimension to use in the vector index, if any.

    • replicaCount

      public final Integer replicaCount()

      The number of replicas in other AZs.

      Default: If not specified, the default value is 1.

      Returns:
      The number of replicas in other AZs.

      Default: If not specified, the default value is 1.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      Specifies the KMS key used to encrypt data in the new graph.

      Returns:
      Specifies the KMS key used to encrypt data in the new graph.

    • sourceSnapshotId

      public final String sourceSnapshotId()

      The ID of the source graph.

      Returns:
      The ID of the source graph.

    • deletionProtection

      public final Boolean deletionProtection()

      A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

      Returns:
      A value that indicates whether the graph has deletion protection enabled. The graph can't be deleted when deletion protection is enabled.

    • buildNumber

      public final String buildNumber()

      The build number of the graph software.

      Returns:
      The build number of the graph software.

    • toBuilder

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

    • builder

      public static CreateGraphResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateGraphResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.