software.amazon.awssdk.services.neptunedata.model

Interface GetPropertygraphStreamRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetPropertygraphStreamRequest.Builder,GetPropertygraphStreamRequest>, NeptunedataRequest.Builder, SdkBuilder<GetPropertygraphStreamRequest.Builder,GetPropertygraphStreamRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetPropertygraphStreamRequest

public static interface GetPropertygraphStreamRequest.Builder
extends NeptunedataRequest.Builder, SdkPojo, CopyableBuilder<GetPropertygraphStreamRequest.Builder,GetPropertygraphStreamRequest>

Method Summary

Modifier and Type	Method and Description
GetPropertygraphStreamRequest.Builder	commitNum(Long commitNum) The commit number of the starting record to read from the change-log stream.
GetPropertygraphStreamRequest.Builder	encoding(Encoding encoding) If set to TRUE, Neptune compresses the response using gzip encoding.
GetPropertygraphStreamRequest.Builder	encoding(String encoding) If set to TRUE, Neptune compresses the response using gzip encoding.
GetPropertygraphStreamRequest.Builder	iteratorType(IteratorType iteratorType) Can be one of:
GetPropertygraphStreamRequest.Builder	iteratorType(String iteratorType) Can be one of:
GetPropertygraphStreamRequest.Builder	limit(Long limit) Specifies the maximum number of records to return.
GetPropertygraphStreamRequest.Builder	opNum(Long opNum) The operation sequence number within the specified commit to start reading from in the change-log stream data.
GetPropertygraphStreamRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetPropertygraphStreamRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Methods inherited from interface software.amazon.awssdk.services.neptunedata.model.NeptunedataRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

limit

GetPropertygraphStreamRequest.Builder limit(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.

iteratorType

GetPropertygraphStreamRequest.Builder iteratorType(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, IteratorType

iteratorType

GetPropertygraphStreamRequest.Builder iteratorType(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, IteratorType

commitNum

GetPropertygraphStreamRequest.Builder commitNum(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.

opNum

GetPropertygraphStreamRequest.Builder opNum(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.

encoding

GetPropertygraphStreamRequest.Builder encoding(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, Encoding

encoding

GetPropertygraphStreamRequest.Builder encoding(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, Encoding

overrideConfiguration

GetPropertygraphStreamRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetPropertygraphStreamRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder