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 ExecuteGremlinProfileQuery operation. Executes a Gremlin Profile query, which runs a specified traversal, collects various metrics about the run, and produces a profile report as output. See Gremlin profile API in Neptune for details.

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:ReadDataViaQuery IAM action in that cluster.

Note that the neptune-db:QueryLanguage:Gremlin IAM condition key can be used in the policy document to restrict the use of Gremlin 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.ExecuteGremlinProfileQueryRequest

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

Syntax

C# 
public class ExecuteGremlinProfileQueryRequest : AmazonNeptunedataRequest
         IAmazonWebServiceRequest

The ExecuteGremlinProfileQueryRequest type exposes the following members

Constructors

NameDescription
Public Method ExecuteGremlinProfileQueryRequest()

Properties

NameTypeDescription
Public Property Chop System.Int32

Gets and sets the property Chop.

If non-zero, causes the results string to be truncated at that number of characters. If set to zero, the string contains all the results.

Public Property GremlinQuery System.String

Gets and sets the property GremlinQuery.

The Gremlin query string to profile.

Public Property IndexOps System.Boolean

Gets and sets the property IndexOps.

If this flag is set to TRUE, the results include a detailed report of all index operations that took place during query execution and serialization.

Public Property Results System.Boolean

Gets and sets the property Results.

If this flag is set to TRUE, the query results are gathered and displayed as part of the profile report. If FALSE, only the result count is displayed.

Public Property Serializer System.String

Gets and sets the property Serializer.

If non-null, the gathered results are returned in a serialized response message in the format specified by this parameter. See Gremlin profile API in Neptune for more information.

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