Class GetPropertygraphStreamRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetPropertygraphStreamRequest.Builder,
GetPropertygraphStreamRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Long
The commit number of the starting record to read from the change-log stream.final Encoding
encoding()
If set to TRUE, Neptune compresses the response using gzip encoding.final String
If set to TRUE, Neptune compresses the response using gzip encoding.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final IteratorType
Can be one of:final String
Can be one of:final Long
limit()
Specifies the maximum number of records to return.final Long
opNum()
The operation sequence number within the specified commit to start reading from in the change-log stream data.static Class
<? extends GetPropertygraphStreamRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
Can be one of:
-
AT_SEQUENCE_NUMBER
– Indicates that reading should start from the event sequence number specified jointly by thecommitNum
andopNum
parameters. -
AFTER_SEQUENCE_NUMBER
– Indicates that reading should start right after the event sequence number specified jointly by thecommitNum
andopNum
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 returnIteratorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiteratorTypeAsString()
.- Returns:
- Can be one of:
-
AT_SEQUENCE_NUMBER
– Indicates that reading should start from the event sequence number specified jointly by thecommitNum
andopNum
parameters. -
AFTER_SEQUENCE_NUMBER
– Indicates that reading should start right after the event sequence number specified jointly by thecommitNum
andopNum
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
Can be one of:
-
AT_SEQUENCE_NUMBER
– Indicates that reading should start from the event sequence number specified jointly by thecommitNum
andopNum
parameters. -
AFTER_SEQUENCE_NUMBER
– Indicates that reading should start right after the event sequence number specified jointly by thecommitNum
andopNum
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 returnIteratorType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromiteratorTypeAsString()
.- Returns:
- Can be one of:
-
AT_SEQUENCE_NUMBER
– Indicates that reading should start from the event sequence number specified jointly by thecommitNum
andopNum
parameters. -
AFTER_SEQUENCE_NUMBER
– Indicates that reading should start right after the event sequence number specified jointly by thecommitNum
andopNum
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
The commit number of the starting record to read from the change-log stream. This parameter is required when
iteratorType
isAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
, and ignored wheniteratorType
isTRIM_HORIZON
orLATEST
.- Returns:
- The commit number of the starting record to read from the change-log stream. This parameter is required
when
iteratorType
isAT_SEQUENCE_NUMBER
orAFTER_SEQUENCE_NUMBER
, and ignored wheniteratorType
isTRIM_HORIZON
orLATEST
.
-
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
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 returnEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingAsString()
.- Returns:
- If set to TRUE, Neptune compresses the response using gzip encoding.
- See Also:
-
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 returnEncoding.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencodingAsString()
.- Returns:
- If set to TRUE, Neptune compresses the response using gzip encoding.
- See Also:
-
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 interfaceToCopyableBuilder<GetPropertygraphStreamRequest.Builder,
GetPropertygraphStreamRequest> - Specified by:
toBuilder
in classNeptunedataRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-