GetPropertygraphStreamRequest Class

Container for the parameters to the GetPropertygraphStream operation. Gets a stream for a property graph.

With the Neptune Streams feature, you can generate a complete sequence of change-log entries that record every change made to your graph data as it happens. GetPropertygraphStream lets you collect these change-log entries for a property graph.

The Neptune streams feature needs to be enabled on your Neptune DBcluster. To enable streams, set the neptune_streams DB cluster parameter to 1.

See Capturing graph changes in real time using Neptune streams.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that allows the neptune-db:GetStreamRecords IAM action in that cluster.

When invoking this operation in a Neptune cluster that has IAM authentication enabled, the IAM user or role making the request must have a policy attached that enables one of the following IAM actions, depending on the query:

Note that you can restrict property-graph queries using the following IAM context keys:

See Condition keys available in Neptune IAM data-access policy statements).

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Neptunedata.AmazonNeptunedataRequest
      Amazon.Neptunedata.Model.GetPropertygraphStreamRequest

Namespace: Amazon.Neptunedata.Model
Assembly: AWSSDK.Neptunedata.dll
Version: 3.x.y.z

Syntax

public class GetPropertygraphStreamRequest : AmazonNeptunedataRequest
         IAmazonWebServiceRequest

The GetPropertygraphStreamRequest type exposes the following members

Constructors

	Name	Description
	GetPropertygraphStreamRequest()

Properties

Name	Type	Description
CommitNum	System.Int64	Gets and sets the property CommitNum. 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`.
Encoding	Amazon.Neptunedata.Encoding	Gets and sets the property Encoding. If set to TRUE, Neptune compresses the response using gzip encoding.
IteratorType	Amazon.Neptunedata.IteratorType	Gets and sets the property 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.
Limit	System.Int64	Gets and sets the property 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.
OpNum	System.Int64	Gets and sets the property OpNum. The operation sequence number within the specified commit to start reading from in the change-log stream data. The default is `1`.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5