Class: Aws::Neptunedata::Types::GetPropertygraphStreamInput

Inherits:

Struct

• Object
• Struct
• Aws::Neptunedata::Types::GetPropertygraphStreamInput

Includes:

Structure

Defined in:

lib/aws-sdk-neptunedata/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #commit_num ⇒ Integer

  The commit number of the starting record to read from the change-log stream.

• #encoding ⇒ String

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

• #iterator_type ⇒ String

  Can be one of:.

• #limit ⇒ Integer

  Specifies the maximum number of records to return.

• #op_num ⇒ Integer

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

Instance Attribute Details

#commit_num ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1475

class GetPropertygraphStreamInput < Struct.new(
  :limit,
  :iterator_type,
  :commit_num,
  :op_num,
  :encoding)
  SENSITIVE = []
  include Aws::Structure
end

#encoding ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1475

class GetPropertygraphStreamInput < Struct.new(
  :limit,
  :iterator_type,
  :commit_num,
  :op_num,
  :encoding)
  SENSITIVE = []
  include Aws::Structure
end

#iterator_type ⇒ String

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:

• (String)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1475

class GetPropertygraphStreamInput < Struct.new(
  :limit,
  :iterator_type,
  :commit_num,
  :op_num,
  :encoding)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

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:

• (Integer)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1475

class GetPropertygraphStreamInput < Struct.new(
  :limit,
  :iterator_type,
  :commit_num,
  :op_num,
  :encoding)
  SENSITIVE = []
  include Aws::Structure
end

#op_num ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-neptunedata/types.rb', line 1475

class GetPropertygraphStreamInput < Struct.new(
  :limit,
  :iterator_type,
  :commit_num,
  :op_num,
  :encoding)
  SENSITIVE = []
  include Aws::Structure
end