AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the GetSparqlStream operation. Gets a stream for an RDF 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. GetSparqlStream lets you collect these change-log entries for an RDF 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.

Note that the neptune-db:QueryLanguage:Sparql IAM condition key can be used in the policy document to restrict the use of SPARQL queries (see Condition keys available in Neptune IAM data-access policy statements).

Inheritance Hierarchy

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

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

Syntax

C# 
public class GetSparqlStreamRequest : AmazonNeptunedataRequest
         IAmazonWebServiceRequest

The GetSparqlStreamRequest type exposes the following members

Constructors

NameDescription
Public Method GetSparqlStreamRequest()

Properties

NameTypeDescription
Public Property 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 isAT_SEQUENCE_NUMBER or AFTER_SEQUENCE_NUMBER, and ignored when iteratorType is TRIM_HORIZON or LATEST.

Public Property Encoding Amazon.Neptunedata.Encoding

Gets and sets the property Encoding.

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

Public Property 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.

Public Property 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.

Public Property 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