Class ListOutgoingTypedLinksRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListOutgoingTypedLinksRequest.Builder,ListOutgoingTypedLinksRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListOutgoingTypedLinksRequest extends CloudDirectoryRequest implements ToCopyableBuilder<ListOutgoingTypedLinksRequest.Builder,ListOutgoingTypedLinksRequest>
  • Method Details

    • directoryArn

      public final String directoryArn()

      The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

      Returns:
      The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
    • objectReference

      public final ObjectReference objectReference()

      A reference that identifies the object whose attributes will be listed.

      Returns:
      A reference that identifies the object whose attributes will be listed.
    • hasFilterAttributeRanges

      public final boolean hasFilterAttributeRanges()
      For responses, this returns true if the service returned a value for the FilterAttributeRanges 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.
    • filterAttributeRanges

      public final List<TypedLinkAttributeRange> filterAttributeRanges()

      Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.

      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 hasFilterAttributeRanges() method.

      Returns:
      Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
    • filterTypedLink

      public final TypedLinkSchemaAndFacetName filterTypedLink()

      Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.

      Returns:
      Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
    • nextToken

      public final String nextToken()

      The pagination token.

      Returns:
      The pagination token.
    • maxResults

      public final Integer maxResults()

      The maximum number of results to retrieve.

      Returns:
      The maximum number of results to retrieve.
    • consistencyLevel

      public final ConsistencyLevel consistencyLevel()

      The consistency level to execute the request at.

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

      Returns:
      The consistency level to execute the request at.
      See Also:
    • consistencyLevelAsString

      public final String consistencyLevelAsString()

      The consistency level to execute the request at.

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

      Returns:
      The consistency level to execute the request at.
      See Also:
    • 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<ListOutgoingTypedLinksRequest.Builder,ListOutgoingTypedLinksRequest>
      Specified by:
      toBuilder in class CloudDirectoryRequest
      Returns:
      a builder for type T
    • builder

      public static ListOutgoingTypedLinksRequest.Builder builder()
    • serializableBuilderClass

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