Class GetGraphSnapshotResponse

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

  • Method Details

    • id

      public final String id()

      The unique identifier of the graph snapshot.

      Returns:
      The unique identifier of the graph snapshot.

    • name

      public final String name()

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

      Returns:
      The ARN of the graph snapshot.

    • sourceGraphId

      public final String sourceGraphId()

      The graph identifier for the graph for which a snapshot is to be created.

      Returns:
      The graph identifier for the graph for which a snapshot is to be created.

    • snapshotCreateTime

      public final Instant snapshotCreateTime()

      The time when the snapshot was created.

      Returns:
      The time when the snapshot was created.

    • status

      public final SnapshotStatus status()

      The status of the graph snapshot.

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

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

    • statusAsString

      public final String statusAsString()

      The status of the graph snapshot.

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

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

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The ID of the KMS key used to encrypt and decrypt the snapshot.

      Returns:
      The ID of the KMS key used to encrypt and decrypt the snapshot.

    • toBuilder

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

    • builder

      public static GetGraphSnapshotResponse.Builder builder()

    • serializableBuilderClass

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