com.amazonaws.services.neptunedata.model

Class GetSparqlStreamRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.neptunedata.model.GetSparqlStreamRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSparqlStreamRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSparqlStreamRequest()

Method Summary

Modifier and Type	Method and Description
GetSparqlStreamRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Long	getCommitNum() The commit number of the starting record to read from the change-log stream.
String	getEncoding() If set to TRUE, Neptune compresses the response using gzip encoding.
String	getIteratorType() Can be one of:
Long	getLimit() Specifies the maximum number of records to return.
Long	getOpNum() The operation sequence number within the specified commit to start reading from in the change-log stream data.
int	hashCode()
void	setCommitNum(Long commitNum) The commit number of the starting record to read from the change-log stream.
void	setEncoding(String encoding) If set to TRUE, Neptune compresses the response using gzip encoding.
void	setIteratorType(String iteratorType) Can be one of:
void	setLimit(Long limit) Specifies the maximum number of records to return.
void	setOpNum(Long opNum) The operation sequence number within the specified commit to start reading from in the change-log stream data.
String	toString() Returns a string representation of this object.
GetSparqlStreamRequest	withCommitNum(Long commitNum) The commit number of the starting record to read from the change-log stream.
GetSparqlStreamRequest	withEncoding(Encoding encoding) If set to TRUE, Neptune compresses the response using gzip encoding.
GetSparqlStreamRequest	withEncoding(String encoding) If set to TRUE, Neptune compresses the response using gzip encoding.
GetSparqlStreamRequest	withIteratorType(IteratorType iteratorType) Can be one of:
GetSparqlStreamRequest	withIteratorType(String iteratorType) Can be one of:
GetSparqlStreamRequest	withLimit(Long limit) Specifies the maximum number of records to return.
GetSparqlStreamRequest	withOpNum(Long opNum) The operation sequence number within the specified commit to start reading from in the change-log stream data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSparqlStreamRequest

public GetSparqlStreamRequest()

Method Detail

setLimit

public void setLimit(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.

Parameters:

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.

getLimit

public Long getLimit()

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.

withLimit

public GetSparqlStreamRequest withLimit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setIteratorType

public void setIteratorType(String 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.

Parameters:

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.

See Also:

IteratorType

getIteratorType

public String getIteratorType()

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.

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

withIteratorType

public GetSparqlStreamRequest withIteratorType(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IteratorType

withIteratorType

public GetSparqlStreamRequest withIteratorType(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

IteratorType

setCommitNum

public void setCommitNum(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.

Parameters:

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.

getCommitNum

public Long getCommitNum()

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.

withCommitNum

public GetSparqlStreamRequest withCommitNum(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setOpNum

public void setOpNum(Long opNum)

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

Parameters:

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

getOpNum

public Long getOpNum()

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.

withOpNum

public GetSparqlStreamRequest withOpNum(Long opNum)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncoding

public void setEncoding(String encoding)

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

Parameters:

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

See Also:

Encoding

getEncoding

public String getEncoding()

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

Returns:

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

See Also:

Encoding

withEncoding

public GetSparqlStreamRequest withEncoding(String encoding)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Encoding

withEncoding

public GetSparqlStreamRequest withEncoding(Encoding encoding)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Encoding

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetSparqlStreamRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()