Class GetPropertygraphStreamRequest

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

  • Method Details

    • limit

      public final Long limit()

      Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

      The range for limit is 1 to 100,000, with a default of 10.

      Returns:
      Specifies the maximum number of records to return. There is also a size limit of 10 MB on the response that can't be modified and that takes precedence over the number of records specified in the limit parameter. The response does include a threshold-breaching record if the 10 MB limit was reached.

      The range for limit is 1 to 100,000, with a default of 10.

    • iteratorType

      public final IteratorType iteratorType()

      Can be one of:

      • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

      • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

      • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

      • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

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

      Returns:
      Can be one of:

      • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

      • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

      • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

      • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

      See Also:

    • iteratorTypeAsString

      public final String iteratorTypeAsString()

      Can be one of:

      • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

      • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

      • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

      • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

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

      Returns:
      Can be one of:

      • AT_SEQUENCE_NUMBER   –   Indicates that reading should start from the event sequence number specified jointly by the commitNum and opNum parameters.

      • AFTER_SEQUENCE_NUMBER   –   Indicates that reading should start right after the event sequence number specified jointly by the commitNum and opNum parameters.

      • TRIM_HORIZON   –   Indicates that reading should start at the last untrimmed record in the system, which is the oldest unexpired (not yet deleted) record in the change-log stream.

      • LATEST   –   Indicates that reading should start at the most recent record in the system, which is the latest unexpired (not yet deleted) record in the change-log stream.

      See Also:

    • commitNum

      public final Long commitNum()

      The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

      Returns:
      The commit number of the starting record to read from the change-log stream. This parameter is required when iteratorType isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

    • opNum

      public final Long opNum()

      The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

      Returns:
      The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is 1.

    • encoding

      public final Encoding encoding()

      If set to TRUE, Neptune compresses the response using gzip encoding.

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

      Returns:
      If set to TRUE, Neptune compresses the response using gzip encoding.
      See Also:

    • encodingAsString

      public final String encodingAsString()

      If set to TRUE, Neptune compresses the response using gzip encoding.

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

      Returns:
      If set to TRUE, Neptune compresses the response using gzip encoding.
      See Also:

    • toBuilder

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

    • builder

      public static GetPropertygraphStreamRequest.Builder builder()

    • serializableBuilderClass

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