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

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

@Generated("software.amazon.awssdk:codegen")
public final class GetSparqlStreamRequest
extends NeptunedataRequest
implements ToCopyableBuilder<GetSparqlStreamRequest.Builder,GetSparqlStreamRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetSparqlStreamRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static GetSparqlStreamRequest.Builder`	`builder()`
`Long`	`commitNum()`	The commit number of the starting record to read from the change-log stream.
`Encoding`	`encoding()`	If set to TRUE, Neptune compresses the response using gzip encoding.
`String`	`encodingAsString()`	If set to TRUE, Neptune compresses the response using gzip encoding.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`IteratorType`	`iteratorType()`	Can be one of:
`String`	`iteratorTypeAsString()`	Can be one of:
`Long`	`limit()`	Specifies the maximum number of records to return.
`Long`	`opNum()`	The operation sequence number within the specified commit to start reading from in the change-log stream data.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetSparqlStreamRequest.Builder>`	`serializableBuilderClass()`
`GetSparqlStreamRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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:
    
    IteratorType
  - 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:
    
    IteratorType
  - 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:
    
    Encoding
  - 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:
    
    Encoding
  - toBuilder
```
public GetSparqlStreamRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetSparqlStreamRequest.Builder,GetSparqlStreamRequest>
    
    Specified by:
    
    toBuilder in class NeptunedataRequest
  - builder
```
public static GetSparqlStreamRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetSparqlStreamRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetSparqlStreamRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

limit

iteratorType

iteratorTypeAsString

commitNum

opNum

encoding

encodingAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField