NerdGraph Scalar Types

Imports¶

Third-party modules

import sgqlc.types
import sgqlc.types.datetime

from newrelic_sb_sdk.graphql import nerdgraph

Definitions¶

__docformat__ = "markdown"

Scalar types¶

1. `AgentApplicationSettingsCustomJsConfiguration`¶

A stringified JSON list of rules to mask or unmask specific components or views. These rules override other masking settings and requires values in stringified JSON format, such as: [{\"type\":\"mask\",\"operator\":\"equals\",\"name\":\"PrivateContent\",\"identifier\":\"PrivateContent709\"}]. Each rule object must include the following attributes:

Attribute	Type	Required	Values	Description
type	String	Yes	“mask” or “unmask”	Defines the masking operation type
operator	String	Yes	“equals” or “contains”	Defines the matching operation
name	Array	Yes	Array of strings	List of element names to target
identifier	String	Yes	Any string	Unique identifier for the rule

These components define how custom masking rules should be structured for effective configuration.

class AgentApplicationSettingsCustomJsConfiguration(sgqlc.types.Scalar):
    __schema__ = nerdgraph

2. `AgentApplicationSettingsErrorCollectorHttpStatus`¶

A list of HTTP status codes, such as “404” or “500.”

class AgentApplicationSettingsErrorCollectorHttpStatus(sgqlc.types.Scalar):
    __schema__ = nerdgraph

3. `AgentApplicationSettingsRawJsConfiguration`¶

The “raw” configuration values for configuring the javascript client.

class AgentApplicationSettingsRawJsConfiguration(sgqlc.types.Scalar):
    __schema__ = nerdgraph

4. `AiDecisionsRuleExpression`¶

Expression used for comparing incidents as part of a correlation.

class AiDecisionsRuleExpression(sgqlc.types.Scalar):
    __schema__ = nerdgraph

5. `AttributeMap`¶

This scalar represents a map of attributes in the form of key-value pairs.

class AttributeMap(sgqlc.types.Scalar):
    __schema__ = nerdgraph

6. `Boolean`¶

The Boolean scalar type represents true or false.

Boolean = sgqlc.types.Boolean

7. `ChangeTrackingRawCustomAttributesMap`¶

A JSON scalar

class ChangeTrackingRawCustomAttributesMap(sgqlc.types.Scalar):
    __schema__ = nerdgraph

8. `CollaborationRawContextMetadata`¶

Nerdlet-supplied metadata to provide context to a conversation

class CollaborationRawContextMetadata(sgqlc.types.Scalar):
    __schema__ = nerdgraph

9. `DashboardWidgetRawConfiguration`¶

Raw JSON payload with full configuration of a widget.

class DashboardWidgetRawConfiguration(sgqlc.types.Scalar):
    __schema__ = nerdgraph

10. `DataAccessPolicyRawDocument`¶

A custom scalar that handles policy configuration as an object

class DataAccessPolicyRawDocument(sgqlc.types.Scalar):
    __schema__ = nerdgraph

11. `Date`¶

The Date scalar represents a date. The Date appears as an ISO8601 formatted string.

Date = sgqlc.types.datetime.Date

12. `DateTime`¶

The DateTime scalar represents a date and time. The DateTime appears as an ISO8601 formatted string.

DateTime = sgqlc.types.datetime.DateTime

13. `DistributedTracingSpanAttributes`¶

Map of key value pairs for a span

class DistributedTracingSpanAttributes(sgqlc.types.Scalar):
    __schema__ = nerdgraph

14. `Duration`¶

The Duration scalar represents a period of time. A Duration appears as an ISO8601 formatted duration string.

class Duration(sgqlc.types.Scalar):
    __schema__ = nerdgraph

15. `EntityAlertViolationInt`¶

The ViolationInt scalar type represents 52-bit signed integers

class EntityAlertViolationInt(sgqlc.types.Scalar):
    __schema__ = nerdgraph

16. `EntityGuid`¶

An encoded Entity GUID

class EntityGuid(sgqlc.types.Scalar):
    __schema__ = nerdgraph

17. `EntityManagementDynamicString`¶

A string meant to be generated at runtime by a function in the form of a directive.

class EntityManagementDynamicString(sgqlc.types.Scalar):
    __schema__ = nerdgraph

18. `EpochMilliseconds`¶

The EpochMilliseconds scalar represents the number of milliseconds since the Unix epoch

class EpochMilliseconds(sgqlc.types.Scalar):
    __schema__ = nerdgraph

19. `EpochSeconds`¶

The EpochSeconds scalar represents the number of seconds since the Unix epoch

class EpochSeconds(sgqlc.types.Scalar):
    __schema__ = nerdgraph

20. `ErrorsInboxRawEvent`¶

This scalar represents an event

class ErrorsInboxRawEvent(sgqlc.types.Scalar):
    __schema__ = nerdgraph

21. `Float`¶

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Float = sgqlc.types.Float

22. `ID`¶

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

ID = sgqlc.types.ID

23. `InstallationRawMetadata`¶

An arbitrary key:value object containing additional data related to the environment where the installation occurred.

class InstallationRawMetadata(sgqlc.types.Scalar):
    __schema__ = nerdgraph

24. `Int`¶

The Int scalar type represents non-fractional signed whole numeric values. It is NOT compliant with the GraphQl spec, it can represent values between -(2^53 - 1) and 2^53 - 1 as specified by IEEE 754. It is kept here for backwards compatibility, prefer using the SpecCompliantInt.

Int = sgqlc.types.Int

25. `LogConfigurationsLogDataPartitionName`¶

The name of a log data partition. Has to start with ‘Log_’ prefix and can only contain alphanumeric characters and underscores.

class LogConfigurationsLogDataPartitionName(sgqlc.types.Scalar):
    __schema__ = nerdgraph

26. `Milliseconds`¶

The Milliseconds scalar represents a duration in milliseconds

class Milliseconds(sgqlc.types.Scalar):
    __schema__ = nerdgraph

27. `Minutes`¶

The Minutes scalar represents a duration in minutes

class Minutes(sgqlc.types.Scalar):
    __schema__ = nerdgraph

28. `NaiveDateTime`¶

The NaiveDateTime scalar represents a date and time without a Time Zone. The NaiveDateTime appears as an ISO8601 formatted string.

class NaiveDateTime(sgqlc.types.Scalar):
    __schema__ = nerdgraph

29. `NerdStorageDocument`¶

This scalar represents a NerdStorage document.

class NerdStorageDocument(sgqlc.types.Scalar):
    __schema__ = nerdgraph

30. `NerdpackTagName`¶

A string representing a nerdpack tag.

class NerdpackTagName(sgqlc.types.Scalar):
    __schema__ = nerdgraph

31. `Nr1CatalogRawNerdletState`¶

Represents JSON nerdlet state data

class Nr1CatalogRawNerdletState(sgqlc.types.Scalar):
    __schema__ = nerdgraph

32. `NrdbRawResults`¶

This scalar represents the raw nrql query results as returned from NRDB. It is a Map of String keys to values.

The shape of these objects reflect the query used to generate them, the contents of the objects is not part of the GraphQL schema.

class NrdbRawResults(sgqlc.types.Scalar):
    __schema__ = nerdgraph

33. `NrdbResult`¶

This scalar represents a NRDB Result. It is a Map of String keys to values.

The shape of these objects reflect the query used to generate them, the contents of the objects is not part of the GraphQL schema.

class NrdbResult(sgqlc.types.Scalar):
    __schema__ = nerdgraph

34. `Nrql`¶

This scalar represents a NRQL query string.

See the NRQL Docs for more information about NRQL syntax.

class Nrql(sgqlc.types.Scalar):
    __schema__ = nerdgraph

35. `Seconds`¶

The Seconds scalar represents a duration in seconds

class Seconds(sgqlc.types.Scalar):
    __schema__ = nerdgraph

36. `SecureValue`¶

The SecureValue scalar represents a secure value, ie a password, an API key, etc.

class SecureValue(sgqlc.types.Scalar):
    __schema__ = nerdgraph

37. `SemVer`¶

The SemVer scalar represents a version designation conforming to the SemVer specification.

class SemVer(sgqlc.types.Scalar):
    __schema__ = nerdgraph

38. `String`¶

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

String = sgqlc.types.String

39. `WorkflowAutomationRawWorkflowInputValue`¶

Sometimes arbitrary data, sometimes JSON, is required. Since we don’t know the shape of the data ahead of time, we use this general purpose type.

class WorkflowAutomationRawWorkflowInputValue(sgqlc.types.Scalar):
    __schema__ = nerdgraph

NerdGraph Scalar Types¶

Imports¶

Definitions¶

Scalar types¶

1. AgentApplicationSettingsCustomJsConfiguration¶

2. AgentApplicationSettingsErrorCollectorHttpStatus¶

3. AgentApplicationSettingsRawJsConfiguration¶

4. AiDecisionsRuleExpression¶

5. AttributeMap¶

6. Boolean¶

7. ChangeTrackingRawCustomAttributesMap¶

8. CollaborationRawContextMetadata¶

9. DashboardWidgetRawConfiguration¶

10. DataAccessPolicyRawDocument¶

11. Date¶

12. DateTime¶

13. DistributedTracingSpanAttributes¶

14. Duration¶

15. EntityAlertViolationInt¶

16. EntityGuid¶

17. EntityManagementDynamicString¶

18. EpochMilliseconds¶

19. EpochSeconds¶

20. ErrorsInboxRawEvent¶

21. Float¶

22. ID¶

23. InstallationRawMetadata¶

24. Int¶

25. LogConfigurationsLogDataPartitionName¶

26. Milliseconds¶

27. Minutes¶

28. NaiveDateTime¶

29. NerdStorageDocument¶

30. NerdpackTagName¶

31. Nr1CatalogRawNerdletState¶

32. NrdbRawResults¶

33. NrdbResult¶

34. Nrql¶

35. Seconds¶

36. SecureValue¶

37. SemVer¶

38. String¶

39. WorkflowAutomationRawWorkflowInputValue¶