Class PropertygraphData

java.lang.Object
software.amazon.awssdk.services.neptunedata.model.PropertygraphData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PropertygraphData.Builder,PropertygraphData>
@Generated("software.amazon.awssdk:codegen") public final class PropertygraphData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PropertygraphData.Builder,PropertygraphData>

A Gremlin or openCypher change record.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the Gremlin or openCypher element.

      Returns:
      The ID of the Gremlin or openCypher element.

    • type

      public final String type()

      The type of this Gremlin or openCypher element. Must be one of:

      • v1   -   Vertex label for Gremlin, or node label for openCypher.

      • vp   -   Vertex properties for Gremlin, or node properties for openCypher.

      • e   -   Edge and edge label for Gremlin, or relationship and relationship type for openCypher.

      • ep   -   Edge properties for Gremlin, or relationship properties for openCypher.

      Returns:
      The type of this Gremlin or openCypher element. Must be one of:

      • v1   -   Vertex label for Gremlin, or node label for openCypher.

      • vp   -   Vertex properties for Gremlin, or node properties for openCypher.

      • e   -   Edge and edge label for Gremlin, or relationship and relationship type for openCypher.

      • ep   -   Edge properties for Gremlin, or relationship properties for openCypher.

    • key

      public final String key()

      The property name. For element labels, this is label.

      Returns:
      The property name. For element labels, this is label.

    • value

      public final Document value()

      This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:

      Returns:
      This is a JSON object that contains a value field for the value itself, and a datatype field for the JSON data type of that value:

    • from

      public final String from()

      If this is an edge (type = e), the ID of the corresponding from vertex or source node.

      Returns:
      If this is an edge (type = e), the ID of the corresponding from vertex or source node.

    • to

      public final String to()

      If this is an edge (type = e), the ID of the corresponding to vertex or target node.

      Returns:
      If this is an edge (type = e), the ID of the corresponding to vertex or target node.

    • toBuilder

      public PropertygraphData.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<PropertygraphData.Builder,PropertygraphData>
      Returns:
      a builder for type T

    • builder

      public static PropertygraphData.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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