Skip to main content

ServiceConfig

Namespace: IotaSdk

public record class ServiceConfig : System.IEquatable`1[[IotaSdk.ServiceConfig, IotaSdk, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]

Inheritance Object → ServiceConfig
Implements IEquatable<ServiceConfig>
Attributes NullableContextAttribute, NullableAttribute

Properties​

DefaultPageSize​

Default number of elements allowed on a single page of a connection.

public int DefaultPageSize { get; init; }

Property Value​

Int32

EnabledFeatures​

List of all features that are enabled on this RPC service.

public Feature[] EnabledFeatures { get; init; }

Property Value​

Feature[]

MaxMoveValueDepth​

Maximum estimated cost of a database query used to serve a GraphQL request. This is measured in the same units that the database uses in EXPLAIN queries. Maximum nesting allowed in struct fields when calculating the layout of a single Move Type.

public int MaxMoveValueDepth { get; init; }

Property Value​

Int32

MaxOutputNodes​

The maximum number of output nodes in a GraphQL response. Non-connection nodes have a count of 1, while connection nodes are counted as the specified 'first' or 'last' number of items, or the default_page_size as set by the server if those arguments are not set. Counts accumulate multiplicatively down the query tree. For example, if a query starts with a connection of first: 10 and has a field to a connection with last: 20, the count at the second level would be 200 nodes. This is then summed to the count of 10 nodes at the first level, for a total of 210 nodes.

public int MaxOutputNodes { get; init; }

Property Value​

Int32

MaxPageSize​

Maximum number of elements allowed on a single page of a connection.

public int MaxPageSize { get; init; }

Property Value​

Int32

MaxQueryDepth​

The maximum depth a GraphQL query can be to be accepted by this service.

public int MaxQueryDepth { get; init; }

Property Value​

Int32

MaxQueryNodes​

The maximum number of nodes (field names) the service will accept in a single query.

public int MaxQueryNodes { get; init; }

Property Value​

Int32

MaxQueryPayloadSize​

Maximum length of a query payload string.

public int MaxQueryPayloadSize { get; init; }

Property Value​

Int32

MaxTypeArgumentDepth​

Maximum nesting allowed in type arguments in Move Types resolved by this service.

public int MaxTypeArgumentDepth { get; init; }

Property Value​

Int32

MaxTypeArgumentWidth​

Maximum number of type arguments passed into a generic instantiation of a Move Type resolved by this service.

public int MaxTypeArgumentWidth { get; init; }

Property Value​

Int32

MaxTypeNodes​

Maximum number of structs that need to be processed when calculating the layout of a single Move Type.

public int MaxTypeNodes { get; init; }

Property Value​

Int32

MutationTimeoutMs​

Maximum time in milliseconds spent waiting for a response from fullnode after issuing a transaction to execute. Note that the transaction may still succeed even in the case of a timeout. Transactions are idempotent, so a transaction that times out should be resubmitted until the network returns a definite response (success or failure, not timeout).

public int MutationTimeoutMs { get; init; }

Property Value​

Int32

RequestTimeoutMs​

Maximum time in milliseconds that will be spent to serve one query request.

public int RequestTimeoutMs { get; init; }

Property Value​

Int32

Constructors​

ServiceConfig(Int32, Feature[], Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32, Int32)​

public ServiceConfig(int DefaultPageSize, Feature[] EnabledFeatures, int MaxMoveValueDepth, int MaxOutputNodes, int MaxPageSize, int MaxQueryDepth, int MaxQueryNodes, int MaxQueryPayloadSize, int MaxTypeArgumentDepth, int MaxTypeArgumentWidth, int MaxTypeNodes, int MutationTimeoutMs, int RequestTimeoutMs)

Parameters​

DefaultPageSize Int32
Default number of elements allowed on a single page of a connection.

EnabledFeatures Feature[]
List of all features that are enabled on this RPC service.

MaxMoveValueDepth Int32
Maximum estimated cost of a database query used to serve a GraphQL request. This is measured in the same units that the database uses in EXPLAIN queries. Maximum nesting allowed in struct fields when calculating the layout of a single Move Type.

MaxOutputNodes Int32
The maximum number of output nodes in a GraphQL response. Non-connection nodes have a count of 1, while connection nodes are counted as the specified 'first' or 'last' number of items, or the default_page_size as set by the server if those arguments are not set. Counts accumulate multiplicatively down the query tree. For example, if a query starts with a connection of first: 10 and has a field to a connection with last: 20, the count at the second level would be 200 nodes. This is then summed to the count of 10 nodes at the first level, for a total of 210 nodes.

MaxPageSize Int32
Maximum number of elements allowed on a single page of a connection.

MaxQueryDepth Int32
The maximum depth a GraphQL query can be to be accepted by this service.

MaxQueryNodes Int32
The maximum number of nodes (field names) the service will accept in a single query.

MaxQueryPayloadSize Int32
Maximum length of a query payload string.

MaxTypeArgumentDepth Int32
Maximum nesting allowed in type arguments in Move Types resolved by this service.

MaxTypeArgumentWidth Int32
Maximum number of type arguments passed into a generic instantiation of a Move Type resolved by this service.

MaxTypeNodes Int32
Maximum number of structs that need to be processed when calculating the layout of a single Move Type.

MutationTimeoutMs Int32
Maximum time in milliseconds spent waiting for a response from fullnode after issuing a transaction to execute. Note that the transaction may still succeed even in the case of a timeout. Transactions are idempotent, so a transaction that times out should be resubmitted until the network returns a definite response (success or failure, not timeout).

RequestTimeoutMs Int32
Maximum time in milliseconds that will be spent to serve one query request.