Class ListLineageNodeHistoryRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.datazone.model.DataZoneRequest
software.amazon.awssdk.services.datazone.model.ListLineageNodeHistoryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListLineageNodeHistoryRequest.Builder,ListLineageNodeHistoryRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListLineageNodeHistoryRequest extends DataZoneRequest implements ToCopyableBuilder<ListLineageNodeHistoryRequest.Builder,ListLineageNodeHistoryRequest>

  • Method Details

    • direction

      public final EdgeDirection direction()

      The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

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

      Returns:
      The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.
      See Also:

    • directionAsString

      public final String directionAsString()

      The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

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

      Returns:
      The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.
      See Also:

    • domainIdentifier

      public final String domainIdentifier()

      The ID of the domain where you want to list the history of the specified data lineage node.

      Returns:
      The ID of the domain where you want to list the history of the specified data lineage node.

    • eventTimestampGTE

      public final Instant eventTimestampGTE()

      Specifies whether the action is to return data lineage node history from the time after the event timestamp.

      Returns:
      Specifies whether the action is to return data lineage node history from the time after the event timestamp.

    • eventTimestampLTE

      public final Instant eventTimestampLTE()

      Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

      Returns:
      Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

    • identifier

      public final String identifier()

      The ID of the data lineage node whose history you want to list.

      Returns:
      The ID of the data lineage node whose history you want to list.

    • maxResults

      public final Integer maxResults()

      The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

      Returns:
      The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

    • nextToken

      public final String nextToken()

      When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

      Returns:
      When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

    • sortOrder

      public final SortOrder sortOrder()

      The order by which you want data lineage node history to be sorted.

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

      Returns:
      The order by which you want data lineage node history to be sorted.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      The order by which you want data lineage node history to be sorted.

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

      Returns:
      The order by which you want data lineage node history to be sorted.
      See Also:

    • toBuilder

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

    • builder

      public static ListLineageNodeHistoryRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.