Class PathElement

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

A single element in a path through the JSON representation of a policy.

See Also:

  • Method Details

    • index

      public final Integer index()

      Refers to an index in a JSON array.

      Returns:
      Refers to an index in a JSON array.

    • key

      public final String key()

      Refers to a key in a JSON object.

      Returns:
      Refers to a key in a JSON object.

    • substring

      public final Substring substring()

      Refers to a substring of a literal string in a JSON object.

      Returns:
      Refers to a substring of a literal string in a JSON object.

    • value

      public final String value()

      Refers to the value associated with a given key in a JSON object.

      Returns:
      Refers to the value associated with a given key in a JSON object.

    • toBuilder

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

    • builder

      public static PathElement.Builder builder()

    • serializableBuilderClass

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

    • fromIndex

      public static PathElement fromIndex(Integer index)
      Create an instance of this class with index() initialized to the given value.

      Refers to an index in a JSON array.

      Parameters:
      index - Refers to an index in a JSON array.

    • fromKey

      public static PathElement fromKey(String key)
      Create an instance of this class with key() initialized to the given value.

      Refers to a key in a JSON object.

      Parameters:
      key - Refers to a key in a JSON object.

    • fromSubstring

      public static PathElement fromSubstring(Substring substring)
      Create an instance of this class with substring() initialized to the given value.

      Refers to a substring of a literal string in a JSON object.

      Parameters:
      substring - Refers to a substring of a literal string in a JSON object.

    • fromSubstring

      public static PathElement fromSubstring(Consumer<Substring.Builder> substring)
      Create an instance of this class with substring() initialized to the given value.

      Refers to a substring of a literal string in a JSON object.

      Parameters:
      substring - Refers to a substring of a literal string in a JSON object.

    • fromValue

      public static PathElement fromValue(String value)
      Create an instance of this class with value() initialized to the given value.

      Refers to the value associated with a given key in a JSON object.

      Parameters:
      value - Refers to the value associated with a given key in a JSON object.

    • type

      public PathElement.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be PathElement.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be PathElement.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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