NerdGraph Object Types
Imports¶
Third-party modules
import sgqlc.types
import sgqlc.types.datetimenewrelic_sb_sdk module
from newrelic_sb_sdk.graphql import nerdgraphfrom newrelic_sb_sdk.graphql.input_objects import (
AccountManagementCreateInput,
AccountManagementUpdateInput,
AgentApplicationBrowserSettingsInput,
AgentApplicationSegmentsBrowserSegmentAllowListInput,
AgentApplicationSegmentsSegmentAllowListFilters,
AgentApplicationSettingsUpdateInput,
AgentEnvironmentFilter,
AiDecisionsRuleBlueprint,
AiDecisionsSearchBlueprint,
AiDecisionsSimulationBlueprint,
AiDecisionsSuggestionBlueprint,
AiIssuesFilterIncidents,
AiIssuesFilterIncidentsEvents,
AiIssuesFilterIssues,
AiIssuesFilterIssuesEvents,
AiIssuesGracePeriodConfigurationInput,
AiNotificationsChannelFilter,
AiNotificationsChannelInput,
AiNotificationsChannelSorter,
AiNotificationsChannelUpdate,
AiNotificationsConstraint,
AiNotificationsDestinationFilter,
AiNotificationsDestinationInput,
AiNotificationsDestinationSorter,
AiNotificationsDestinationUpdate,
AiNotificationsDynamicVariable,
AiNotificationsEntityScopeInput,
AiNotificationsSuggestionFilter,
AiNotificationsUnverifiedEmailsFilters,
AiNotificationsUnverifiedEmailsSorter,
AiNotificationsVariableFilter,
AiNotificationsVariableSorter,
AiWorkflowsCreateWorkflowInput,
AiWorkflowsFilters,
AiWorkflowsTestWorkflowInput,
AiWorkflowsUpdateWorkflowInput,
AlertsAsNrqlConditionsSearchCriteriaInput,
AlertsCompoundConditionFilterInput,
AlertsCompoundConditionSortInput,
AlertsMutingRuleInput,
AlertsMutingRulesFilterCriteriaInput,
AlertsMutingRuleUpdateInput,
AlertsNrqlConditionBaselineInput,
AlertsNrqlConditionsSearchCriteriaInput,
AlertsNrqlConditionStaticInput,
AlertsNrqlConditionUpdateBaselineInput,
AlertsNrqlConditionUpdateStaticInput,
AlertsPoliciesSearchCriteriaInput,
AlertsPolicyInput,
AlertsPolicyUpdateInput,
ApiAccessCreateInput,
ApiAccessDeleteInput,
ApiAccessKeySearchQuery,
ApiAccessUpdateInput,
AuthorizationManagementGrantAccess,
AuthorizationManagementRevokeAccess,
AuthorizationManagementUpdateAccess,
ChangeTrackingChangeTrackingSearchFilter,
ChangeTrackingCreateEventInput,
ChangeTrackingDataHandlingRules,
ChangeTrackingDeploymentInput,
ChangeTrackingSearchFilter,
CloudAwsGovCloudMigrateToAssumeroleInput,
CloudDisableIntegrationsInput,
CloudIntegrationsInput,
CloudLinkCloudAccountsInput,
CloudOciInstrumentedPayloadInput,
CloudOciLogGroupInstrumentedPayloadInput,
CloudRenameAccountsInput,
CloudUnlinkAccountsInput,
CloudUpdateCloudAccountsInput,
CollaborationAssistantConfigInput,
CustomRoleContainerInput,
DashboardInput,
DashboardLiveUrlAuthCreationInput,
DashboardLiveUrlAuthUpdateInput,
DashboardLiveUrlCreationPoliciesFilterInput,
DashboardLiveUrlOptionsInput,
DashboardLiveUrlsFilterInput,
DashboardSnapshotUrlInput,
DashboardUpdateLiveUrlCreationPoliciesInput,
DashboardUpdatePageInput,
DashboardUpdateWidgetInput,
DashboardWidgetInput,
DataAccessPolicyFilterInput,
DataAccessPolicySortInput,
DataManagementAccountFeatureSettingInput,
DataManagementAccountLimitInput,
DataManagementLimitLookupInput,
DataManagementOrganizationLimitInput,
DataManagementOrganizationLimitLookupInput,
DataManagementRuleInput,
DataSourceGapsGapsQuery,
DomainTypeInput,
EdgeCreateTraceFilterRulesInput,
EdgeCreateTraceObserverInput,
EdgeDeleteTraceFilterRulesInput,
EdgeDeleteTraceObserverInput,
EdgeUpdateTraceObserverInput,
EntityGoldenContextInput,
EntityGoldenMetricInput,
EntityGoldenNrqlTimeWindowInput,
EntityGoldenTagInput,
EntityManagementAiAgentEntityCreateInput,
EntityManagementAiAgentEntityUpdateInput,
EntityManagementAiToolEntityCreateInput,
EntityManagementAiToolEntityUpdateInput,
EntityManagementCollectionElementsFilter,
EntityManagementCollectionEntityCreateInput,
EntityManagementCollectionEntityUpdateInput,
EntityManagementConfluenceIntegrationCreateInput,
EntityManagementConfluenceIntegrationUpdateInput,
EntityManagementConfluenceRagSettingsEntityCreateInput,
EntityManagementConfluenceRagSettingsEntityUpdateInput,
EntityManagementGenericEntityUpdateInput,
EntityManagementGitRepositoryEntityCreateInput,
EntityManagementGitRepositoryEntityUpdateInput,
EntityManagementImpactProfileEntityCreateInput,
EntityManagementImpactProfileEntityUpdateInput,
EntityManagementInboxIssueCategoryEntityCreateInput,
EntityManagementInboxIssueCategoryEntityUpdateInput,
EntityManagementIncidentLinkEntityCreateInput,
EntityManagementIncidentLinkEntityUpdateInput,
EntityManagementIncidentTimelineEntityCreateInput,
EntityManagementIncidentTimelineEntityUpdateInput,
EntityManagementMcpServerEntityCreateInput,
EntityManagementMcpServerEntityUpdateInput,
EntityManagementPipelineCloudRuleEntityCreateInput,
EntityManagementPipelineCloudRuleEntityUpdateInput,
EntityManagementRagToolEntityCreateInput,
EntityManagementRagToolEntityUpdateInput,
EntityManagementRelationshipCreateInput,
EntityManagementRelationshipUpdateInput,
EntityManagementScorecardEntityCreateInput,
EntityManagementScorecardEntityUpdateInput,
EntityManagementScorecardRuleEntityCreateInput,
EntityManagementScorecardRuleEntityUpdateInput,
EntityManagementTeamEntityCreateInput,
EntityManagementTeamEntityUpdateInput,
EntityManagementTeamsHierarchyLevelEntityUpdateInput,
EntityManagementTeamsOrganizationSettingsEntityUpdateInput,
EntityRelationshipEdgeFilter,
EntitySearchOptions,
EntitySearchQueryBuilder,
ErrorsInboxAssignErrorGroupInput,
ErrorsInboxErrorEventInput,
ErrorsInboxErrorGroupSearchFilterInput,
ErrorsInboxErrorGroupSortOrderInput,
ErrorsInboxResourceFilterInput,
ErrorsInboxStateVersionInput,
EventsToMetricsCreateRuleInput,
EventsToMetricsDeleteRuleInput,
EventsToMetricsUpdateRuleInput,
FleetControlFleetDeploymentCreateInput,
FleetControlFleetDeploymentPolicyInput,
FleetControlFleetDeploymentUpdateInput,
FleetControlFleetEntityCreateInput,
FleetControlFleetMemberRingInput,
FleetControlFleetMembersFilterInput,
FleetControlUpdateFleetEntityInput,
InstallationInstallStatusInput,
InstallationRecipeStatus,
IntegrationServicesInstallationInput,
IntegrationServicesUpdateInput,
LogConfigurationsCreateDataPartitionRuleInput,
LogConfigurationsCreateObfuscationExpressionInput,
LogConfigurationsCreateObfuscationRuleInput,
LogConfigurationsParsingRuleConfiguration,
LogConfigurationsPipelineConfigurationInput,
LogConfigurationsUpdateDataPartitionRuleInput,
LogConfigurationsUpdateObfuscationExpressionInput,
LogConfigurationsUpdateObfuscationRuleInput,
MachineLearningAddDocumentIndexConfiguration,
MachineLearningFilterBy,
MachineLearningIndexOptions,
MetricNormalizationCreateRuleInput,
MetricNormalizationEditRuleInput,
MultiTenantAuthorizationGrantFilterInputExpression,
MultiTenantAuthorizationGrantSortInput,
MultiTenantAuthorizationPermissionFilter,
MultiTenantAuthorizationRoleFilterInputExpression,
MultiTenantAuthorizationRoleSortInput,
MultiTenantIdentityGroupFilterInput,
MultiTenantIdentityGroupSortInput,
MultiTenantIdentityGroupUserFilterInput,
MultiTenantIdentityUserFilterInput,
MultiTenantIdentityUserSortInput,
NerdpackAllowListInput,
NerdpackCreationInput,
NerdpackDataFilter,
NerdpackOverrideVersionRules,
NerdpackRemoveVersionTagInput,
NerdpackSubscribeAccountsInput,
NerdpackTagVersionInput,
NerdpackUnsubscribeAccountsInput,
NerdpackVersionFilter,
NerdStorageScopeInput,
NerdStorageVaultScope,
NerdStorageVaultWriteSecretInput,
Nr1CatalogSearchFilter,
Nr1CatalogSubmitMetadataInput,
NrqlDropRulesCreateDropRuleInput,
NrqlQueryOptions,
OrganizationAccountFilterInput,
OrganizationAccountShareFilterInput,
OrganizationAccountShareSortInput,
OrganizationAccountSortInput,
OrganizationAuthenticationDomainFilterInput,
OrganizationAuthenticationDomainSortInput,
OrganizationCreateOrganizationInput,
OrganizationCreateSharedAccountInput,
OrganizationCustomerContractFilterInput,
OrganizationCustomerOrganizationFilterInput,
OrganizationMembersOrganizationMemberFilter,
OrganizationNewManagedAccountInput,
OrganizationOrganizationCreateAsyncResultFilterInput,
OrganizationOrganizationGroupFilterInput,
OrganizationProvisioningProductInput,
OrganizationRevokeSharedAccountInput,
OrganizationSharedAccountInput,
OrganizationUpdateInput,
OrganizationUpdateSharedAccountInput,
QueryHistoryQueryHistoryOptionsInput,
ReferenceEntityCreateRepositoryInput,
SecretsManagementScope,
SecretsManagementSecretsCollectionFilter,
SecretsManagementSecretsCollectionSort,
SecretsManagementTagInput,
ServiceLevelIndicatorCreateInput,
ServiceLevelIndicatorUpdateInput,
SessionsSessionFilter,
SortCriterionWithDirection,
StreamingExportAwsInput,
StreamingExportAzureInput,
StreamingExportGcpInput,
StreamingExportRuleInput,
SyntheticsCreateBrokenLinksMonitorInput,
SyntheticsCreateCertCheckMonitorInput,
SyntheticsCreateScriptApiMonitorInput,
SyntheticsCreateScriptBrowserMonitorInput,
SyntheticsCreateSimpleBrowserMonitorInput,
SyntheticsCreateSimpleMonitorInput,
SyntheticsCreateStepMonitorInput,
SyntheticsDateWindowEndConfig,
SyntheticsMonitorDowntimeDailyConfig,
SyntheticsMonitorDowntimeMonthlyConfig,
SyntheticsMonitorDowntimeMonthlyFrequency,
SyntheticsMonitorDowntimeOnceConfig,
SyntheticsMonitorDowntimeWeeklyConfig,
SyntheticsUpdateBrokenLinksMonitorInput,
SyntheticsUpdateCertCheckMonitorInput,
SyntheticsUpdateScriptApiMonitorInput,
SyntheticsUpdateScriptBrowserMonitorInput,
SyntheticsUpdateSimpleBrowserMonitorInput,
SyntheticsUpdateSimpleMonitorInput,
SyntheticsUpdateStepMonitorInput,
SystemIdentityGroupFilter,
SystemIdentityIdentityFilter,
SystemIdentityIdentitySort,
TaggingTagInput,
TaggingTagValueInput,
TimeWindowInput,
UserManagementCreateGroup,
UserManagementCreateUser,
UserManagementDeleteGroup,
UserManagementDeleteUser,
UserManagementGroupFilterInput,
UserManagementGroupSortInput,
UserManagementUpdateGroup,
UserManagementUpdateUser,
UserManagementUserFilterInput,
UserManagementUsersGroupsInput,
UsersUserSearchQuery,
WhatsNewContentSearchQuery,
WorkflowAutomationCreateScheduleDefinitionInput,
WorkflowAutomationCreateWorkflowDefinitionInput,
WorkflowAutomationDeleteScheduleInput,
WorkflowAutomationDeleteWorkflowDefinitionInput,
WorkflowAutomationScopeInput,
WorkflowAutomationSignalInput,
WorkflowAutomationStartWorkflowRunDefinitionInput,
WorkflowAutomationTag,
WorkflowAutomationUpdateWorkflowDefinitionInput,
WorkflowAutomationWorkflowDefinitionValidationInput,
WorkflowAutomationWorkflowRunInput,
WorkflowAutomationWorkflowRunOptions,
WorkflowAutomationWorkflowRunScope,
WorkloadCreateInput,
WorkloadDuplicateInput,
WorkloadUpdateInput,
)from newrelic_sb_sdk.graphql.scalars import (
ID,
AgentApplicationSettingsCustomJsConfiguration,
AgentApplicationSettingsErrorCollectorHttpStatus,
AgentApplicationSettingsRawJsConfiguration,
AiDecisionsRuleExpression,
AttributeMap,
Boolean,
ChangeTrackingRawCustomAttributesMap,
CollaborationRawContextMetadata,
DashboardWidgetRawConfiguration,
DataAccessPolicyRawDocument,
Date,
DateTime,
DistributedTracingSpanAttributes,
Duration,
EntityAlertViolationInt,
EntityGuid,
EntityManagementDynamicString,
EpochMilliseconds,
EpochSeconds,
Float,
InstallationRawMetadata,
Int,
LogConfigurationsLogDataPartitionName,
Milliseconds,
Minutes,
NaiveDateTime,
NerdpackTagName,
NerdStorageDocument,
Nr1CatalogRawNerdletState,
NrdbRawResults,
NrdbResult,
Nrql,
Seconds,
SecureValue,
SemVer,
String,
WorkflowAutomationRawWorkflowInputValue,
)from newrelic_sb_sdk.graphql.enums import (
AgentApplicationBrowserLoader,
AgentApplicationSettingsBrowserLoader,
AgentApplicationSettingsMobileSessionReplayMode,
AgentApplicationSettingsNetworkFilterMode,
AgentApplicationSettingsRecordSqlEnum,
AgentApplicationSettingsSessionTraceMode,
AgentApplicationSettingsThresholdTypeEnum,
AgentApplicationSettingsTracer,
AgentApplicationSettingsUpdateErrorClass,
AgentReleasesFilter,
AiDecisionsDecisionSortMethod,
AiDecisionsDecisionState,
AiDecisionsDecisionType,
AiDecisionsIncidentSelect,
AiDecisionsIssuePriority,
AiDecisionsOpinion,
AiDecisionsResultType,
AiDecisionsRuleSource,
AiDecisionsRuleState,
AiDecisionsRuleType,
AiDecisionsSuggestionState,
AiIssuesIncidentState,
AiIssuesIssueMutingState,
AiIssuesIssueState,
AiIssuesIssueUserAction,
AiIssuesPriority,
AiNotificationsAuthType,
AiNotificationsChannelStatus,
AiNotificationsChannelType,
AiNotificationsDestinationStatus,
AiNotificationsDestinationType,
AiNotificationsEmailVerificationStatus,
AiNotificationsEntityScopeType,
AiNotificationsErrorType,
AiNotificationsExtendedScopeService,
AiNotificationsProduct,
AiNotificationsResult,
AiNotificationsUiComponentType,
AiNotificationsUiComponentValidation,
AiNotificationsVariableCategory,
AiNotificationsVariableType,
AiTopologyCollectorResultType,
AiTopologyVertexClass,
AiWorkflowsBatchCreateMigratedWorkflowsErrorType,
AiWorkflowsBatchDeleteMigratedWorkflowsErrorType,
AiWorkflowsCreateErrorType,
AiWorkflowsDeleteErrorType,
AiWorkflowsDestinationType,
AiWorkflowsEnrichmentType,
AiWorkflowsFetchWorkflowsByIssuesFilterErrorType,
AiWorkflowsFilterType,
AiWorkflowsMutingRulesHandling,
AiWorkflowsNotificationTrigger,
AiWorkflowsOperator,
AiWorkflowsSaveTeamWorkflowConfigurationErrorType,
AiWorkflowsTestErrorType,
AiWorkflowsTestNotificationResponseStatus,
AiWorkflowsTestResponseStatus,
AiWorkflowsUpdateErrorType,
AlertsActionOnMutingRuleWindowEnded,
AlertsAsNrqlSourceProduct,
AlertsCompoundConditionFacetMatchingBehavior,
AlertsDayOfWeek,
AlertsFillOption,
AlertsIncidentPreference,
AlertsMutingRuleConditionGroupOperator,
AlertsMutingRuleConditionOperator,
AlertsMutingRuleScheduleRepeat,
AlertsMutingRuleStatus,
AlertsNotificationChannelCreateErrorType,
AlertsNotificationChannelDeleteErrorType,
AlertsNotificationChannelsAddToPolicyErrorType,
AlertsNotificationChannelsRemoveFromPolicyErrorType,
AlertsNotificationChannelType,
AlertsNotificationChannelUpdateErrorType,
AlertsNrqlBaselineDirection,
AlertsNrqlConditionPriority,
AlertsNrqlConditionTermsOperator,
AlertsNrqlConditionThresholdOccurrences,
AlertsNrqlConditionType,
AlertsNrqlSignalSeasonality,
AlertsOpsGenieDataCenterRegion,
AlertsSignalAggregationMethod,
AlertsWebhookCustomPayloadType,
ApiAccessIngestKeyErrorType,
ApiAccessIngestKeyType,
ApiAccessKeyType,
ApiAccessUserKeyErrorType,
BrowserAgentInstallType,
ChangeTrackingCategoryType,
ChangeTrackingDeploymentType,
ChartFormatType,
ChartImageType,
CloudMetricCollectionMode,
CollaborationExternalApplicationType,
CollaborationStatus,
DashboardAddWidgetsToPageErrorType,
DashboardAlertSeverity,
DashboardCreateErrorType,
DashboardDeleteErrorType,
DashboardDeleteResultStatus,
DashboardEntityPermissions,
DashboardLiveUrlAuthType,
DashboardLiveUrlErrorType,
DashboardLiveUrlType,
DashboardPermissions,
DashboardUndeleteErrorType,
DashboardUpdateErrorType,
DashboardUpdatePageErrorType,
DashboardUpdateWidgetsInPageErrorType,
DashboardVariableReplacementStrategy,
DashboardVariableType,
DataAccessPolicyAssignedStatus,
DataAccessPolicyStatus,
DataDictionaryTextFormat,
DataManagementCategory,
DataManagementType,
DataManagementUnit,
DataSourceGapsGapTypeIdentifier,
DistributedTracingSpanAnomalyType,
DistributedTracingSpanClientType,
DistributedTracingSpanProcessBoundary,
EdgeComplianceTypeCode,
EdgeCreateSpanAttributeRuleResponseErrorType,
EdgeCreateTraceObserverResponseErrorType,
EdgeDataSourceStatusType,
EdgeDeleteSpanAttributeRuleResponseErrorType,
EdgeDeleteTraceObserverResponseErrorType,
EdgeEndpointStatus,
EdgeEndpointType,
EdgeProviderRegion,
EdgeSpanAttributeKeyOperator,
EdgeSpanAttributeValueOperator,
EdgeTraceFilterAction,
EdgeTraceObserverStatus,
EdgeUpdateTraceObserverResponseErrorType,
EmbeddedChartType,
EntityAlertSeverity,
EntityCollectionType,
EntityDeleteErrorType,
EntityGoldenEventObjectId,
EntityGoldenGoldenMetricsErrorType,
EntityGoldenMetricUnit,
EntityManagementActorType,
EntityManagementAiToolParameterType,
EntityManagementAiToolType,
EntityManagementArrayOperator,
EntityManagementAssignmentType,
EntityManagementBackgroundProcessingType,
EntityManagementBudgetType,
EntityManagementCategoryScopeType,
EntityManagementChannelType,
EntityManagementCloudProvider,
EntityManagementCommunicationMode,
EntityManagementCommunicationStatus,
EntityManagementConsumptionMetric,
EntityManagementCorrelationAttributeConditionOperator,
EntityManagementCorrelationMatchingAlgorithm,
EntityManagementCorrelationOverrideAction,
EntityManagementCorrelationSubjectType,
EntityManagementDateOperator,
EntityManagementEncodingName,
EntityManagementEncodingType,
EntityManagementEntityScope,
EntityManagementEvaluationParameter,
EntityManagementEventBridgeEventSourceType,
EntityManagementEventBridgeTargetType,
EntityManagementEventBridgeWorkflowDefinitionScopeType,
EntityManagementExecutionStatus,
EntityManagementExternalOwnerType,
EntityManagementFederatedLogSetupStatus,
EntityManagementFleetDeploymentPhase,
EntityManagementHostingPlatform,
EntityManagementIncidentSource,
EntityManagementIncidentStatus,
EntityManagementIncidentTimelineSource,
EntityManagementInstallationSource,
EntityManagementInstallationStatus,
EntityManagementIssueType,
EntityManagementJiraIssueType,
EntityManagementKeyType,
EntityManagementLicenseName,
EntityManagementLogPartitionStatus,
EntityManagementManagedEntityType,
EntityManagementManagedEvaluationType,
EntityManagementMcpAuthType,
EntityManagementMcpTransport,
EntityManagementMessageType,
EntityManagementNumericOperator,
EntityManagementOperatingSystemType,
EntityManagementOverlapPolicy,
EntityManagementPrincipalType,
EntityManagementProcessStatus,
EntityManagementProvider,
EntityManagementRegion,
EntityManagementRetentionUnit,
EntityManagementSigningAlgorithm,
EntityManagementStatusCode,
EntityManagementStatusPageAnnouncementCategory,
EntityManagementStatusPageAnnouncementState,
EntityManagementStringOperator,
EntityManagementSyncConfigurationMode,
EntityManagementSyncDirection,
EntityManagementSyncGroupRuleConditionType,
EntityManagementTeamExternalIntegrationType,
EntityManagementTextSplitterType,
EntityManagementThresholdScope,
EntityManagementWorkItemCategory,
EntityManagementWorkItemPriority,
EntityRelationshipEdgeType,
EntityRelationshipType,
EntityRelationshipUserDefinedCreateOrReplaceErrorType,
EntityRelationshipUserDefinedDeleteErrorType,
EntitySearchCountsFacet,
EntitySearchSortCriteria,
EntityType,
ErrorsInboxAssignErrorGroupErrorType,
ErrorsInboxErrorGroupState,
ErrorsInboxIssueType,
ErrorsInboxUpdateErrorGroupStateErrorType,
EventsToMetricsErrorReason,
FleetControlEntityScope,
FleetControlFleetDeploymentPhase,
FleetControlManagedEntityType,
FleetControlOperatingSystemType,
HistoricalDataExportStatus,
IncidentIntelligenceEnvironmentConsentAccountsResult,
IncidentIntelligenceEnvironmentCreateEnvironmentResult,
IncidentIntelligenceEnvironmentCurrentEnvironmentResultReason,
IncidentIntelligenceEnvironmentDeleteEnvironmentResult,
IncidentIntelligenceEnvironmentDissentAccountsResult,
IncidentIntelligenceEnvironmentEnvironmentKind,
IncidentIntelligenceEnvironmentSupportedEnvironmentKind,
InstallationInstallStateType,
InstallationRecipeStatusType,
KnowledgePublishStatus,
KnowledgeSearchSortOption,
KnowledgeSearchSources,
LogConfigurationsCreateDataPartitionRuleErrorType,
LogConfigurationsDataPartitionRuleMatchingOperator,
LogConfigurationsDataPartitionRuleMutationErrorType,
LogConfigurationsDataPartitionRuleRetentionPolicyType,
LogConfigurationsLiveArchiveRetentionPolicyType,
LogConfigurationsObfuscationMethod,
LogConfigurationsParsingRuleMutationErrorType,
LogConfigurationsParsingRuleSource,
MetricNormalizationRuleAction,
MetricNormalizationRuleErrorType,
MultiTenantAuthorizationGranteeTypeEnum,
MultiTenantAuthorizationGrantScopeEnum,
MultiTenantAuthorizationPermissionCategoryEnum,
MultiTenantIdentityEmailVerificationState,
NerdpackMutationErrorType,
NerdpackMutationResult,
NerdpackRemovedTagResponseType,
NerdpackSubscriptionAccessType,
NerdpackSubscriptionModel,
NerdStorageVaultErrorType,
NerdStorageVaultResultStatus,
Nr1CatalogAlertConditionType,
Nr1CatalogInstallerType,
Nr1CatalogInstallPlanDestination,
Nr1CatalogInstallPlanDirectiveMode,
Nr1CatalogInstallPlanOperatingSystem,
Nr1CatalogInstallPlanTargetType,
Nr1CatalogMutationResult,
Nr1CatalogNerdpackVisibility,
Nr1CatalogQuickstartAlertConditionType,
Nr1CatalogRenderFormat,
Nr1CatalogSearchComponentType,
Nr1CatalogSearchResultType,
Nr1CatalogSearchSortOption,
Nr1CatalogSubmitMetadataErrorType,
Nr1CatalogSupportedEntityTypesMode,
Nr1CatalogSupportLevel,
NrqlCancelQueryMutationRequestStatus,
NrqlDropRulesAction,
NrqlDropRulesErrorReason,
OrganizationAuthenticationTypeEnum,
OrganizationBillingStructure,
OrganizationMembersOrganizationMemberType,
OrganizationOrganizationCreateJobResultStatusEnum,
OrganizationProvisioningTypeEnum,
OrganizationUpdateErrorType,
PixieLinkPixieProjectErrorType,
PixieRecordPixieTosAcceptanceErrorType,
ReferenceEntityCreateRepositoryErrorType,
RegionScope,
SecretsManagementScopeType,
ServiceLevelEventsQuerySelectFunction,
ServiceLevelObjectiveRollingTimeWindowUnit,
SessionsClientType,
SessionsPrincipalType,
StreamingExportPayloadCompression,
StreamingExportStatus,
SyntheticMonitorStatus,
SyntheticMonitorType,
SyntheticsBrowser,
SyntheticsDevice,
SyntheticsDeviceOrientation,
SyntheticsDeviceType,
SyntheticsMonitorCreateErrorType,
SyntheticsMonitorDowntimeDayOfMonthOrdinal,
SyntheticsMonitorDowntimeWeekDays,
SyntheticsMonitorPeriod,
SyntheticsMonitorStatus,
SyntheticsMonitorUpdateErrorType,
SyntheticsPrivateLocationMutationErrorType,
SyntheticsStepType,
SystemIdentityIdentityType,
TaggingMutationErrorType,
WhatsNewContentType,
WorkflowAutomationActionDefinitionInputType,
WorkflowAutomationScheduleOverlapPolicy,
WorkflowAutomationScopeType,
WorkflowAutomationWorkflowRunStatus,
WorkloadGroupRemainingEntitiesRuleBy,
WorkloadResultingGroupType,
WorkloadRollupStrategy,
WorkloadRuleThresholdType,
WorkloadStatusSource,
WorkloadStatusValue,
)Definitions¶
Constants¶
__docformat__ = "markdown"Interface types¶
1. AiIssuesIIncident¶
Incident interface
Available fields:
account: accountaccountIds: An account id this incident is stored inclosedAt: The time the incident was closedcreatedAt: The time the incident was createddescription: The description is generated from the policy name and the condition name or provided through APIentityGuids: A list of unique entity identifiersentityNames: A list of entity namesentityTypes: A list of entity typesincidentId: Incident identifierpriority: Incident prioritystate: Incident statetimestamp: Incident event timestamptitle: The description the user gave the condition if provided. Otherwise the incident descriptionupdatedAt: The time the incident was last updated
class AiIssuesIIncident(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"account",
"account_ids",
"closed_at",
"created_at",
"description",
"entity_guids",
"entity_names",
"entity_types",
"incident_id",
"priority",
"state",
"timestamp",
"title",
"updated_at",
)
account = sgqlc.types.Field("AccountReference", graphql_name="account")
account_ids = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="accountIds"
)
closed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="closedAt")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
description = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="description",
)
entity_guids = sgqlc.types.Field(EntityGuid, graphql_name="entityGuids")
entity_names = sgqlc.types.Field(String, graphql_name="entityNames")
entity_types = sgqlc.types.Field(String, graphql_name="entityTypes")
incident_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="incidentId")
priority = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesPriority), graphql_name="priority"
)
state = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIncidentState), graphql_name="state"
)
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
title = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="title")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)2. AiWorkflowsResponseError¶
Error description
Available fields:
description: The error description
class AiWorkflowsResponseError(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)3. AlertableEntity¶
Available fields:
alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the timewindow or look at fewer entities.recentAlertViolations: Recent violations on the entity.
class AlertableEntity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("alert_severity", "alert_violations", "recent_alert_violations")
alert_severity = sgqlc.types.Field(
EntityAlertSeverity, graphql_name="alertSeverity"
)
alert_violations = sgqlc.types.Field(
sgqlc.types.list_of("EntityAlertViolation"),
graphql_name="alertViolations",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="endTime",
default=None,
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="startTime",
default=None,
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds!`): End of time window for
violations.
* `start_time` (`EpochMilliseconds!`): Start of time window for
violations.
"""
recent_alert_violations = sgqlc.types.Field(
sgqlc.types.list_of("EntityAlertViolation"),
graphql_name="recentAlertViolations",
args=sgqlc.types.ArgDict(
(("count", sgqlc.types.Arg(Int, graphql_name="count", default=10)),)
),
)
"""Arguments:
* `count` (`Int`): The desired number of alert violations to be
returned. (default: `10`)
"""4. AlertableEntityOutline¶
Available fields:
alertSeverity: The current alerting severity of the entity.
class AlertableEntityOutline(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("alert_severity",)
alert_severity = sgqlc.types.Field(
EntityAlertSeverity, graphql_name="alertSeverity"
)5. AlertsAsNrqlCondition¶
A New Relic Alerts condition that uses a NRQL query to determine violations.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Configuration that defines the signal that the NRQL condition will use to evaluate.sourceProduct: A type of Product that the asNrql condition was converted from.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsAsNrqlCondition(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"description",
"enabled",
"entity",
"entity_guid",
"expiration",
"id",
"name",
"nrql",
"policy_id",
"runbook_url",
"signal",
"source_product",
"terms",
"title_template",
"type",
"updated_at",
"updated_by",
"violation_time_limit_seconds",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
entity = sgqlc.types.Field("EntityOutline", graphql_name="entity")
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
expiration = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionExpiration"), graphql_name="expiration"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nrql = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionQuery"), graphql_name="nrql"
)
policy_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="policyId")
runbook_url = sgqlc.types.Field(String, graphql_name="runbookUrl")
signal = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionSignal"), graphql_name="signal"
)
source_product = sgqlc.types.Field(
sgqlc.types.non_null(AlertsAsNrqlSourceProduct), graphql_name="sourceProduct"
)
terms = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AlertsNrqlTerms"))
),
graphql_name="terms",
)
title_template = sgqlc.types.Field(String, graphql_name="titleTemplate")
type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlConditionType), graphql_name="type"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")
violation_time_limit_seconds = sgqlc.types.Field(
Seconds, graphql_name="violationTimeLimitSeconds"
)6. AlertsNotificationChannel¶
A notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.id: Channel ID.name: Channel name.type: Channel type.
class AlertsNotificationChannel(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("associated_policies", "id", "name", "type")
associated_policies = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNotificationChannelPoliciesResultSet"),
graphql_name="associatedPolicies",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelType), graphql_name="type"
)7. AlertsNrqlCondition¶
A New Relic Alerts condition that uses a NRQL query to determine violations.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Configuration that defines the signal that the NRQL condition will use to evaluate.targetEntity: BETA PREVIEW: ThetargetEntityfield is in limited release. The entity explicitly targeted by the condition.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsNrqlCondition(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"description",
"enabled",
"entity",
"entity_guid",
"expiration",
"id",
"name",
"nrql",
"policy_id",
"runbook_url",
"signal",
"target_entity",
"terms",
"title_template",
"type",
"updated_at",
"updated_by",
"violation_time_limit_seconds",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
entity = sgqlc.types.Field("EntityOutline", graphql_name="entity")
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
expiration = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionExpiration"), graphql_name="expiration"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nrql = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionQuery"), graphql_name="nrql"
)
policy_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="policyId")
runbook_url = sgqlc.types.Field(String, graphql_name="runbookUrl")
signal = sgqlc.types.Field(
sgqlc.types.non_null("AlertsNrqlConditionSignal"), graphql_name="signal"
)
target_entity = sgqlc.types.Field(EntityGuid, graphql_name="targetEntity")
terms = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AlertsNrqlTerms"))
),
graphql_name="terms",
)
title_template = sgqlc.types.Field(String, graphql_name="titleTemplate")
type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlConditionType), graphql_name="type"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")
violation_time_limit_seconds = sgqlc.types.Field(
Seconds, graphql_name="violationTimeLimitSeconds"
)8. AlertsNrqlTerms¶
NRQL terms determine when a violation will be opened.
Available fields:
disableHealthStatusReporting: Violations will not change system health status for this term.operator: Operator used to compare against the threshold.priority: Priority determines how much attention your incidents need. Your workflow settings then tell us when and where to send notifications for different priorities.threshold: Value that triggers a violation.thresholdDuration: Duration, in seconds, that the condition must violate the threshold before creating a violation.thresholdOccurrences: How many data points must be in violation for the specified threshold duration.
class AlertsNrqlTerms(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"disable_health_status_reporting",
"operator",
"priority",
"threshold",
"threshold_duration",
"threshold_occurrences",
)
disable_health_status_reporting = sgqlc.types.Field(
Boolean, graphql_name="disableHealthStatusReporting"
)
operator = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlConditionTermsOperator), graphql_name="operator"
)
priority = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlConditionPriority), graphql_name="priority"
)
threshold = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="threshold")
threshold_duration = sgqlc.types.Field(
sgqlc.types.non_null(Seconds), graphql_name="thresholdDuration"
)
threshold_occurrences = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlConditionThresholdOccurrences),
graphql_name="thresholdOccurrences",
)9. AlertsOutlierConfiguration¶
Defines the common configuration fields for an outlier detection algorithm used in a NRQL condition. This interface is implemented by specific algorithm configuration types.
Available fields:
algorithm: The name of the algorithm used, i.e. ‘DBSCAN’. This field determines which specific configuration type is returned.evaluationGroupFacet: The facet name to pre-group data by before applying the outlier detection algorithm. If not specified, the algorithm is applied to all returned data.
class AlertsOutlierConfiguration(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("algorithm", "evaluation_group_facet")
algorithm = sgqlc.types.Field(String, graphql_name="algorithm")
evaluation_group_facet = sgqlc.types.Field(
String, graphql_name="evaluationGroupFacet"
)10. ApiAccessKey¶
A key for accessing New Relic APIs.
Available fields:
createdAt: The UNIX epoch when the key was created, in seconds.id: The ID of the key. This can be used to identify a key without revealing the key itself (used to update and delete).key: The keystring of the key.name: The name of the key. This can be used as a short identifier for easy reference.notes: Any notes can be attached to a key. This is intended for more a more detailed description of the key use if desired.obfuscatedKey: The obfuscated key.type: The type of key, indicating what New Relic APIs it can be used to access.
class ApiAccessKey(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"id",
"key",
"name",
"notes",
"obfuscated_key",
"type",
)
created_at = sgqlc.types.Field(EpochSeconds, graphql_name="createdAt")
id = sgqlc.types.Field(ID, graphql_name="id")
key = sgqlc.types.Field(String, graphql_name="key")
name = sgqlc.types.Field(String, graphql_name="name")
notes = sgqlc.types.Field(String, graphql_name="notes")
obfuscated_key = sgqlc.types.Field(String, graphql_name="obfuscatedKey")
type = sgqlc.types.Field(ApiAccessKeyType, graphql_name="type")11. ApiAccessKeyError¶
A key error. Each error maps to a single key input.
Available fields:
message: A message about why the key creation failed.type: The type of the key.
class ApiAccessKeyError(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(ApiAccessKeyType, graphql_name="type")12. ApmBrowserApplicationEntity¶
The ApmBrowserApplicationEntity interface provides detailed information for the Browser App injected by an APM Application.
Available fields:
apmBrowserSummary
class ApmBrowserApplicationEntity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("apm_browser_summary",)
apm_browser_summary = sgqlc.types.Field(
"ApmBrowserApplicationSummaryData", graphql_name="apmBrowserSummary"
)13. ApmBrowserApplicationEntityOutline¶
The ApmBrowserApplicationEntityOutline interface provides detailed information for the Browser App injected by an APM Application.
Available fields:
apmBrowserSummary
class ApmBrowserApplicationEntityOutline(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("apm_browser_summary",)
apm_browser_summary = sgqlc.types.Field(
"ApmBrowserApplicationSummaryData", graphql_name="apmBrowserSummary"
)14. ChangeTrackingEvent¶
The change tracking event interface.
Available fields:
category: The category of change eventcategoryAndType: The categoryType of change eventchangeTrackingId: A unique change tracking identifier.customAttributes: Represents key-value pairs of custom attributes in JSON format.description: A description of the event.entity: The NR entity associated with the event.groupId: An identifier used to correlate account-wide changes across entities. These changes are shown together in theChanges in groupsection of the change event details UI.shortDescription: This field allows you to add your own context to help you quickly identify the change events sent to our system. This field should contain a concise description of the change suitable for showing in various parts of New Relic One:
In the marker flag, shown when hovering over the pinhead of a “Changes” marker on a chart.
In the “Activity stream” panels.
If this field is left blank sensible defaults will be shown instead.
To see an example of how the shortDescription appears in change markers, see the optional attributes section of our docs.
timestamp: The start time of the change tracking event as the number of milliseconds since the Unix epoch. Defaults to now.type: The type of the change eventuser: The name or identifier of the person responsible for the change.
class ChangeTrackingEvent(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"category",
"category_and_type",
"change_tracking_id",
"custom_attributes",
"description",
"entity",
"group_id",
"short_description",
"timestamp",
"type",
"user",
)
category = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="category")
category_and_type = sgqlc.types.Field(
sgqlc.types.non_null(ChangeTrackingCategoryType), graphql_name="categoryAndType"
)
change_tracking_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="changeTrackingId"
)
custom_attributes = sgqlc.types.Field(
ChangeTrackingRawCustomAttributesMap, graphql_name="customAttributes"
)
description = sgqlc.types.Field(String, graphql_name="description")
entity = sgqlc.types.Field("EntityOutline", graphql_name="entity")
group_id = sgqlc.types.Field(String, graphql_name="groupId")
short_description = sgqlc.types.Field(String, graphql_name="shortDescription")
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")
user = sgqlc.types.Field(String, graphql_name="user")15. CloudIntegration¶
The configuration of a cloud service integration for a linked account.
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudIntegration(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"id",
"linked_account",
"name",
"nr_account_id",
"service",
"updated_at",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="createdAt"
)
id = sgqlc.types.Field(Int, graphql_name="id")
linked_account = sgqlc.types.Field(
"CloudLinkedAccount", graphql_name="linkedAccount"
)
name = sgqlc.types.Field(String, graphql_name="name")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
service = sgqlc.types.Field("CloudService", graphql_name="service")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="updatedAt"
)16. CloudProvider¶
A cloud services provider.
Available fields:
createdAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.service: Get details of one cloud provider service.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudProvider(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"icon",
"id",
"name",
"service",
"services",
"slug",
"template_params",
"updated_at",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="createdAt"
)
icon = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="icon")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
service = sgqlc.types.Field(
"CloudService",
graphql_name="service",
args=sgqlc.types.ArgDict(
(
(
"slug",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="slug", default=None
),
),
)
),
)
"""Arguments:
* `slug` (`String!`): The cloud provider short name.
"""
services = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null("CloudService"))),
graphql_name="services",
)
slug = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="slug")
template_params = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("CloudTemplateParam"))
),
graphql_name="templateParams",
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="updatedAt"
)17. CollectionEntity¶
A group of entities defined by entity search queries and specific GUIDs
Available fields:
collectionguid
class CollectionEntity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("collection", "guid")
collection = sgqlc.types.Field(
"EntityCollection",
graphql_name="collection",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
"""Arguments:
* `name` (`String!`): The name of the collection to fetch.
"""
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")18. EdgeEndpointDetail¶
The information common to all endpoints.
Available fields:
host: Full host name that is used to connect to the endpoint.port: Port that is used to connect to the endpoint.
class EdgeEndpointDetail(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("host", "port")
host = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="host")
port = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="port")19. EntityManagementActor¶
Represents an actor.
Available fields:
id: Id of the actor.type: Type of the actor.
class EntityManagementActor(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementActorType), graphql_name="type"
)20. EntityManagementApiCatalogApiContract¶
Interface for Api Contract entities
Available fields:
name: The name of the Api Contract
class EntityManagementApiCatalogApiContract(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("name",)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")21. EntityManagementEntity¶
The Entity interface.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementEntity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "name", "scope", "tags", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementMetadata"), graphql_name="metadata"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScopedReference"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementTag")),
graphql_name="tags",
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")22. EntityManagementWorkItemLinkV2¶
Work Item Link interface
Available fields:
externalId: External identifier for the work item linksourceSyncConfigurationId: Indicates which syncConfigurationId if any created this linkurl: URL of the work item link
class EntityManagementWorkItemLinkV2(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("external_id", "source_sync_configuration_id", "url")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
source_sync_configuration_id = sgqlc.types.Field(
ID, graphql_name="sourceSyncConfigurationId"
)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")23. EntityManagementWorkItemMessageV2¶
Work Item Message interface
Available fields:
content: The message contentcontentEncoding: The message encoding: UTF8(default), BASE64contentType: The message type: TEXT(default), JSON, YAMLexternalId: Optional field representing an identifier managed by the consumer.parentId: Optional id of the WorkItemMessage parent. This can be used to implement a replyTo functionality.sourceSyncConfigurationId: Optional (internal readonly), indicate which syncConfigurationId if any created this message
class EntityManagementWorkItemMessageV2(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"content",
"content_encoding",
"content_type",
"external_id",
"parent_id",
"source_sync_configuration_id",
)
content = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="content")
content_encoding = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEncodingType),
graphql_name="contentEncoding",
)
content_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementMessageType), graphql_name="contentType"
)
external_id = sgqlc.types.Field(String, graphql_name="externalId")
parent_id = sgqlc.types.Field(ID, graphql_name="parentId")
source_sync_configuration_id = sgqlc.types.Field(
ID, graphql_name="sourceSyncConfigurationId"
)24. EntityManagementWorkItemV2¶
Work Item V2 interface
Available fields:
assignedTo: Assigned entity of a work itemattributes: Collection of Work Item attributescategory: Category of the Work Itemdescription: Description of the Work ItemdueDate: Optional Epoch timestamp in milliseconds to indicate a potential due date.externalId: Represents an identifier managed by the consumerlabels: Optional list of label as alphanumeric string.links: Collection of Work Item Linksmessages: Collection of Work Item messagespriority: Priority of the work itemstatus: Status of the work item: OPEN, CLOSED
class EntityManagementWorkItemV2(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"assigned_to",
"attributes",
"category",
"description",
"due_date",
"external_id",
"labels",
"links",
"messages",
"priority",
"status",
)
assigned_to = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementWorkItemAssignment"),
graphql_name="assignedTo",
)
attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementWorkItemAttribute")),
graphql_name="attributes",
)
category = sgqlc.types.Field(
EntityManagementWorkItemCategory, graphql_name="category"
)
description = sgqlc.types.Field(String, graphql_name="description")
due_date = sgqlc.types.Field(EpochMilliseconds, graphql_name="dueDate")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
labels = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="labels"
)
links = sgqlc.types.Field("EntityManagementCollectionEntity", graphql_name="links")
messages = sgqlc.types.Field(
"EntityManagementCollectionEntity", graphql_name="messages"
)
priority = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementWorkItemPriority), graphql_name="priority"
)
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")25. EntityRelationshipEdge¶
An entity relationship.
Available fields:
createdAt: The time the relationship was created.source: The source entity of the relationship.target: The target entity of the relationship.type: The type of the relationship.
class EntityRelationshipEdge(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("created_at", "source", "target", "type")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
source = sgqlc.types.Field(
sgqlc.types.non_null("EntityRelationshipVertex"), graphql_name="source"
)
target = sgqlc.types.Field(
sgqlc.types.non_null("EntityRelationshipVertex"), graphql_name="target"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityRelationshipEdgeType), graphql_name="type"
)26. ErrorsInboxErrorGroupBase¶
A base set of fields for a grouping of similar error events.
Available fields:
assignment: User assigned to the error groupentityGuid: Source entity GuideventsQuery: NRQL formatted query for retrieving error eventsfirstSeenAt: Time of first occurrenceid: A unique identifier for the error groupisCustom: Indicates whether this error group was custom generated.
false = this is a system-generated error group
true = this is a custom error group, created and sent by the end user
issueType: Indicates the type of issue
PERFORMANCE = Any performance issue like slow query, NPlusOneQuery, etc falls under this issue type
ERROR = Any error like TransactionError, MobileRequestError, etc falls under this issue type
lastSeenAt: Time of last occurrencemessage: Error group messagename: Error group nameoccurrences: The occurrences of this error group.regressedAt: Time of regression occurrence for regressed error groupsresources: List of resources associated with this error groupsource: The source event of the error group.state: Value to indicate the current state of the group.url: The public URL of the error group detail view.
class ErrorsInboxErrorGroupBase(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"assignment",
"entity_guid",
"events_query",
"first_seen_at",
"id",
"is_custom",
"issue_type",
"last_seen_at",
"message",
"name",
"occurrences",
"regressed_at",
"resources",
"source",
"state",
"url",
)
assignment = sgqlc.types.Field("ErrorsInboxAssignment", graphql_name="assignment")
entity_guid = sgqlc.types.Field(EntityGuid, graphql_name="entityGuid")
events_query = sgqlc.types.Field(Nrql, graphql_name="eventsQuery")
first_seen_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="firstSeenAt")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
is_custom = sgqlc.types.Field(Boolean, graphql_name="isCustom")
issue_type = sgqlc.types.Field(ErrorsInboxIssueType, graphql_name="issueType")
last_seen_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastSeenAt")
message = sgqlc.types.Field(String, graphql_name="message")
name = sgqlc.types.Field(String, graphql_name="name")
occurrences = sgqlc.types.Field(
"ErrorsInboxOccurrences", graphql_name="occurrences"
)
regressed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="regressedAt")
resources = sgqlc.types.Field(
sgqlc.types.non_null("ErrorsInboxResourcesResponse"),
graphql_name="resources",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
ErrorsInboxResourceFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Current query cursor
* `filter` (`ErrorsInboxResourceFilterInput`): Set of filters to
be applied to the search.
"""
source = sgqlc.types.Field(String, graphql_name="source")
state = sgqlc.types.Field(ErrorsInboxErrorGroupState, graphql_name="state")
url = sgqlc.types.Field(String, graphql_name="url")27. ErrorsInboxResource¶
Basic external resource
Available fields:
id: Unique resource identifierurl: External resource url
class ErrorsInboxResource(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("id", "url")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")28. ErrorsInboxResponseError¶
Response error interface
Available fields:
description: The description of the error
class ErrorsInboxResponseError(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)29. InfrastructureIntegrationEntity¶
Available fields:
integrationTypeCode
class InfrastructureIntegrationEntity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("integration_type_code",)
integration_type_code = sgqlc.types.Field(
String, graphql_name="integrationTypeCode"
)30. InfrastructureIntegrationEntityOutline¶
Available fields:
integrationTypeCode
class InfrastructureIntegrationEntityOutline(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("integration_type_code",)
integration_type_code = sgqlc.types.Field(
String, graphql_name="integrationTypeCode"
)31. Nr1CatalogInstallPlanDirective¶
Information about an install plan directive
Available fields:
mode: The mode of the install plan directive
class Nr1CatalogInstallPlanDirective(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("mode",)
mode = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogInstallPlanDirectiveMode), graphql_name="mode"
)32. Nr1CatalogInstaller¶
Information about how a quickstart is installed
Available fields:
type: The type of installer
class Nr1CatalogInstaller(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogInstallerType), graphql_name="type"
)33. Nr1CatalogNerdpackItem¶
Information about an item in a Nerdpack
Available fields:
id: The unique identifier for the Nerdpack item.metadata: Metadata associated with the Nerdpack item
class Nr1CatalogNerdpackItem(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
"Nr1CatalogNerdpackItemMetadata", graphql_name="metadata"
)34. Nr1CatalogNerdpackItemMetadata¶
Metadata information for an item in a Nerdpack
Available fields:
description: A short form description for the Nerdpack item.displayName: The human-readable name for the Nerdpack item.previews: A list of previews for the Nerdpack item, such as screenshots.
class Nr1CatalogNerdpackItemMetadata(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("description", "display_name", "previews")
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
previews = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogPreview"))
),
graphql_name="previews",
)35. Nr1CatalogPreview¶
Specifies fields required for types that implement the ability to display a media preview in the New Relic One Catalog
Available fields:
url: The publicly accessible URL for the preview
class Nr1CatalogPreview(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")36. Nr1CatalogQuickstartComponent¶
Information about a component in a quickstart
Available fields:
metadata: Metadata associated with the quickstart component
class Nr1CatalogQuickstartComponent(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("metadata",)
metadata = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogQuickstartComponentMetadata"),
graphql_name="metadata",
)37. Nr1CatalogQuickstartComponentMetadata¶
Information related to the metadata attached to a quickstart component
Available fields:
description: A short form description for the quickstart component.displayName: The human-readable name for the quickstart component.
class Nr1CatalogQuickstartComponentMetadata(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("description", "display_name")
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")38. Nr1CatalogSupportedEntityTypes¶
Specifies fields required for types that implement the ability to determine the level of supported entity types.
Available fields:
mode: Determines the supported entity type mode.
class Nr1CatalogSupportedEntityTypes(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("mode",)
mode = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSupportedEntityTypesMode), graphql_name="mode"
)39. StackTraceFileBasedStackTraceFrame¶
An object representing a stack trace segment
Available fields:
filepath: Frame filepathformatted: Formatted frameline: Frame line numbername: Frame name
class StackTraceFileBasedStackTraceFrame(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("filepath", "formatted", "line", "name")
filepath = sgqlc.types.Field(String, graphql_name="filepath")
formatted = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="formatted"
)
line = sgqlc.types.Field(Int, graphql_name="line")
name = sgqlc.types.Field(String, graphql_name="name")40. SuggestedNrqlQuery¶
Interface type representing a query suggestion.
Available fields:
nrql: The NRQL string to run for the suggested querytitle: A human-readable title describing what the query shows
class SuggestedNrqlQuery(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("nrql", "title")
nrql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="nrql")
title = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="title")41. WhatsNewContent¶
Represents the details in common between all types of news.
Available fields:
contentType: The type of the news.context: Contains information about the context of the news.id: The ID of the news.publishDate: The date the news was published.summary: The summary of the news.title: The title of the news.
class WhatsNewContent(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"content_type",
"context",
"id",
"publish_date",
"summary",
"title",
)
content_type = sgqlc.types.Field(
sgqlc.types.non_null(WhatsNewContentType), graphql_name="contentType"
)
context = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="context"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
publish_date = sgqlc.types.Field(EpochMilliseconds, graphql_name="publishDate")
summary = sgqlc.types.Field(String, graphql_name="summary")
title = sgqlc.types.Field(String, graphql_name="title")42. WorkloadStatusResult¶
The details of a status that was involved in the calculation of the workload status.
Available fields:
source: Indicates where the status value derives from.value: The value of a status.
class WorkloadStatusResult(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = ("source", "value")
source = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadStatusSource), graphql_name="source"
)
value = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadStatusValue), graphql_name="value"
)43. Entity¶
The Entity interface allows fetching detailed entity information for a single entity.
To understand more about entities and entity types, look at our docs.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class Entity(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"account",
"account_id",
"alert_severity",
"alert_violations",
"deployment_search",
"domain",
"entity_type",
"first_indexed_at",
"golden_metrics",
"golden_tags",
"guid",
"indexed_at",
"last_reporting_change_at",
"name",
"nerd_storage",
"nrdb_query",
"permalink",
"recent_alert_violations",
"related_entities",
"reporting",
"service_level",
"tags",
"tags_with_metadata",
"tracing_summary",
"type",
)
account = sgqlc.types.Field("AccountOutline", graphql_name="account")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
alert_severity = sgqlc.types.Field(
EntityAlertSeverity, graphql_name="alertSeverity"
)
alert_violations = sgqlc.types.Field(
sgqlc.types.list_of("EntityAlertViolation"),
graphql_name="alertViolations",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="endTime",
default=None,
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="startTime",
default=None,
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds!`): End of time window for
violations.
* `start_time` (`EpochMilliseconds!`): Start of time window for
violations.
"""
deployment_search = sgqlc.types.Field(
"ChangeTrackingDeploymentSearchResult",
graphql_name="deploymentSearch",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
ChangeTrackingSearchFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `filter` (`ChangeTrackingSearchFilter`): Contains the set of
filters to apply to the query.
"""
domain = sgqlc.types.Field(String, graphql_name="domain")
entity_type = sgqlc.types.Field(EntityType, graphql_name="entityType")
first_indexed_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="firstIndexedAt"
)
golden_metrics = sgqlc.types.Field(
"EntityGoldenContextScopedGoldenMetrics",
graphql_name="goldenMetrics",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
EntityGoldenContextInput, graphql_name="context", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
EntityGoldenNrqlTimeWindowInput,
graphql_name="timeWindow",
default=None,
),
),
)
),
)
golden_tags = sgqlc.types.Field(
"EntityGoldenContextScopedGoldenTags",
graphql_name="goldenTags",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
EntityGoldenContextInput, graphql_name="context", default=None
),
),
)
),
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
indexed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="indexedAt")
last_reporting_change_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="lastReportingChangeAt"
)
name = sgqlc.types.Field(String, graphql_name="name")
nerd_storage = sgqlc.types.Field(
"NerdStorageEntityScope", graphql_name="nerdStorage"
)
nrdb_query = sgqlc.types.Field(
"NrdbResultContainer",
graphql_name="nrdbQuery",
args=sgqlc.types.ArgDict(
(
(
"async_",
sgqlc.types.Arg(Boolean, graphql_name="async", default=False),
),
(
"nrql",
sgqlc.types.Arg(
sgqlc.types.non_null(Nrql), graphql_name="nrql", default=None
),
),
(
"options",
sgqlc.types.Arg(
NrqlQueryOptions, graphql_name="options", default=None
),
),
(
"timeout",
sgqlc.types.Arg(Seconds, graphql_name="timeout", default=None),
),
)
),
)
"""Arguments:
* `async_` (`Boolean`): When true, the query will begin
asynchronous resolution after the allotted `timeout`. Include
`queryProgress` fields in your GraphQL query to receive the
information you will need to poll the `nrdbQueryProgress` field
for the results of your async NRQL query. See [this page](https
://docs.newrelic.com/docs/apis/nerdgraph/examples/async-queries-
nrql-tutorial) for additional asynchronous query documentation.
(default: `false`)
* `nrql` (`Nrql!`): The
[NRQL](https://docs.newrelic.com/docs/insights/nrql-new-relic-
query-language/nrql-resources/nrql-syntax-components-functions)
query string.
* `options` (`NrqlQueryOptions`): Additional options for NRQL
queries.
* `timeout` (`Seconds`): The timeout we will apply to the NRQL
Query. The value will be clamped to between 5 and 120 seconds
and defaults to 5 seconds. For `async` queries, if the query is
still incomplete after this amount of time, resolution will
become asynchronous and return `queryProgress` data if
requested.
"""
permalink = sgqlc.types.Field(String, graphql_name="permalink")
recent_alert_violations = sgqlc.types.Field(
sgqlc.types.list_of("EntityAlertViolation"),
graphql_name="recentAlertViolations",
args=sgqlc.types.ArgDict(
(("count", sgqlc.types.Arg(Int, graphql_name="count", default=None)),)
),
)
"""Arguments:
* `count` (`Int`): The desired number of alert violations to be
returned.
"""
related_entities = sgqlc.types.Field(
"EntityRelationshipRelatedEntitiesResult",
graphql_name="relatedEntities",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
EntityRelationshipEdgeFilter,
graphql_name="filter",
default=None,
),
),
("limit", sgqlc.types.Arg(Int, graphql_name="limit", default=None)),
)
),
)
"""Arguments:
* `cursor` (`String`): The cursor to fetch paginated results.
* `filter` (`EntityRelationshipEdgeFilter`): Apply an optional
filter to the related entities.
* `limit` (`Int`): A limit to apply to the number of relationships
returned. Note: this option can only lower the default limits
(2000 relationships).
"""
reporting = sgqlc.types.Field(Boolean, graphql_name="reporting")
service_level = sgqlc.types.Field(
"ServiceLevelDefinition", graphql_name="serviceLevel"
)
tags = sgqlc.types.Field(sgqlc.types.list_of("EntityTag"), graphql_name="tags")
tags_with_metadata = sgqlc.types.Field(
sgqlc.types.list_of("EntityTagWithMetadata"), graphql_name="tagsWithMetadata"
)
tracing_summary = sgqlc.types.Field(
"DistributedTracingEntityTracingSummary",
graphql_name="tracingSummary",
args=sgqlc.types.ArgDict(
(
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `time_window` (`TimeWindowInput`): The start and end of the
tracing data. Defaults to the last 30 minutes
"""
type = sgqlc.types.Field(String, graphql_name="type")44. EntityOutline¶
The EntityOutline interface object allows fetching basic entity data for many entities at a time.
To understand more about entities and entity types, look at our docs.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class EntityOutline(sgqlc.types.Interface):
__schema__ = nerdgraph
__field_names__ = (
"account",
"account_id",
"alert_severity",
"domain",
"entity_type",
"first_indexed_at",
"golden_metrics",
"golden_tags",
"guid",
"indexed_at",
"last_reporting_change_at",
"name",
"permalink",
"reporting",
"service_level",
"tags",
"type",
)
account = sgqlc.types.Field("AccountOutline", graphql_name="account")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
alert_severity = sgqlc.types.Field(
EntityAlertSeverity, graphql_name="alertSeverity"
)
domain = sgqlc.types.Field(String, graphql_name="domain")
entity_type = sgqlc.types.Field(EntityType, graphql_name="entityType")
first_indexed_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="firstIndexedAt"
)
golden_metrics = sgqlc.types.Field(
"EntityGoldenContextScopedGoldenMetrics",
graphql_name="goldenMetrics",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
EntityGoldenContextInput, graphql_name="context", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
EntityGoldenNrqlTimeWindowInput,
graphql_name="timeWindow",
default=None,
),
),
)
),
)
golden_tags = sgqlc.types.Field(
"EntityGoldenContextScopedGoldenTags",
graphql_name="goldenTags",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
EntityGoldenContextInput, graphql_name="context", default=None
),
),
)
),
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
indexed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="indexedAt")
last_reporting_change_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="lastReportingChangeAt"
)
name = sgqlc.types.Field(String, graphql_name="name")
permalink = sgqlc.types.Field(String, graphql_name="permalink")
reporting = sgqlc.types.Field(Boolean, graphql_name="reporting")
service_level = sgqlc.types.Field(
"ServiceLevelDefinition", graphql_name="serviceLevel"
)
tags = sgqlc.types.Field(sgqlc.types.list_of("EntityTag"), graphql_name="tags")
type = sgqlc.types.Field(String, graphql_name="type")Object types¶
1. Account¶
The Account object provides general data about the account, as well as
being the entry point into more detailed data about a single account.
Account configuration data is queried through this object, as well as telemetry data that is specific to a single account.
Available fields:
agentEnvironment: This field provides access to AgentEnvironment data.aiDecisions: This field provides access to AiDecisions data.aiIssues: This field provides access to AiIssues data.aiNotifications: This field provides access to AiNotifications data.aiTopology: This field provides access to AiTopology data.aiWorkflows: This field provides access to AiWorkflows data.alerts: This field provides access to Alerts data.cloud: Thecloudfield provides access to cloud integrations configuration data.
For details and query examples visit our docs.
dataManagement: This field provides access to DataManagement data.edge: This field provides access to Edge data.eventsToMetrics: This field provides access to EventsToMetrics data.historicalDataExport: This field provides access to HistoricalDataExport data.idincidentIntelligenceEnvironment: This field provides access to IncidentIntelligenceEnvironment data.installation: This field provides access to Installation data.logConfigurations: This field provides access to LogConfigurations data.machineLearning: This field provides access to MachineLearning data.metricNormalization: This field provides access to MetricNormalization data.namenerdStorage: NerdStorage is a document database that is accessible within the New Relic One interface. This allows for persistence of Nerdpack data including users’ configuration settings and preferences (like favorites), or any other small data sets.
Conceptually, you can imagine NerdStorage as a nested key-value map.
For information on New Relic NerdStorage, visit our docs.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
nrql: Make a query to NRDB with a NRQL string.
See the NRQL Docs for more information about generating a query string.
Example NRQL query:
SELECT count(*) FROM Transaction TIMESERIESFor more details on how to use NRQL in the GraphQL API, visit our docs
nrqlDropRules: This field provides access to NrqlDropRules data.nrqlQueryProgress: Poll for the results of a previously-executed asychronous NRDB query.
The queryId is available in the queryProgress data returned by the original asynchronous query.
See this page for additional asynchronous query documentation.
pixie: This field provides access to Pixie data.streamingExport: This field provides access to StreamingExport data.synthetics: This field provides access to Synthetics data.workflowAutomation: This field provides access to WorkflowAutomation data.workload: This field provides access to Workload data.
class Account(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"agent_environment",
"ai_decisions",
"ai_issues",
"ai_notifications",
"ai_topology",
"ai_workflows",
"alerts",
"cloud",
"data_management",
"edge",
"events_to_metrics",
"historical_data_export",
"id",
"incident_intelligence_environment",
"installation",
"log_configurations",
"machine_learning",
"metric_normalization",
"name",
"nerd_storage",
"nrql",
"nrql_drop_rules",
"nrql_query_progress",
"pixie",
"streaming_export",
"synthetics",
"workflow_automation",
"workload",
)
agent_environment = sgqlc.types.Field(
"AgentEnvironmentAccountStitchedFields", graphql_name="agentEnvironment"
)
ai_decisions = sgqlc.types.Field(
"AiDecisionsAccountStitchedFields", graphql_name="aiDecisions"
)
ai_issues = sgqlc.types.Field(
"AiIssuesAccountStitchedFields", graphql_name="aiIssues"
)
ai_notifications = sgqlc.types.Field(
"AiNotificationsAccountStitchedFields", graphql_name="aiNotifications"
)
ai_topology = sgqlc.types.Field(
"AiTopologyAccountStitchedFields", graphql_name="aiTopology"
)
ai_workflows = sgqlc.types.Field(
"AiWorkflowsAccountStitchedFields", graphql_name="aiWorkflows"
)
alerts = sgqlc.types.Field("AlertsAccountStitchedFields", graphql_name="alerts")
cloud = sgqlc.types.Field("CloudAccountFields", graphql_name="cloud")
data_management = sgqlc.types.Field(
"DataManagementAccountStitchedFields", graphql_name="dataManagement"
)
edge = sgqlc.types.Field("EdgeAccountStitchedFields", graphql_name="edge")
events_to_metrics = sgqlc.types.Field(
"EventsToMetricsAccountStitchedFields", graphql_name="eventsToMetrics"
)
historical_data_export = sgqlc.types.Field(
"HistoricalDataExportAccountStitchedFields", graphql_name="historicalDataExport"
)
id = sgqlc.types.Field(Int, graphql_name="id")
incident_intelligence_environment = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentAccountStitchedFields",
graphql_name="incidentIntelligenceEnvironment",
)
installation = sgqlc.types.Field(
"InstallationAccountStitchedFields", graphql_name="installation"
)
log_configurations = sgqlc.types.Field(
"LogConfigurationsAccountStitchedFields", graphql_name="logConfigurations"
)
machine_learning = sgqlc.types.Field(
"MachineLearningAccountStitchedFields", graphql_name="machineLearning"
)
metric_normalization = sgqlc.types.Field(
"MetricNormalizationAccountStitchedFields", graphql_name="metricNormalization"
)
name = sgqlc.types.Field(String, graphql_name="name")
nerd_storage = sgqlc.types.Field(
"NerdStorageAccountScope", graphql_name="nerdStorage"
)
nrql = sgqlc.types.Field(
"NrdbResultContainer",
graphql_name="nrql",
args=sgqlc.types.ArgDict(
(
(
"async_",
sgqlc.types.Arg(Boolean, graphql_name="async", default=False),
),
(
"options",
sgqlc.types.Arg(
NrqlQueryOptions, graphql_name="options", default=None
),
),
(
"query",
sgqlc.types.Arg(
sgqlc.types.non_null(Nrql), graphql_name="query", default=None
),
),
(
"timeout",
sgqlc.types.Arg(Seconds, graphql_name="timeout", default=None),
),
)
),
)
"""Arguments:
* `async_` (`Boolean`): When true, the query will begin
asynchronous resolution after the allotted `timeout`. Include
`queryProgress` fields in your GraphQL query to receive the
information you will need to poll the `nrqlQueryProgress` field
for the results of your async NRQL query. See [this page](https
://docs.newrelic.com/docs/apis/nerdgraph/examples/async-queries-
nrql-tutorial) for additional asynchronous query documentation.
(default: `false`)
* `options` (`NrqlQueryOptions`): Additional options for NRQL
queries.
* `query` (`Nrql!`): The
[NRQL](https://docs.newrelic.com/docs/insights/nrql-new-relic-
query-language/nrql-resources/nrql-syntax-components-functions)
query string.
* `timeout` (`Seconds`): The timeout we will apply to the NRQL
Query. The value will be clamped to between 5 and 120 seconds
and defaults to 5 seconds. For `async` queries, if the query is
still incomplete after this amount of time, resolution will
become asynchronous and return `queryProgress` data if
requested.
"""
nrql_drop_rules = sgqlc.types.Field(
"NrqlDropRulesAccountStitchedFields", graphql_name="nrqlDropRules"
)
nrql_query_progress = sgqlc.types.Field(
"NrdbResultContainer",
graphql_name="nrqlQueryProgress",
args=sgqlc.types.ArgDict(
(
(
"query_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="queryId", default=None
),
),
)
),
)
"""Arguments:
* `query_id` (`ID!`): A token for retrieving the results of a
previously executed asynchronous query.
"""
pixie = sgqlc.types.Field("PixieAccountStitchedFields", graphql_name="pixie")
streaming_export = sgqlc.types.Field(
"StreamingExportAccountStitchedFields", graphql_name="streamingExport"
)
synthetics = sgqlc.types.Field(
"SyntheticsAccountStitchedFields", graphql_name="synthetics"
)
workflow_automation = sgqlc.types.Field(
"WorkflowAutomationAccountStitchedFields", graphql_name="workflowAutomation"
)
workload = sgqlc.types.Field(
"WorkloadAccountStitchedFields", graphql_name="workload"
)2. AccountManagementCreateResponse¶
The return object for a create-account mutation.
Available fields:
managedAccount: Information about the newly created account.
class AccountManagementCreateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("managed_account",)
managed_account = sgqlc.types.Field(
"AccountManagementManagedAccount", graphql_name="managedAccount"
)3. AccountManagementManagedAccount¶
Account data view for administration tasks.
Available fields:
id: The account ID.isCanceled: True if account is canceledname: The name of the account.regionCode: The data center region for the account (US or EU).
class AccountManagementManagedAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "is_canceled", "name", "region_code")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
is_canceled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isCanceled"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
region_code = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="regionCode"
)4. AccountManagementOrganizationStitchedFields¶
The field type for stitching into the NerdGraph schema.
Available fields:
managedAccounts: Admin-level info about the accounts in an organization.
class AccountManagementOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("managed_accounts",)
managed_accounts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AccountManagementManagedAccount)),
graphql_name="managedAccounts",
args=sgqlc.types.ArgDict(
(
(
"is_canceled",
sgqlc.types.Arg(Boolean, graphql_name="isCanceled", default=None),
),
)
),
)
"""Arguments:
* `is_canceled` (`Boolean`): Input for filtering by canceled
status
"""5. AccountManagementUpdateResponse¶
The return object for an update-account mutation.
Available fields:
managedAccount: Information about an updated account
class AccountManagementUpdateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("managed_account",)
managed_account = sgqlc.types.Field(
AccountManagementManagedAccount, graphql_name="managedAccount"
)6. AccountOutline¶
The AccountOutline object provides basic data about an account.
Available fields:
idnamereportingEventTypes: Returns event types that are currently reporting in the account.
class AccountOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name", "reporting_event_types")
id = sgqlc.types.Field(Int, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
reporting_event_types = sgqlc.types.Field(
sgqlc.types.list_of(String),
graphql_name="reportingEventTypes",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
sgqlc.types.list_of(String), graphql_name="filter", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `filter` (`[String]`): Filter results to a chosen set of event
types.
* `time_window` (`TimeWindowInput`)None
"""7. AccountReference¶
The AccountReference object provides basic identifying information about the account.
Available fields:
idname
class AccountReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(Int, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")8. Actor¶
The Actor object contains fields that are scoped to the API user’s access level.
Available fields:
account: Theaccountfield is the entry point into data that is scoped to a single account.accounts: Theaccountsfield returns all accounts that the Actor is authorized to view.apiAccess: This field provides access to ApiAccess data.changeTracking: This field provides access to ChangeTracking data.cloud: Thecloudfield provides access to cloud integrations configuration data scoped to the Actor.collaboration: This field provides access to Collaboration data.dashboard: This field provides access to Dashboard data.dataSourceGaps: This field provides access to DataSourceGaps data.distributedTracing: This field provides access to DistributedTracing data.entities: Fetch a list of entities.
You can fetch a max of 25 entities in one query.
For more details on entities, visit our entity docs.
entity: Fetch a single entity.
For more details on entities, visit our entity docs.
entityManagement: This field provides access to EntityManagement data.entitySearch: Search for entities using a custom query.
For more details on how to create a custom query and what entity data you can request, visit our entity docs.
Note: you must supply either a query OR a queryBuilder argument, not both.
errorsInbox: This field provides access to ErrorsInbox data.fleetControl: This field provides access to FleetControl data.incidentIntelligenceEnvironment: This field provides access to IncidentIntelligenceEnvironment data.machineLearning: This field provides access to MachineLearning data.mobilePushNotification: This field provides access to MobilePushNotification data.nerdStorage: NerdStorage is a document database that is accessible within the New Relic One interface. This allows for persistence of Nerdpack data including users’ configuration settings and preferences (like favorites), or any other small data sets.
Conceptually, you can imagine NerdStorage as a nested key-value map.
For information on New Relic NerdStorage, visit our docs.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
nerdStorageVault: This field provides access to NerdStorageVault data.nerdpacks: Nerdpacks registry. Provides queries for nerdpacks by different conditionsnr1Catalog: This field provides access to Nr1Catalog data.nrql: Make a query to NRDB with a NRQL string.
See the NRQL Docs for more information about generating a query string.
Example NRQL query:
SELECT count(*) FROM Transaction TIMESERIESFor more details on how to use NRQL in the GraphQL API, visit our docs
nrqlQueryProgress: Poll for the results of a previously-executed asychronous NRDB query.
The queryId is available in the queryProgress data returned by the original asynchronous query.
See this page for additional asynchronous query documentation.
organization: Theorganizationfield is the entry point into data that is scoped to the user’s organization.pixie: This field provides access to Pixie data.queryHistory: This field provides access to QueryHistory data.sessions: Query for a collection of sessionsuser: The authenticatedUserwho made this request.users: This field provides access to Users data.workflowAutomation: This field provides access to WorkflowAutomation data.
class Actor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"accounts",
"api_access",
"change_tracking",
"cloud",
"collaboration",
"dashboard",
"data_source_gaps",
"distributed_tracing",
"entities",
"entity",
"entity_management",
"entity_search",
"errors_inbox",
"fleet_control",
"incident_intelligence_environment",
"machine_learning",
"mobile_push_notification",
"nerd_storage",
"nerd_storage_vault",
"nerdpacks",
"nr1_catalog",
"nrql",
"nrql_query_progress",
"organization",
"pixie",
"query_history",
"sessions",
"user",
"users",
"workflow_automation",
)
account = sgqlc.types.Field(
Account,
graphql_name="account",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`Int!`): The New Relic account ID you want to query.
"""
accounts = sgqlc.types.Field(
sgqlc.types.list_of(AccountOutline),
graphql_name="accounts",
args=sgqlc.types.ArgDict(
(
(
"scope",
sgqlc.types.Arg(
RegionScope, graphql_name="scope", default="IN_REGION"
),
),
)
),
)
api_access = sgqlc.types.Field(
"ApiAccessActorStitchedFields", graphql_name="apiAccess"
)
change_tracking = sgqlc.types.Field(
"ChangeTrackingActorStitchedFields", graphql_name="changeTracking"
)
cloud = sgqlc.types.Field("CloudActorFields", graphql_name="cloud")
collaboration = sgqlc.types.Field(
"CollaborationActorStitchedFields", graphql_name="collaboration"
)
dashboard = sgqlc.types.Field(
"DashboardActorStitchedFields", graphql_name="dashboard"
)
data_source_gaps = sgqlc.types.Field(
"DataSourceGapsActorStitchedFields", graphql_name="dataSourceGaps"
)
distributed_tracing = sgqlc.types.Field(
"DistributedTracingActorStitchedFields", graphql_name="distributedTracing"
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(Entity),
graphql_name="entities",
args=sgqlc.types.ArgDict(
(
(
"guids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(EntityGuid)),
graphql_name="guids",
default=None,
),
),
)
),
)
"""Arguments:
* `guids` (`[EntityGuid]!`): A list of unique entity identifiers.
"""
entity = sgqlc.types.Field(
Entity,
graphql_name="entity",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): A unique entity identifier.
"""
entity_management = sgqlc.types.Field(
"EntityManagementActorStitchedFields", graphql_name="entityManagement"
)
entity_search = sgqlc.types.Field(
"EntitySearch",
graphql_name="entitySearch",
args=sgqlc.types.ArgDict(
(
(
"options",
sgqlc.types.Arg(
EntitySearchOptions, graphql_name="options", default=None
),
),
("query", sgqlc.types.Arg(String, graphql_name="query", default=None)),
(
"query_builder",
sgqlc.types.Arg(
EntitySearchQueryBuilder,
graphql_name="queryBuilder",
default=None,
),
),
(
"sort_by",
sgqlc.types.Arg(
sgqlc.types.list_of(EntitySearchSortCriteria),
graphql_name="sortBy",
default=("NAME",),
),
),
(
"sort_by_with_direction",
sgqlc.types.Arg(
sgqlc.types.list_of(SortCriterionWithDirection),
graphql_name="sortByWithDirection",
default=None,
),
),
)
),
)
"""Arguments:
* `options` (`EntitySearchOptions`): Additional options to apply
to the entity search.
* `query` (`String`): Entity search query string. The query string
can search for an exact or fuzzy match on name, as well as
searching several other attributes. Note: you must supply
either a `query` OR a `queryBuilder` argument, not both.
Operators available: `=`, `AND`, `IN`, `LIKE` Special
characters (`.,;:*-_`) are treated as whitespace. For example,
name LIKE ':aws:' will match `-aws.` or `foo aws.` Tags can be
referenced in multiple ways with or without backticks.
Examples: - `"name = 'MyApp (Staging)'` - `"name LIKE 'MyApp'
AND type IN ('APPLICATION')"` - `"reporting = 'false' AND type
IN ('HOST')"` - `"domain IN ('INFRA', 'APM')"` -
`tags.Environment = 'staging' AND type IN ('APPLICATION')`
* `query_builder` (`EntitySearchQueryBuilder`): The query builder
object can be used to discover and create the entity search
query argument. This should be used as a means to discover, but
it has limited functionality. For example, it can only search
for one entity `type` at a time. The `queryBuilder` parameters
do not include all possible entity `type`s, entity `domain`s, or
`infrastructureIntegrationType`s. To see the query string that
is generated by your `queryBuilder` search, ask for the `query`
field in the result object. You can then use this to build a
more complex query supplied to the `query` argument and remove
your `queryBuilder`. Note: you must supply either a `query` OR
a `queryBuilder` argument, not both.
* `sort_by` (`[EntitySearchSortCriteria]`): The criteria used to
sort your entity search results. If both are provided,
`sortByWithDirection` will take precedence over `sortBy`.
(default: `[NAME]`)
* `sort_by_with_direction` (`[SortCriterionWithDirection]`): Sort
by criteria and direction. If both are provided,
`sortByWithDirection` will take precedence over `sortBy`.
"""
errors_inbox = sgqlc.types.Field(
"ErrorsInboxActorStitchedFields", graphql_name="errorsInbox"
)
fleet_control = sgqlc.types.Field(
"FleetControlActorStitchedFields", graphql_name="fleetControl"
)
incident_intelligence_environment = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentActorStitchedFields",
graphql_name="incidentIntelligenceEnvironment",
)
machine_learning = sgqlc.types.Field(
"MachineLearningActorStitchedFields", graphql_name="machineLearning"
)
mobile_push_notification = sgqlc.types.Field(
"MobilePushNotificationActorStitchedFields",
graphql_name="mobilePushNotification",
)
nerd_storage = sgqlc.types.Field(
"NerdStorageActorScope", graphql_name="nerdStorage"
)
nerd_storage_vault = sgqlc.types.Field(
"NerdStorageVaultActorStitchedFields", graphql_name="nerdStorageVault"
)
nerdpacks = sgqlc.types.Field("NerdpackNerdpacks", graphql_name="nerdpacks")
nr1_catalog = sgqlc.types.Field(
"Nr1CatalogActorStitchedFields", graphql_name="nr1Catalog"
)
nrql = sgqlc.types.Field(
"CrossAccountNrdbResultContainer",
graphql_name="nrql",
args=sgqlc.types.ArgDict(
(
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Int))
),
graphql_name="accounts",
default=None,
),
),
(
"async_",
sgqlc.types.Arg(Boolean, graphql_name="async", default=False),
),
(
"options",
sgqlc.types.Arg(
NrqlQueryOptions, graphql_name="options", default=None
),
),
(
"query",
sgqlc.types.Arg(
sgqlc.types.non_null(Nrql), graphql_name="query", default=None
),
),
(
"timeout",
sgqlc.types.Arg(Seconds, graphql_name="timeout", default=None),
),
)
),
)
"""Arguments:
* `accounts` (`[Int!]!`): List of account IDs to return NRDB
results from. Max of 5 can be supplied.
* `async_` (`Boolean`): When true, the query will begin
asynchronous resolution after the allotted `timeout`. Include
`queryProgress` fields in your GraphQL query to receive the
information you will need to poll the `nrqlQueryProgress` field
for the results of your async NRQL query. See [this page](https
://docs.newrelic.com/docs/apis/nerdgraph/examples/async-queries-
nrql-tutorial) for additional asynchronous query documentation.
(default: `false`)
* `options` (`NrqlQueryOptions`): Additional options for NRQL
queries.
* `query` (`Nrql!`): The
[NRQL](https://docs.newrelic.com/docs/insights/nrql-new-relic-
query-language/nrql-resources/nrql-syntax-components-functions)
query string.
* `timeout` (`Seconds`): The timeout we will apply to the NRQL
Query. The value will be clamped to between 5 and 120 seconds
and defaults to 5 seconds. For `async` queries, if the query is
still incomplete after this amount of time, resolution will
become asynchronous and return `queryProgress` data if
requested.
"""
nrql_query_progress = sgqlc.types.Field(
"CrossAccountNrdbResultContainer",
graphql_name="nrqlQueryProgress",
args=sgqlc.types.ArgDict(
(
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Int))
),
graphql_name="accounts",
default=None,
),
),
(
"query_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="queryId", default=None
),
),
)
),
)
"""Arguments:
* `accounts` (`[Int!]!`): List of account IDs associated with
`queryId`. Must match the account IDs of the original
asynchronous query. Max of 5 can be supplied.
* `query_id` (`ID!`): A token for retrieving the results of a
previously executed asynchronous query.
"""
organization = sgqlc.types.Field("Organization", graphql_name="organization")
pixie = sgqlc.types.Field("PixieActorStitchedFields", graphql_name="pixie")
query_history = sgqlc.types.Field(
"QueryHistoryActorStitchedFields", graphql_name="queryHistory"
)
sessions = sgqlc.types.Field(
"SessionsSessionCollection",
graphql_name="sessions",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
SessionsSessionFilter, graphql_name="filter", default=None
),
),
)
),
)
user = sgqlc.types.Field("User", graphql_name="user")
users = sgqlc.types.Field("UsersActorStitchedFields", graphql_name="users")
workflow_automation = sgqlc.types.Field(
"WorkflowAutomationActorStitchedFields", graphql_name="workflowAutomation"
)9. AgentApplicationAddAppToEntityPlatformResult¶
The result of reindex an application to entity.
Available fields:
guid: The GUID for the entitymessage: error messagename: The name of the applicationsuccess: Did it succeed?
class AgentApplicationAddAppToEntityPlatformResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid", "message", "name", "success")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
message = sgqlc.types.Field(String, graphql_name="message")
name = sgqlc.types.Field(String, graphql_name="name")
success = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="success")10. AgentApplicationApmBrowserSettings¶
The settings of a browser application.
Available fields:
cookiesEnabled: Configure session tracking. The default is enabled: true.distributedTracingEnabled: Configure distributed tracing in browser apps. The default is enabled: true.loaderType: Determines which browser loader will be configured. The default is “SPA”.
class AgentApplicationApmBrowserSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("cookies_enabled", "distributed_tracing_enabled", "loader_type")
cookies_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="cookiesEnabled"
)
distributed_tracing_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="distributedTracingEnabled"
)
loader_type = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationBrowserLoader), graphql_name="loaderType"
)11. AgentApplicationBrowserSettings¶
The settings of a browser application. Includes loader script.
Available fields:
cookiesEnabled: Configure session tracking. The default is enabled: true.distributedTracingEnabled: Configure distributed tracing in browser apps. The default is enabled: true.loaderScript: The snippet of JavaScript used to copy/paste into your JavaScript app if you aren’t using an auto-instrumenting agent on the backend. Note that the resulting snippet will be a JSON string that will need to be parsed before using in your browser application.loaderType: Determines which browser loader will be configured. The default is “SPA”.
class AgentApplicationBrowserSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"cookies_enabled",
"distributed_tracing_enabled",
"loader_script",
"loader_type",
)
cookies_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="cookiesEnabled"
)
distributed_tracing_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="distributedTracingEnabled"
)
loader_script = sgqlc.types.Field(String, graphql_name="loaderScript")
loader_type = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationBrowserLoader), graphql_name="loaderType"
)12. AgentApplicationCreateBrowserResult¶
The result of creating a browser application.
Available fields:
guid: The GUID for the affected Entity.isGhostApp: Indicates if this is an existing application that was not indexed.name: The name of the application.settings: Fields related to browser settings.
class AgentApplicationCreateBrowserResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid", "is_ghost_app", "name", "settings")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
is_ghost_app = sgqlc.types.Field(Boolean, graphql_name="isGhostApp")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
settings = sgqlc.types.Field(
AgentApplicationBrowserSettings, graphql_name="settings"
)13. AgentApplicationCreateMobileResult¶
The result of creating a mobile application.
Available fields:
accountId: The application’s account ID.applicationToken: The mobile application’s token.entityOutline: Additional information about the mobile application.guid: The new mobile application’s GUID.isGhostApp: Indicates if this is an existing application that was not indexed.name: The application’s name.
class AgentApplicationCreateMobileResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"application_token",
"entity_outline",
"guid",
"is_ghost_app",
"name",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
application_token = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="applicationToken"
)
entity_outline = sgqlc.types.Field(EntityOutline, graphql_name="entityOutline")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
is_ghost_app = sgqlc.types.Field(Boolean, graphql_name="isGhostApp")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")14. AgentApplicationDeleteResult¶
The result of deleting an application.
Available fields:
success: Did the delete succeed?
class AgentApplicationDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("success",)
success = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="success")15. AgentApplicationEnableBrowserResult¶
The result of enabling browser monitoring for an APM-monitored application.
Available fields:
name: The application’s namesettings: Fields related to browser settings.
class AgentApplicationEnableBrowserResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "settings")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
settings = sgqlc.types.Field(
AgentApplicationApmBrowserSettings, graphql_name="settings"
)16. AgentApplicationSegmentsBrowserSegmentAllowList¶
The allow list object for browser applications.
Available fields:
segments: The url segments that are allowed.
class AgentApplicationSegmentsBrowserSegmentAllowList(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("segments",)
segments = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="segments")17. AgentApplicationSegmentsBrowserSegmentAllowListResult¶
The resulting allow list after the modifications have been made.
Available fields:
entityGuid: The NR1 entity guid.segments: The aggregate result of the segments in the modified list or lists.
class AgentApplicationSegmentsBrowserSegmentAllowListResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity_guid", "segments")
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
segments = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="segments")18. AgentApplicationSettingsApmBase¶
Settings that are applicable to APM applications and their agents.
Available fields:
alias: The name for the applicationapmConfig: Access general settings for the application.applicationLogging: Access log forwarding settings for the application.captureMemcacheKeys: Enable or disable the capture of memcache keys.errorCollector: Access error collector settings for the application. The error collector captures information about uncaught exceptions and sends them to New Relic for viewing.jfr: Access enabled state for the Java Flight Recorder. This is available only for the Java language agent version 8.0.0 or later.originalName: The name originally given to the application for reporting.slowSql: In APM, when transaction traces are collected, there may be additional Slow query data available.threadProfiler: Measures wall clock time, CPU time, and method call counts in your application’s threads as they run.tracerType: Type of tracer used. APM’s cross application tracing links transactions between APM apps in your service-oriented architecture (SOA). Distributed tracing is an improvement on the cross application tracing feature, and is recommended for large, distributed systems.transactionTracer: Access transaction tracer settings for the application.
class AgentApplicationSettingsApmBase(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"alias",
"apm_config",
"application_logging",
"capture_memcache_keys",
"error_collector",
"jfr",
"original_name",
"slow_sql",
"thread_profiler",
"tracer_type",
"transaction_tracer",
)
alias = sgqlc.types.Field(String, graphql_name="alias")
apm_config = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsApmConfig"),
graphql_name="apmConfig",
)
application_logging = sgqlc.types.Field(
"AgentApplicationSettingsApplicationLogging", graphql_name="applicationLogging"
)
capture_memcache_keys = sgqlc.types.Field(
Boolean, graphql_name="captureMemcacheKeys"
)
error_collector = sgqlc.types.Field(
"AgentApplicationSettingsErrorCollector", graphql_name="errorCollector"
)
jfr = sgqlc.types.Field("AgentApplicationSettingsJfr", graphql_name="jfr")
original_name = sgqlc.types.Field(String, graphql_name="originalName")
slow_sql = sgqlc.types.Field(
"AgentApplicationSettingsSlowSql", graphql_name="slowSql"
)
thread_profiler = sgqlc.types.Field(
"AgentApplicationSettingsThreadProfiler", graphql_name="threadProfiler"
)
tracer_type = sgqlc.types.Field(
AgentApplicationSettingsTracer, graphql_name="tracerType"
)
transaction_tracer = sgqlc.types.Field(
"AgentApplicationSettingsTransactionTracer", graphql_name="transactionTracer"
)19. AgentApplicationSettingsApmConfig¶
General settings related to APM applications.
Available fields:
apdexTarget: The desired target for the APDEX measurement of this APM application.useServerSideConfig: Sets if agents for this APM application should get some of their configuration from the server.
class AgentApplicationSettingsApmConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("apdex_target", "use_server_side_config")
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")
use_server_side_config = sgqlc.types.Field(
Boolean, graphql_name="useServerSideConfig"
)20. AgentApplicationSettingsApplicationExitInfo¶
Reports on application exits, which can be used to determine if an application is not responding.
Available fields:
enabled: Whether or not application exit info is collected.
class AgentApplicationSettingsApplicationExitInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")21. AgentApplicationSettingsApplicationLogging¶
Monitoring application logs is crucial for maintaining health and performance, directly impacting user satisfaction, operational efficiency, and overall product quality.
Available fields:
enabled: Configure agent to capture logs and forward them to New Relic One.forwarding: Manages the configuration for automatic log forwarding for APM, including logs in context.localDecorating: Controls whether locally stored log lines are decorated or not. This is independent of whether log forwarding is enabled or not and is used to support customers that want to use a separate log forwarding solution.metrics: Enables the capture of metrics information about your logs and log levels, which is displayed in a chart on the APM Summary page.
class AgentApplicationSettingsApplicationLogging(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "forwarding", "local_decorating", "metrics")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
forwarding = sgqlc.types.Field(
"AgentApplicationSettingsForwarding", graphql_name="forwarding"
)
local_decorating = sgqlc.types.Field(
"AgentApplicationSettingsLocalDecorating", graphql_name="localDecorating"
)
metrics = sgqlc.types.Field(
"AgentApplicationSettingsMetrics", graphql_name="metrics"
)22. AgentApplicationSettingsBrowserAjax¶
Enables ajax traces in the browser app.
Available fields:
denyList: List of domains excluded from Ajax traces by the browser agent.
class AgentApplicationSettingsBrowserAjax(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deny_list",)
deny_list = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="denyList"
)23. AgentApplicationSettingsBrowserBase¶
Settings that are applicable to browser applications.
Available fields:
browserConfig: Access general settings for the application.browserConsentMode: Browser consent mode configuration for privacy compliance and consent management platform integration.browserMonitoring: browser monitoring provides real user monitoring (RUM) that measures the speed and performance of end users as they navigate the application using different web browsers, devices, operating systems, and networks.browserPerformance: Browser Performance configuration.sessionReplay: Session Replay configuration.sessionTrace: Session Trace configuration.
class AgentApplicationSettingsBrowserBase(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"browser_config",
"browser_consent_mode",
"browser_monitoring",
"browser_performance",
"session_replay",
"session_trace",
)
browser_config = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsBrowserConfig"),
graphql_name="browserConfig",
)
browser_consent_mode = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsBrowserConsentMode"),
graphql_name="browserConsentMode",
)
browser_monitoring = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsBrowserMonitoring"),
graphql_name="browserMonitoring",
)
browser_performance = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsBrowserPerformance"),
graphql_name="browserPerformance",
)
session_replay = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsSessionReplay"),
graphql_name="sessionReplay",
)
session_trace = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsSessionTrace"),
graphql_name="sessionTrace",
)24. AgentApplicationSettingsBrowserConfig¶
General settings related to APM applications.
Available fields:
apdexTarget: The desired target for the APDEX measurement of this browser application.
class AgentApplicationSettingsBrowserConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("apdex_target",)
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")25. AgentApplicationSettingsBrowserConsentMode¶
Browser consent mode configuration for privacy compliance.
Available fields:
enabled: When enabled, the browser agent will operate in consent mode, respecting user privacy preferences and consent management platforms. When disabled (default), the agent operates normally without consent mode restrictions.
class AgentApplicationSettingsBrowserConsentMode(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")26. AgentApplicationSettingsBrowserDistributedTracing¶
Distributed tracing type. See documentation for further information.
Available fields:
allowedOrigins: List of allowed origins for use with distributed tracing.corsEnabled: Whether or not CORS is enabled in distributed tracing.corsUseNewrelicHeader: Whether or not CORS uses thenewrelicheader in distributed tracing.corsUseTracecontextHeaders: Whether or not CORS uses tracecontext headers in distributed tracing.enabled: Whether or not distributed tracing is enabled.excludeNewrelicHeader: Whether or not to exclude thenewrelicheader in distributed tracing.
class AgentApplicationSettingsBrowserDistributedTracing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"allowed_origins",
"cors_enabled",
"cors_use_newrelic_header",
"cors_use_tracecontext_headers",
"enabled",
"exclude_newrelic_header",
)
allowed_origins = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="allowedOrigins"
)
cors_enabled = sgqlc.types.Field(Boolean, graphql_name="corsEnabled")
cors_use_newrelic_header = sgqlc.types.Field(
Boolean, graphql_name="corsUseNewrelicHeader"
)
cors_use_tracecontext_headers = sgqlc.types.Field(
Boolean, graphql_name="corsUseTracecontextHeaders"
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
exclude_newrelic_header = sgqlc.types.Field(
Boolean, graphql_name="excludeNewrelicHeader"
)27. AgentApplicationSettingsBrowserMonitoring¶
Provides fields to set browser monitoring application settings.
Available fields:
ajax: Enables ajax traces in the browser app.distributedTracing: Distributed tracing type. See documentation for further information.loader: The type of browser agent that will be loaded.pinnedVersion: Specify the semantic version of the browser agent that you would like your app to use. Leave this blank to use the most recent version. Use ‘x’ in place of a numeric digit to represent the latest release within the version range. For example, ‘1.x.x’privacy: Browser privacy. See documentation for further information.
class AgentApplicationSettingsBrowserMonitoring(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"ajax",
"distributed_tracing",
"loader",
"pinned_version",
"privacy",
)
ajax = sgqlc.types.Field(AgentApplicationSettingsBrowserAjax, graphql_name="ajax")
distributed_tracing = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationSettingsBrowserDistributedTracing),
graphql_name="distributedTracing",
)
loader = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationSettingsBrowserLoader),
graphql_name="loader",
)
pinned_version = sgqlc.types.Field(String, graphql_name="pinnedVersion")
privacy = sgqlc.types.Field(
sgqlc.types.non_null("AgentApplicationSettingsBrowserPrivacy"),
graphql_name="privacy",
)28. AgentApplicationSettingsBrowserPerformance¶
Browser Performance configuration.
Available fields:
captureDetail: Capture detail enabled.captureMarks: Capture mark enabled.captureMeasures: Capture measures enabled.
class AgentApplicationSettingsBrowserPerformance(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("capture_detail", "capture_marks", "capture_measures")
capture_detail = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="captureDetail"
)
capture_marks = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="captureMarks"
)
capture_measures = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="captureMeasures"
)29. AgentApplicationSettingsBrowserPrivacy¶
Browser privacy. See documentation for further information.
Available fields:
cookiesEnabled: Whether or not cookies are enabled.
class AgentApplicationSettingsBrowserPrivacy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("cookies_enabled",)
cookies_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="cookiesEnabled"
)30. AgentApplicationSettingsBrowserProperties¶
General Properties related to browser applications.
Available fields:
jsConfig: The configuration required to run the npm version of the JS agent. This is the “pure” JSON configuration block without surrounding HTML tags.jsConfigScript: The configuration block required to run the npm version of the JS agent. This includes the HTML tags.jsLoaderScript: The snippet of JavaScript used to copy/paste into your JavaScript app if you aren’t using an auto-instrumentating agent on the backend.
class AgentApplicationSettingsBrowserProperties(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("js_config", "js_config_script", "js_loader_script")
js_config = sgqlc.types.Field(
AgentApplicationSettingsRawJsConfiguration, graphql_name="jsConfig"
)
js_config_script = sgqlc.types.Field(String, graphql_name="jsConfigScript")
js_loader_script = sgqlc.types.Field(String, graphql_name="jsLoaderScript")31. AgentApplicationSettingsErrorCollector¶
The error collector captures information about uncaught exceptions and sends them to New Relic for viewing. For more information about what these settings do and which ones are applicable for your application, please see https://
Available fields:
enabled: Enables error collector.expectedErrorClasses: Prevents specified exception classes from affecting error rate or Apdex score while still reporting the errors to APM.expectedErrorCodes: An array of individual HTTP status codes to be marked as expected and thus prevented from affecting error rate or Apdex score.ignoredErrorClasses: Specified exception class names will be ignored and will not affect error rate or Apdex score, or be reported to APM.ignoredErrorCodes: An array of individual HTTP status codes that should not be treated as errors.
class AgentApplicationSettingsErrorCollector(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"enabled",
"expected_error_classes",
"expected_error_codes",
"ignored_error_classes",
"ignored_error_codes",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
expected_error_classes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="expectedErrorClasses",
)
expected_error_codes = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(AgentApplicationSettingsErrorCollectorHttpStatus)
),
graphql_name="expectedErrorCodes",
)
ignored_error_classes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="ignoredErrorClasses",
)
ignored_error_codes = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(AgentApplicationSettingsErrorCollectorHttpStatus)
),
graphql_name="ignoredErrorCodes",
)32. AgentApplicationSettingsForwarding¶
Manages the configuration for automatic log forwarding for APM, including logs in context.
Available fields:
enabled: This controls the number of logs sent per minute.maxSamplesStored: This controls the number of logs sent per minute.
class AgentApplicationSettingsForwarding(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "max_samples_stored")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
max_samples_stored = sgqlc.types.Field(Int, graphql_name="maxSamplesStored")33. AgentApplicationSettingsIgnoredStatusCodeRule¶
A configuration setting used ignore status codes associated with different hosts.
Available fields:
hosts: An array of hosts to apply the status code rule to.statusCodes: An array of status codes to be be ignored on these hosts.
class AgentApplicationSettingsIgnoredStatusCodeRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("hosts", "status_codes")
hosts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="hosts"
)
status_codes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="statusCodes"
)34. AgentApplicationSettingsJfr¶
Access to the enabled state of the Java Flight Recorder. This feature only available on the Java language agent version 8.0.0 or later.
Available fields:
enabled: If true, the java agent collects Java Flight Recorder data. (Java Agent version 8.0.0 required.)
class AgentApplicationSettingsJfr(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")35. AgentApplicationSettingsLocalDecorating¶
Controls whether locally stored log lines are decorated or not. This is independent of whether log forwarding is enabled or not and is used to support customers that want to use a separate log forwarding solution.
Available fields:
enabled: Enables application logging local decorating.
class AgentApplicationSettingsLocalDecorating(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")36. AgentApplicationSettingsMaskInputOptions¶
Mask specific kinds of input options as *.
Available fields:
color: Mask ‘color’ input type.date: Mask ‘date’ input type.datetimeLocal: Mask ‘datetime_local’ input type.email: Mask ‘email’ input type.month: Mask ‘month’ input type.number: Mask ‘number’ input type.range: Mask ‘range’ input type.search: Mask ‘search’ input type.select: Mask ‘select’ input type.tel: Mask ‘tel’ input type.text: Mask ‘text’ input type.textArea: Mask ‘textarea’ input type.time: Mask ‘time’ input type.url: Mask ‘url’ input type.week: Mask ‘week’ input type.
class AgentApplicationSettingsMaskInputOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"color",
"date",
"datetime_local",
"email",
"month",
"number",
"range",
"search",
"select",
"tel",
"text",
"text_area",
"time",
"url",
"week",
)
color = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="color")
date = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="date")
datetime_local = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="datetimeLocal"
)
email = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="email")
month = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="month")
number = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="number")
range = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="range")
search = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="search")
select = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="select")
tel = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="tel")
text = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="text")
text_area = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="textArea"
)
time = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="time")
url = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="url")
week = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="week")37. AgentApplicationSettingsMetrics¶
Enables the capture of metrics information about your logs and log levels, which is displayed in a chart on the APM Summary page.
Available fields:
enabled: Enables application logging metrics.
class AgentApplicationSettingsMetrics(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")38. AgentApplicationSettingsMobileBase¶
Settings that are applicable to mobile applications
Available fields:
applicationExitInfo: Reports on application exits, which can be used to determine if an application is not responding.mobileSessionReplay: Mobile Session Replay configuration.networkSettings: Network settings associated with the mobile application.useCrashReports: Enables viewing in-depth reports for mobile application crashes.
class AgentApplicationSettingsMobileBase(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"application_exit_info",
"mobile_session_replay",
"network_settings",
"use_crash_reports",
)
application_exit_info = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationSettingsApplicationExitInfo),
graphql_name="applicationExitInfo",
)
mobile_session_replay = sgqlc.types.Field(
"AgentApplicationSettingsMobileSessionReplay",
graphql_name="mobileSessionReplay",
)
network_settings = sgqlc.types.Field(
"AgentApplicationSettingsMobileNetworkSettings", graphql_name="networkSettings"
)
use_crash_reports = sgqlc.types.Field(Boolean, graphql_name="useCrashReports")39. AgentApplicationSettingsMobileNetworkSettings¶
Network settings associated with the mobile application.
Available fields:
aliases: A list of configuration settings that map host to alias names for grouping and identification purposes.filterMode: Configuration setting to apply either the show or hide strategy for network filtering.hideList: A list of hostnames that would be applied to our filter settings when the filterMode is ‘HIDE.’ignoredStatusCodeRules: A list of rules to ignore status codes associated with different hosts.showList: A list of hostnames that would be applied to our filter settings when the filterMode is ‘SHOW.’
class AgentApplicationSettingsMobileNetworkSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"aliases",
"filter_mode",
"hide_list",
"ignored_status_code_rules",
"show_list",
)
aliases = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("AgentApplicationSettingsNetworkAlias")
),
graphql_name="aliases",
)
filter_mode = sgqlc.types.Field(
AgentApplicationSettingsNetworkFilterMode, graphql_name="filterMode"
)
hide_list = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="hideList"
)
ignored_status_code_rules = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(AgentApplicationSettingsIgnoredStatusCodeRule)
),
graphql_name="ignoredStatusCodeRules",
)
show_list = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="showList"
)40. AgentApplicationSettingsMobileProperties¶
General properties related to mobile applications.
Available fields:
applicationToken: A token used to authenticate your mobile application for data ingest.
class AgentApplicationSettingsMobileProperties(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("application_token",)
application_token = sgqlc.types.Field(SecureValue, graphql_name="applicationToken")41. AgentApplicationSettingsMobileSessionReplay¶
Mobile Session Replay configuration.
Available fields:
customMaskingRules: Rules to mask or unmask specific components or views. These rules override other masking settings.enabled: Mobile Session Replay enabled.errorSamplingRate: Percentage from 0-10 specifying how many of all user sessions that contain errors should be recorded.maskAllImages: Replace all images with placeholdermaskAllUserTouches: Ignore all user input from recordingmaskApplicationText: Mask all application text content as *maskUserInputText: Mask all input text content as *mode: Toggle between default masking settings and custom masking settings.samplingRate: Percentage from 0-10 specifying how many of all user sessions should be recorded.
class AgentApplicationSettingsMobileSessionReplay(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"custom_masking_rules",
"enabled",
"error_sampling_rate",
"mask_all_images",
"mask_all_user_touches",
"mask_application_text",
"mask_user_input_text",
"mode",
"sampling_rate",
)
custom_masking_rules = sgqlc.types.Field(
AgentApplicationSettingsCustomJsConfiguration, graphql_name="customMaskingRules"
)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
error_sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="errorSamplingRate"
)
mask_all_images = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="maskAllImages"
)
mask_all_user_touches = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="maskAllUserTouches"
)
mask_application_text = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="maskApplicationText"
)
mask_user_input_text = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="maskUserInputText"
)
mode = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationSettingsMobileSessionReplayMode),
graphql_name="mode",
)
sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="samplingRate"
)42. AgentApplicationSettingsNetworkAlias¶
A configuration setting that maps hosts to alias names for grouping and identification purposes.
Available fields:
alias: An alternative name that can be used to reference the hostnames.hosts: A list of hostnames to associate with an alias.
class AgentApplicationSettingsNetworkAlias(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("alias", "hosts")
alias = sgqlc.types.Field(String, graphql_name="alias")
hosts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="hosts"
)43. AgentApplicationSettingsSessionReplay¶
Session Replay configuration.
Available fields:
autoStart: When true, Session Replay will activate normally (this is the default). If set to false, Session Replay will not record automatically, but the agent will allow recording to be turned on via it’s API. Please see here for more details.blockSelector: String to configure which selector should be blockedcollectFonts: Indicates whether the agent will serialize fonts for collection without public asset url.enabled: Session Replay enabled.errorSamplingRate: Percentage from 0-10 specifying how many of all user sessions that contain errors should be recorded.fixStylesheets: Agent session replay asset fetching.inlineImages: Indicates whether the agent will serialize images for collection without public asset urlinlineStylesheet: Indicates whether the agent will serialize css for collection without public asset url.maskAllInputs: Mask all input content as *maskInputOptions: Mask specific kinds of input options as *.maskTextSelector: String to configure which selector should be masked.preload: This setting in Session Replay allows users to capture replays of the initial page load for enhanced analysis when using automatic start.samplingRate: Percentage from 0-10 specifying how many of all user sessions should be recorded.
class AgentApplicationSettingsSessionReplay(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"auto_start",
"block_selector",
"collect_fonts",
"enabled",
"error_sampling_rate",
"fix_stylesheets",
"inline_images",
"inline_stylesheet",
"mask_all_inputs",
"mask_input_options",
"mask_text_selector",
"preload",
"sampling_rate",
)
auto_start = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="autoStart"
)
block_selector = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="blockSelector"
)
collect_fonts = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="collectFonts"
)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
error_sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="errorSamplingRate"
)
fix_stylesheets = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="fixStylesheets"
)
inline_images = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="inlineImages"
)
inline_stylesheet = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="inlineStylesheet"
)
mask_all_inputs = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="maskAllInputs"
)
mask_input_options = sgqlc.types.Field(
sgqlc.types.non_null(AgentApplicationSettingsMaskInputOptions),
graphql_name="maskInputOptions",
)
mask_text_selector = sgqlc.types.Field(String, graphql_name="maskTextSelector")
preload = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="preload")
sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="samplingRate"
)44. AgentApplicationSettingsSessionTrace¶
Session Trace configuration.
Available fields:
enabled: Session Trace enabled.errorSamplingRate: Percentage from 0-100 specifying how many of all user sessions that contain errors should be recorded.mode: Default (fixed_rate) or custom (probabilistic) option used to collect session traces.samplingRate: Percentage from 0-100 specifying how many of all user sessions should be recorded.
class AgentApplicationSettingsSessionTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "error_sampling_rate", "mode", "sampling_rate")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
error_sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="errorSamplingRate"
)
mode = sgqlc.types.Field(
AgentApplicationSettingsSessionTraceMode, graphql_name="mode"
)
sampling_rate = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="samplingRate"
)45. AgentApplicationSettingsSlowSql¶
In APM, when transaction traces are collected, there may be additional Slow query data available.
Available fields:
enabled: If true, the agent collects slow SQL queries.
class AgentApplicationSettingsSlowSql(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")46. AgentApplicationSettingsThreadProfiler¶
Measures wall clock time, CPU time, and method call counts in your application’s threads as they run.
Available fields:
enabled: Whether or not the Thread Profiler is enabled for your application.
class AgentApplicationSettingsThreadProfiler(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled",)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")47. AgentApplicationSettingsTransactionTracer¶
Transaction tracer settings related to APM applications. For more information about what these settings do and which ones are applicable for your application, please see https://
Available fields:
captureMemcacheKeys: DEPRECATED: Please use capture_memcache_keys on parent type.enabled: If true, this enables the transaction tracer feature, enabling collection of transaction traces.explainEnabled: If true, enables the collection of explain plans in transaction traces. This setting will also apply to explain plans in slow SQL traces if slow_sql.explain_enabled is not set separately.explainThresholdType: Relevant only when explain_enabled is true. Can be set to automatic configuration (APDEX_F) or manual (see explainThresholdValue).explainThresholdValue: Threshold (in seconds) above which the agent will collect explain plans. Relevant only when explainEnabled is true and explainThresholdType is set to VALUE.logSql: Set to true to enable logging of queries to the agent log file instead of uploading to New Relic. Queries are logged using the record_sql mode.recordSql: Obfuscation level for SQL queries reported in transaction trace nodes.stackTraceThreshold: Specify a threshold in seconds. The agent includes stack traces in transaction trace nodes when the stack trace duration exceeds this threshold.transactionThresholdType: Relevant only when TransactionTracer is enabled. Can be set to automatic configuration (APDEX_F) or manual (see TransactionThresholdValue).transactionThresholdValue: Threshold (in seconds) that transactions with a duration longer than this threshold are eligible for transaction traces. Relevant only when transaction tracer is enabled and transaction_threshold_type is set to VALUE.
class AgentApplicationSettingsTransactionTracer(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"capture_memcache_keys",
"enabled",
"explain_enabled",
"explain_threshold_type",
"explain_threshold_value",
"log_sql",
"record_sql",
"stack_trace_threshold",
"transaction_threshold_type",
"transaction_threshold_value",
)
capture_memcache_keys = sgqlc.types.Field(
Boolean, graphql_name="captureMemcacheKeys"
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
explain_enabled = sgqlc.types.Field(Boolean, graphql_name="explainEnabled")
explain_threshold_type = sgqlc.types.Field(
AgentApplicationSettingsThresholdTypeEnum, graphql_name="explainThresholdType"
)
explain_threshold_value = sgqlc.types.Field(
Seconds, graphql_name="explainThresholdValue"
)
log_sql = sgqlc.types.Field(Boolean, graphql_name="logSql")
record_sql = sgqlc.types.Field(
AgentApplicationSettingsRecordSqlEnum, graphql_name="recordSql"
)
stack_trace_threshold = sgqlc.types.Field(
Seconds, graphql_name="stackTraceThreshold"
)
transaction_threshold_type = sgqlc.types.Field(
AgentApplicationSettingsThresholdTypeEnum,
graphql_name="transactionThresholdType",
)
transaction_threshold_value = sgqlc.types.Field(
Seconds, graphql_name="transactionThresholdValue"
)48. AgentApplicationSettingsUpdateError¶
Information about any errors encountered while updating values.
Available fields:
description: A ‘human readable’ description of the error.errorClass: The category of the error.field: The field that was being updated when the error was encountered.
class AgentApplicationSettingsUpdateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_class", "field")
description = sgqlc.types.Field(String, graphql_name="description")
error_class = sgqlc.types.Field(
AgentApplicationSettingsUpdateErrorClass, graphql_name="errorClass"
)
field = sgqlc.types.Field(String, graphql_name="field")49. AgentApplicationSettingsUpdateResult¶
The result of updating application settings.
Available fields:
alias: The name for the application.apmSettings: Access general settings for the application.applicationLogging: Access log forwarding settings for the application.browserProperties: Access general properties for the application.browserSettings: Access general settings for the browser application.errors: Information about any errors encountered while updating values.guid: The GUID for the affected Entity.mobileSettings: Access mobile settings for the application.
class AgentApplicationSettingsUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"alias",
"apm_settings",
"application_logging",
"browser_properties",
"browser_settings",
"errors",
"guid",
"mobile_settings",
)
alias = sgqlc.types.Field(String, graphql_name="alias")
apm_settings = sgqlc.types.Field(
AgentApplicationSettingsApmBase, graphql_name="apmSettings"
)
application_logging = sgqlc.types.Field(
AgentApplicationSettingsApplicationLogging, graphql_name="applicationLogging"
)
browser_properties = sgqlc.types.Field(
AgentApplicationSettingsBrowserProperties, graphql_name="browserProperties"
)
browser_settings = sgqlc.types.Field(
AgentApplicationSettingsBrowserBase, graphql_name="browserSettings"
)
errors = sgqlc.types.Field(
sgqlc.types.list_of(AgentApplicationSettingsUpdateError), graphql_name="errors"
)
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
mobile_settings = sgqlc.types.Field(
AgentApplicationSettingsMobileBase, graphql_name="mobileSettings"
)50. AgentEnvironmentAccountApplicationLoadedModules¶
Data found for one application instance’s loaded modules.
Available fields:
applicationGuids: List of Guids of the APM Applications this instance belongs to.details: Information of the application instance, such as host and language.loadedModules: A list of loaded modules of the application instance.
class AgentEnvironmentAccountApplicationLoadedModules(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("application_guids", "details", "loaded_modules")
application_guids = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))),
graphql_name="applicationGuids",
)
details = sgqlc.types.Field(
"AgentEnvironmentApplicationInstanceDetails", graphql_name="details"
)
loaded_modules = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("AgentEnvironmentApplicationLoadedModule")
),
graphql_name="loadedModules",
)51. AgentEnvironmentAccountApplicationLoadedModulesResults¶
Results for loaded modules search. This list is paginated. Use the cursor to go through all the available results.
Available fields:
nextCursor: If nextCursor is a String value, set it to the cursor input field while searching in order to get the next page of results.results: Results of the search.
class AgentEnvironmentAccountApplicationLoadedModulesResults(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(AgentEnvironmentAccountApplicationLoadedModules)
),
graphql_name="results",
)52. AgentEnvironmentAccountEnvironmentAttributesResults¶
Results for environment attributes search. This list is paginated. Use the cursor to go through all the available results.
Available fields:
nextCursor: If nextCursor is a String value, set it to the cursor input field while searching in order to get the next page of results.results: Results of the search.
class AgentEnvironmentAccountEnvironmentAttributesResults(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("AgentEnvironmentApplicationEnvironmentAttributes")
),
graphql_name="results",
)53. AgentEnvironmentAccountStitchedFields¶
account-scope schemas
Available fields:
agentSettingsAttributes: Contains environment attributes regarding the reported setting of the reporting agent at account level.environmentAttributes: Contains general environment attributes from the same environment where the application instance is running.modules: Contains environment attributes regarding modules loaded by the application instance. Used only by the Java agent.
class AgentEnvironmentAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("agent_settings_attributes", "environment_attributes", "modules")
agent_settings_attributes = sgqlc.types.Field(
AgentEnvironmentAccountEnvironmentAttributesResults,
graphql_name="agentSettingsAttributes",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for fetching more results. Populate
using result's nextCursor field.
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on attribute name.
"""
environment_attributes = sgqlc.types.Field(
AgentEnvironmentAccountEnvironmentAttributesResults,
graphql_name="environmentAttributes",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for fetching more results. Populate
using result's nextCursor field.
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on attribute name.
"""
modules = sgqlc.types.Field(
AgentEnvironmentAccountApplicationLoadedModulesResults,
graphql_name="modules",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for fetching more results. Populate
using result's nextCursor field.
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on module name field.
"""54. AgentEnvironmentApplicationEnvironmentAttributes¶
Environment data found for one application instance.
Available fields:
applicationGuids: List of Guids of the APM Applications this instance belongs to.attributes: A list of environment attributes of the application instance.details: Information of the application instance, such as host and language.
class AgentEnvironmentApplicationEnvironmentAttributes(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("application_guids", "attributes", "details")
application_guids = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))),
graphql_name="applicationGuids",
)
attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AgentEnvironmentAttribute")),
graphql_name="attributes",
)
details = sgqlc.types.Field(
"AgentEnvironmentApplicationInstanceDetails", graphql_name="details"
)55. AgentEnvironmentApplicationInstance¶
Representation of the New Relic agent collecting data.
Available fields:
agentSettingsAttributes: Contains environment attributes regarding the reported setting of the reporting agent.details: Information of the application instance, such as host and language.environmentAttributes: Contains general environment attributes from the same environment where the application instance is running.modules: Contains environment attributes regarding modules loaded by the application instance. Used only by the Java agent.
class AgentEnvironmentApplicationInstance(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"agent_settings_attributes",
"details",
"environment_attributes",
"modules",
)
agent_settings_attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AgentEnvironmentAttribute")),
graphql_name="agentSettingsAttributes",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on attribute name.
"""
details = sgqlc.types.Field(
sgqlc.types.non_null("AgentEnvironmentApplicationInstanceDetails"),
graphql_name="details",
)
environment_attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AgentEnvironmentAttribute")),
graphql_name="environmentAttributes",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on attribute name.
"""
modules = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("AgentEnvironmentApplicationLoadedModule")
),
graphql_name="modules",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
AgentEnvironmentFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `filter` (`AgentEnvironmentFilter`): Filter to apply to results
on module name field.
"""56. AgentEnvironmentApplicationInstanceDetails¶
Details of an application instance such as host and language.
Available fields:
host: Host of the application instance.hostDisplayName: Host display name of the application instance.id: ID of the application instance.instanceName: Instance name generated by language, host and namelanguage: Language of the application instance.name: Name of the application instance.
class AgentEnvironmentApplicationInstanceDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"host",
"host_display_name",
"id",
"instance_name",
"language",
"name",
)
host = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="host")
host_display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="hostDisplayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
instance_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="instanceName"
)
language = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="language")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")57. AgentEnvironmentApplicationInstancesResult¶
List of APM application instances with pagination data.
Available fields:
applicationInstances: List of APM application instances .nextCursor: If nextCursor is a String value, set it to the cursor input field while searching in order to get the next page of results.
class AgentEnvironmentApplicationInstancesResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("application_instances", "next_cursor")
application_instances = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AgentEnvironmentApplicationInstance)),
graphql_name="applicationInstances",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")58. AgentEnvironmentApplicationLoadedModule¶
Represents a module loaded by the apm application.
Available fields:
attributes: Extra module attributes.name: Module name.version: Module version.
class AgentEnvironmentApplicationLoadedModule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "name", "version")
attributes = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of("AgentEnvironmentLoadedModuleAttribute")
),
graphql_name="attributes",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
version = sgqlc.types.Field(String, graphql_name="version")59. AgentEnvironmentAttribute¶
Represents one attribute from within the environment on which an agent is running.
Available fields:
attribute: Environment attribute name.value: Value of the environment attribute.
class AgentEnvironmentAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute", "value")
attribute = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attribute"
)
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")60. AgentEnvironmentLoadedModuleAttribute¶
Attribute belonging to a loaded module.
Available fields:
name: Name of the module attribute.value: Value of the module attribute.
class AgentEnvironmentLoadedModuleAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")61. AgentFeatures¶
Features of the Agent
Available fields:
minVersion: The minimum version available for the Agent on this entityname: The name of the feature
class AgentFeatures(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("min_version", "name")
min_version = sgqlc.types.Field(String, graphql_name="minVersion")
name = sgqlc.types.Field(String, graphql_name="name")62. AgentReleasesAgentRelease¶
Information about an Agent release
Available fields:
bugs: Patch for a bugdate: The date of the releasedownloadLink: Link to agent distributioneolDate: The date the release will reach the end of its life. See New Relic’s EOL Policy for detailsfeatures: New feature or instrumentationsecurity: Fix for a security vulnerabilityslug: The release note’s location on the docs website. The full URL would be prefixed with https://docs .newrelic .com supportedOperatingSystems: List of supported operating systems for the agent release.version: The version of the release
class AgentReleasesAgentRelease(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"bugs",
"date",
"download_link",
"eol_date",
"features",
"security",
"slug",
"supported_operating_systems",
"version",
)
bugs = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="bugs")
date = sgqlc.types.Field(Date, graphql_name="date")
download_link = sgqlc.types.Field(String, graphql_name="downloadLink")
eol_date = sgqlc.types.Field(Date, graphql_name="eolDate")
features = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="features")
security = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="security")
slug = sgqlc.types.Field(String, graphql_name="slug")
supported_operating_systems = sgqlc.types.Field(
sgqlc.types.list_of("AgentReleasesOperatingSystem"),
graphql_name="supportedOperatingSystems",
)
version = sgqlc.types.Field(String, graphql_name="version")63. AgentReleasesOperatingSystem¶
Operating System details including the name and supported versions.
Available fields:
osName: Name of the operating system.osVersions: List of versions available for the operating system.
class AgentReleasesOperatingSystem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("os_name", "os_versions")
os_name = sgqlc.types.Field(String, graphql_name="osName")
os_versions = sgqlc.types.Field(
sgqlc.types.list_of("AgentReleasesOsVersion"), graphql_name="osVersions"
)64. AgentReleasesOsVersion¶
Version details for a specific operating system, including architecture compatibility.
Available fields:
architectures: List of supported architectures for the version.versionName: Name of the version.
class AgentReleasesOsVersion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("architectures", "version_name")
architectures = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="architectures"
)
version_name = sgqlc.types.Field(String, graphql_name="versionName")65. AiDecisionsAccountStitchedFields¶
Available fields:
decision: Fetch a decision by ID.decisions: Returns a paginated list of decisions.
class AiDecisionsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("decision", "decisions")
decision = sgqlc.types.Field(
"AiDecisionsDecision",
graphql_name="decision",
args=sgqlc.types.ArgDict(
(
(
"decision_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="decisionId",
default=None,
),
),
)
),
)
"""Arguments:
* `decision_id` (`ID!`): Decision ID.
"""
decisions = sgqlc.types.Field(
sgqlc.types.non_null("AiDecisionsDecisionListing"),
graphql_name="decisions",
args=sgqlc.types.ArgDict(
(
("after", sgqlc.types.Arg(String, graphql_name="after", default=None)),
(
"before",
sgqlc.types.Arg(String, graphql_name="before", default=None),
),
(
"decision_states",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiDecisionsDecisionState)
),
graphql_name="decisionStates",
default=None,
),
),
(
"decision_types",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiDecisionsDecisionType)
),
graphql_name="decisionTypes",
default=None,
),
),
(
"page_size",
sgqlc.types.Arg(Int, graphql_name="pageSize", default=None),
),
(
"sort_method",
sgqlc.types.Arg(
AiDecisionsDecisionSortMethod,
graphql_name="sortMethod",
default=None,
),
),
)
),
)
"""Arguments:
* `after` (`String`): Cursor to paginate forwards.
* `before` (`String`): Cursor to paginate backwards.
* `decision_states` (`[AiDecisionsDecisionState!]`): List of
decision states.
* `decision_types` (`[AiDecisionsDecisionType!]`): List of
decision types.
* `page_size` (`Int`): Number of elements in page.
* `sort_method` (`AiDecisionsDecisionSortMethod`): Sorting method.
"""66. AiDecisionsAnnotationEntry¶
A key-value entry.
Available fields:
key: Key of entry.value: Value of entry.
class AiDecisionsAnnotationEntry(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")67. AiDecisionsApplicableIncidentSearch¶
A search for a subset of incidents that may be relevant for a given rule expression
Available fields:
completedAt: Time search operation completedcreatedAt: Time search operation was createderrorMessage: Error message if search operation failedid: ID of search operationincidentsScanned: Number of incidents scanned by the search operationresults: Listing of incident selectors and potential applicable incidentsupdatedAt: Time search operation was last updated
class AiDecisionsApplicableIncidentSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"completed_at",
"created_at",
"error_message",
"id",
"incidents_scanned",
"results",
"updated_at",
)
completed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="completedAt")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
error_message = sgqlc.types.Field(String, graphql_name="errorMessage")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
incidents_scanned = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="incidentsScanned"
)
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiDecisionsSelectorExamples"))
),
graphql_name="results",
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)68. AiDecisionsDecision¶
A decision used to compare incidents and subsequently merge issues.
Available fields:
annotations: Internal data associated with this decision.correlationWindowLength: Length of the window in which incidents are compared.createdAt: Time decision was created.creator: Creator of decision.decisionExpression: Expression to use to compare incidents.decisionType: Type of decision.description: Description of decision.id: ID of decision.metadata: External data associated with this decision.minCorrelationThreshold: Number of correlations within a window required to merge issues.name: Name of decision.overrideConfiguration: Configuration to allow decision to override issue properties.source: Creation source of decision.state: Current state of decision.updatedAt: Time decision was last updated.
class AiDecisionsDecision(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"annotations",
"correlation_window_length",
"created_at",
"creator",
"decision_expression",
"decision_type",
"description",
"id",
"metadata",
"min_correlation_threshold",
"name",
"override_configuration",
"source",
"state",
"updated_at",
)
annotations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiDecisionsAnnotationEntry))
),
graphql_name="annotations",
)
correlation_window_length = sgqlc.types.Field(
Milliseconds, graphql_name="correlationWindowLength"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator = sgqlc.types.Field("UserReference", graphql_name="creator")
decision_expression = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleExpression),
graphql_name="decisionExpression",
)
decision_type = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsDecisionType), graphql_name="decisionType"
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("AiDecisionsRuleMetadata"), graphql_name="metadata"
)
min_correlation_threshold = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="minCorrelationThreshold"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
override_configuration = sgqlc.types.Field(
"AiDecisionsOverrideConfiguration", graphql_name="overrideConfiguration"
)
source = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleSource), graphql_name="source"
)
state = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsDecisionState), graphql_name="state"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)69. AiDecisionsDecisionListing¶
Windowed view of an account’s decisions.
Available fields:
count: Number of decisions in this window.decisions: List of decisions in this window.nextCursor: Cursor used to fetch next page.prevCursor: Cursor used to fetch previous page.
class AiDecisionsDecisionListing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "decisions", "next_cursor", "prev_cursor")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
decisions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiDecisionsDecision))
),
graphql_name="decisions",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")70. AiDecisionsMergeFeedback¶
Represents a piece of user feedback for a merge.
Available fields:
childIssueId: ID of child issue.opinion: Opinion of the current user on this merge.parentIssueId: ID of parent issue.ruleId: ID of correlation rule.userId: ID of user.
class AiDecisionsMergeFeedback(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"child_issue_id",
"opinion",
"parent_issue_id",
"rule_id",
"user_id",
)
child_issue_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="childIssueId"
)
opinion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOpinion), graphql_name="opinion"
)
parent_issue_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="parentIssueId"
)
rule_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="ruleId")
user_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="userId")71. AiDecisionsOperationResult¶
Result of an operation.
Available fields:
result: Status of the operation.
class AiDecisionsOperationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("result",)
result = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsResultType), graphql_name="result"
)72. AiDecisionsOpinionEntry¶
Represents a number of opinions.
Available fields:
count: Number of this type of opinion.opinion: Type of opinion.
class AiDecisionsOpinionEntry(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "opinion")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
opinion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOpinion), graphql_name="opinion"
)73. AiDecisionsOverrideConfiguration¶
Configuration for overriding properties of issues created by merges.
Available fields:
description: Description merged issues should take.priority: Priority merged issues should take.title: Title merged issues should take.
class AiDecisionsOverrideConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "priority", "title")
description = sgqlc.types.Field(String, graphql_name="description")
priority = sgqlc.types.Field(AiDecisionsIssuePriority, graphql_name="priority")
title = sgqlc.types.Field(String, graphql_name="title")74. AiDecisionsRule¶
A correlation rule used to compare incidents and subsequently merge issues.
Available fields:
annotations: Internal data associated with this rule.correlationWindowLength: Length of the window in which incidents are compared.createdAt: Time rule was created.creator: Creator of rule.description: Description of rule.id: ID of rule.metadata: External data associated with this rule.minCorrelationThreshold: Number of correlations within a window required to merge issues.name: Name of rule.overrideConfiguration: Configuration to allow rule to override issue properties.ruleExpression: Expression to use to compare incidents.ruleType: Type of rule.source: Creation source of rule.state: Current state of rule.updatedAt: Time rule was last updated.
class AiDecisionsRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"annotations",
"correlation_window_length",
"created_at",
"creator",
"description",
"id",
"metadata",
"min_correlation_threshold",
"name",
"override_configuration",
"rule_expression",
"rule_type",
"source",
"state",
"updated_at",
)
annotations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiDecisionsAnnotationEntry))
),
graphql_name="annotations",
)
correlation_window_length = sgqlc.types.Field(
Milliseconds, graphql_name="correlationWindowLength"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator = sgqlc.types.Field("UserReference", graphql_name="creator")
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("AiDecisionsRuleMetadata"), graphql_name="metadata"
)
min_correlation_threshold = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="minCorrelationThreshold"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
override_configuration = sgqlc.types.Field(
AiDecisionsOverrideConfiguration, graphql_name="overrideConfiguration"
)
rule_expression = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleExpression), graphql_name="ruleExpression"
)
rule_type = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleType), graphql_name="ruleType"
)
source = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleSource), graphql_name="source"
)
state = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleState), graphql_name="state"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)75. AiDecisionsRuleMetadata¶
Metadata about a decision.
Available fields:
mergeOpinionCount: Summary of user opinions for merges by this decision
class AiDecisionsRuleMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("merge_opinion_count",)
merge_opinion_count = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiDecisionsOpinionEntry))
),
graphql_name="mergeOpinionCount",
)76. AiDecisionsSelectorApplicability¶
Number of incidents applicable for a selector
Available fields:
count: Applicable number of incidentsselect: Incident selector
class AiDecisionsSelectorApplicability(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "select")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
select = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsIncidentSelect), graphql_name="select"
)77. AiDecisionsSelectorExamples¶
Example subset of incidents applicable for a selector
Available fields:
incidents: IDs of incidents that can be applied to this selectorselect: Incident selector
class AiDecisionsSelectorExamples(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("incidents", "select")
incidents = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(ID))),
graphql_name="incidents",
)
select = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsIncidentSelect), graphql_name="select"
)78. AiDecisionsSimulation¶
Simulation of a rule expression for a certain period of time.
Available fields:
candidateIncidents: Example potential incident correlations.completedAt: Time simulation completed.createdAt: Time simulation was created.errorMessage: Error message if simulation failed.id: ID of simulation.incidentsApplicable: Applicability of ingested incidents to the expression.incidentsCorrelated: Number of incidents correlated by simulation.incidentsIngested: Number of incidents ingested by simulation.incidentsProcessed: Number of applicable incidents processed by simulation.progress: Percentage of current progress of simulation.updatedAt: Time simulation was last updated.
class AiDecisionsSimulation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"candidate_incidents",
"completed_at",
"created_at",
"error_message",
"id",
"incidents_applicable",
"incidents_correlated",
"incidents_ingested",
"incidents_processed",
"progress",
"updated_at",
)
candidate_incidents = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(ID)))
)
),
graphql_name="candidateIncidents",
)
completed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="completedAt")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
error_message = sgqlc.types.Field(String, graphql_name="errorMessage")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
incidents_applicable = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiDecisionsSelectorApplicability))
),
graphql_name="incidentsApplicable",
)
incidents_correlated = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="incidentsCorrelated"
)
incidents_ingested = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="incidentsIngested"
)
incidents_processed = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="incidentsProcessed"
)
progress = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="progress")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)79. AiDecisionsSuggestion¶
A suggested correlation rule.
Available fields:
correlationWindowLength: Length of the window in which incidents are compared.createdAt: Time suggestion was created.description: Description of suggestion.hash: External hash of suggestion.id: ID of suggestion.minCorrelationThreshold: Number of correlations within a window required to merge issues.name: Name of suggestion.overrideConfiguration: Configuration to allow rule to override issue properties.ruleExpression: Expression to use to compare incidents.state: Acceptance state of suggestion.suggester: Service/user that created this suggestion.support: External support for suggestion.
class AiDecisionsSuggestion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"correlation_window_length",
"created_at",
"description",
"hash",
"id",
"min_correlation_threshold",
"name",
"override_configuration",
"rule_expression",
"state",
"suggester",
"support",
)
correlation_window_length = sgqlc.types.Field(
Milliseconds, graphql_name="correlationWindowLength"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
description = sgqlc.types.Field(String, graphql_name="description")
hash = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="hash")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
min_correlation_threshold = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="minCorrelationThreshold"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
override_configuration = sgqlc.types.Field(
AiDecisionsOverrideConfiguration, graphql_name="overrideConfiguration"
)
rule_expression = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRuleExpression), graphql_name="ruleExpression"
)
state = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsSuggestionState), graphql_name="state"
)
suggester = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="suggester"
)
support = sgqlc.types.Field(String, graphql_name="support")80. AiIssuesAccountStitchedFields¶
Available fields:
configByEnvironment: Fetch config for envincidents: Fetch incidents latest data by supplied filterincidentsEvents: Fetch incidents events data by supplied filterissues: Fetch issues latest data by supplied filterissuesEvents: Fetch issues events data by supplied filter
class AiIssuesAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"config_by_environment",
"incidents",
"incidents_events",
"issues",
"issues_events",
)
config_by_environment = sgqlc.types.Field(
"AiIssuesConfigurationByEnvironment", graphql_name="configByEnvironment"
)
incidents = sgqlc.types.Field(
"AiIssuesIncidentData",
graphql_name="incidents",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AiIssuesFilterIncidents, graphql_name="filter", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor
* `filter` (`AiIssuesFilterIncidents`): filter incidents
* `time_window` (`TimeWindowInput`): time window, if not provided
the default is the last 24 hours
"""
incidents_events = sgqlc.types.Field(
"AiIssuesIncidentData",
graphql_name="incidentsEvents",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AiIssuesFilterIncidentsEvents,
graphql_name="filter",
default=None,
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor
* `filter` (`AiIssuesFilterIncidentsEvents`): filter incidents
events
* `time_window` (`TimeWindowInput`): time window, if not provided
the default is the last 24 hours
"""
issues = sgqlc.types.Field(
"AiIssuesIssueData",
graphql_name="issues",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AiIssuesFilterIssues, graphql_name="filter", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor
* `filter` (`AiIssuesFilterIssues`): filter issues
* `time_window` (`TimeWindowInput`): time window, if not provided
the default is the last 24 hours
"""
issues_events = sgqlc.types.Field(
"AiIssuesIssueData",
graphql_name="issuesEvents",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AiIssuesFilterIssuesEvents, graphql_name="filter", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor
* `filter` (`AiIssuesFilterIssuesEvents`): filter issues events
* `time_window` (`TimeWindowInput`): time window, if not provided
the default is the last 24 hours
"""81. AiIssuesConfigurationByEnvironment¶
Configuration per environment
Available fields:
config: Configuration
class AiIssuesConfigurationByEnvironment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
"AiIssuesEnvironmentConfiguration", graphql_name="config"
)82. AiIssuesConfigurationOverrideResponse¶
Response for configuration override
Available fields:
config: Updated configurationerror: Error, if any
class AiIssuesConfigurationOverrideResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("config", "error")
config = sgqlc.types.Field(
"AiIssuesEnvironmentConfiguration", graphql_name="config"
)
error = sgqlc.types.Field(String, graphql_name="error")83. AiIssuesEnvironmentConfiguration¶
Environment configuration object
Available fields:
flappingInterval: Flapping interval in secondsgracePeriod: Grace periods per priorityinactivePeriod: Inactive period in secondsincidentTimeout: Incident timeout in secondsissueTtl: Issue TTL in secondsmaxIssueSize: Max incidents in the issue
class AiIssuesEnvironmentConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"flapping_interval",
"grace_period",
"inactive_period",
"incident_timeout",
"issue_ttl",
"max_issue_size",
)
flapping_interval = sgqlc.types.Field(Seconds, graphql_name="flappingInterval")
grace_period = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AiIssuesGracePeriodConfig")),
graphql_name="gracePeriod",
)
inactive_period = sgqlc.types.Field(Seconds, graphql_name="inactivePeriod")
incident_timeout = sgqlc.types.Field(Seconds, graphql_name="incidentTimeout")
issue_ttl = sgqlc.types.Field(Seconds, graphql_name="issueTtl")
max_issue_size = sgqlc.types.Field(Int, graphql_name="maxIssueSize")84. AiIssuesGracePeriodConfig¶
Grace period config per priority
Available fields:
period: Grace period for notification in seconds per prioritypriority: Priority for which grace period is defined (MEDIUM/LOW/HIGH/CRITICAL)
class AiIssuesGracePeriodConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("period", "priority")
period = sgqlc.types.Field(sgqlc.types.non_null(Seconds), graphql_name="period")
priority = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesPriority), graphql_name="priority"
)85. AiIssuesIncidentData¶
Incidents data
Available fields:
incidents: IncidentsnextCursor: Cursor to get the next batch of results
class AiIssuesIncidentData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("incidents", "next_cursor")
incidents = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiIssuesIIncident))
),
graphql_name="incidents",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")86. AiIssuesIncidentUserActionResponse¶
User action for issue
Available fields:
accountId: account iderror: Error, if anyincidentId: Incident id
class AiIssuesIncidentUserActionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "error", "incident_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
error = sgqlc.types.Field(String, graphql_name="error")
incident_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="incidentId")87. AiIssuesIssue¶
Issue
Available fields:
account: accountaccountIds: A list of account Ids. As an issue could be correlated with others from other accounts.acknowledgedAt: The time the issue was acknowledgedacknowledgedBy: The user that acknowledged the issueactivatedAt: The time the issue was activatedclosedAt: The time the issue was closedclosedBy: The user that manually closed the issueconditionFamilyId: A list of condition ids associated with this issueconditionName: A list of condition text descriptions associated with this issueconditionProduct: A list of New Relic products connected to the conditions associated with this issuecorrelationRuleDescriptions: A list of correlation rule descriptions applied to correlate this issue to other issuescorrelationRuleIds: A list of correlation rule ids applied to correlate this issue to other issuescorrelationRuleNames: A list of correlation rule names applied to correlate this issue to other issuescreatedAt: The time the issue was createddataMlModules: A list of ML data associated with this issuedeepLinkUrl: A list of urls into New Relic product page, scoped to this issuedescription: A list of incident descriptionsentityGuids: A list of unique entity identifiersentityNames: A list of entity namesentityTypes: A list of entity typeseventType: An issue event that could be INCIDENT_ADDED, USER_ACTION, INCIDENT_CLOSED,...incidentIds: A list of incident IDs in this issue. Notice, in some cases there may be thousands of incidents in an issueinvestigatedAt: The time the issue was marked as investigatinginvestigatedBy: The user that marked the issue as investigatingisCorrelated: True means that other issues were correlated to this oneisIdle: See our documentation to learn about idle issuesissueId: Issue identifiermergeReason: The reason this issue was mergedmutingState: The issue muting state (supress notifications)origins: A list of origins of the incidents (violations, anomalies, external)parentMergeId: The merge id if this issue is part of the merge or null otherwisepolicyIds: A list of policy ids associated with this issuepolicyName: A list of policy names associated with this issuepriority: The issue prioritysources: A list of sources of the incidents (newrelic or external)state: The issue statetitle: A list of underlying incident titlestotalIncidents: The count of underlying incidentsunAcknowledgedAt: The time the issue was unacknowledgedunAcknowledgedBy: The user that unacknowledged the issueupdatedAt: The time the issue was last updatedwildcard: A list of wildcard expressions used for wildcard metrics associated with this issue
class AiIssuesIssue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"account_ids",
"acknowledged_at",
"acknowledged_by",
"activated_at",
"closed_at",
"closed_by",
"condition_family_id",
"condition_name",
"condition_product",
"correlation_rule_descriptions",
"correlation_rule_ids",
"correlation_rule_names",
"created_at",
"data_ml_modules",
"deep_link_url",
"description",
"entity_guids",
"entity_names",
"entity_types",
"event_type",
"incident_ids",
"investigated_at",
"investigated_by",
"is_correlated",
"is_idle",
"issue_id",
"merge_reason",
"muting_state",
"origins",
"parent_merge_id",
"policy_ids",
"policy_name",
"priority",
"sources",
"state",
"title",
"total_incidents",
"un_acknowledged_at",
"un_acknowledged_by",
"updated_at",
"wildcard",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
account_ids = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(Int))),
graphql_name="accountIds",
)
acknowledged_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="acknowledgedAt"
)
acknowledged_by = sgqlc.types.Field(String, graphql_name="acknowledgedBy")
activated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="activatedAt")
closed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="closedAt")
closed_by = sgqlc.types.Field(String, graphql_name="closedBy")
condition_family_id = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="conditionFamilyId"
)
condition_name = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="conditionName"
)
condition_product = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="conditionProduct",
)
correlation_rule_descriptions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="correlationRuleDescriptions",
)
correlation_rule_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)),
graphql_name="correlationRuleIds",
)
correlation_rule_names = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="correlationRuleNames",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
data_ml_modules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AiIssuesKeyValues")),
graphql_name="dataMlModules",
)
deep_link_url = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="deepLinkUrl"
)
description = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="description",
)
entity_guids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid)),
graphql_name="entityGuids",
)
entity_names = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="entityNames"
)
entity_types = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="entityTypes"
)
event_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="eventType"
)
incident_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="incidentIds"
)
investigated_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="investigatedAt"
)
investigated_by = sgqlc.types.Field(String, graphql_name="investigatedBy")
is_correlated = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isCorrelated"
)
is_idle = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="isIdle")
issue_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="issueId")
merge_reason = sgqlc.types.Field(String, graphql_name="mergeReason")
muting_state = sgqlc.types.Field(
AiIssuesIssueMutingState, graphql_name="mutingState"
)
origins = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="origins",
)
parent_merge_id = sgqlc.types.Field(String, graphql_name="parentMergeId")
policy_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="policyIds"
)
policy_name = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="policyName"
)
priority = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesPriority), graphql_name="priority"
)
sources = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="sources",
)
state = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIssueState), graphql_name="state"
)
title = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="title",
)
total_incidents = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalIncidents"
)
un_acknowledged_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="unAcknowledgedAt"
)
un_acknowledged_by = sgqlc.types.Field(String, graphql_name="unAcknowledgedBy")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)
wildcard = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="wildcard"
)88. AiIssuesIssueData¶
Issues data
Available fields:
issues: IssuesnextCursor: Cursor to get the next batch of results
class AiIssuesIssueData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("issues", "next_cursor")
issues = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(AiIssuesIssue))),
graphql_name="issues",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")89. AiIssuesIssueUserActionResponse¶
Response for user action
Available fields:
error: Error, if anyresult: User operation performed with an issue
class AiIssuesIssueUserActionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "result")
error = sgqlc.types.Field(String, graphql_name="error")
result = sgqlc.types.Field("AiIssuesIssueUserActionResult", graphql_name="result")90. AiIssuesIssueUserActionResult¶
User action for issue
Available fields:
accountId: Account idaction: User actionissueId: Issue id
class AiIssuesIssueUserActionResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "action", "issue_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
action = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIssueUserAction), graphql_name="action"
)
issue_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="issueId")91. AiIssuesKeyValue¶
Key value type
Available fields:
key: keyvalue: value
class AiIssuesKeyValue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")92. AiIssuesKeyValues¶
Key to values type
Available fields:
key: keyvalue: A list of values
class AiIssuesKeyValues(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="value",
)93. AiNotificationsAccountStitchedFields¶
Available fields:
channelSchema: Fetch channel creation schemachannelSuggestions: Fetch a field suggestions list for Channel creationchannels: Fetch a Channel by productdestinationSuggestions: Fetch a field suggestions list for Destination creationdestinations: Fetch a Destinations by typeoAuthUrl: Get an OAuth URL by destination typevariables: Fetch a Variables by product
class AiNotificationsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"channel_schema",
"channel_suggestions",
"channels",
"destination_suggestions",
"destinations",
"o_auth_url",
"variables",
)
channel_schema = sgqlc.types.Field(
"AiNotificationsChannelSchemaResult",
graphql_name="channelSchema",
args=sgqlc.types.ArgDict(
(
(
"channel_type",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsChannelType),
graphql_name="channelType",
default=None,
),
),
(
"constraints",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiNotificationsConstraint)
),
graphql_name="constraints",
default=None,
),
),
(
"destination_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="destinationId",
default=None,
),
),
(
"product",
sgqlc.types.Arg(
AiNotificationsProduct, graphql_name="product", default=None
),
),
)
),
)
"""Arguments:
* `channel_type` (`AiNotificationsChannelType!`): Query by
channelType
* `constraints` (`[AiNotificationsConstraint!]`): Channel creation
constraints
* `destination_id` (`ID!`): Query by destinationId
* `product` (`AiNotificationsProduct`): Product type for schema
personalization
"""
channel_suggestions = sgqlc.types.Field(
"AiNotificationsSuggestionsResponse",
graphql_name="channelSuggestions",
args=sgqlc.types.ArgDict(
(
(
"channel_type",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsChannelType),
graphql_name="channelType",
default=None,
),
),
(
"constraints",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiNotificationsConstraint)
),
graphql_name="constraints",
default=None,
),
),
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"destination_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="destinationId",
default=None,
),
),
(
"filter",
sgqlc.types.Arg(
AiNotificationsSuggestionFilter,
graphql_name="filter",
default=None,
),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
)
),
)
"""Arguments:
* `channel_type` (`AiNotificationsChannelType!`): Suggestions
channel type
* `constraints` (`[AiNotificationsConstraint!]`): List of
key/value pairs indicating field constraints
* `cursor` (`String`): cursor to get the next batch of results
* `destination_id` (`ID!`): Query by destinationId
* `filter` (`AiNotificationsSuggestionFilter`): Filter for the
suggestions results
* `key` (`String!`): The field name for which the suggestions are
"""
channels = sgqlc.types.Field(
"AiNotificationsChannelsResponse",
graphql_name="channels",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiNotificationsChannelFilter,
graphql_name="filters",
default=None,
),
),
(
"sorter",
sgqlc.types.Arg(
AiNotificationsChannelSorter,
graphql_name="sorter",
default=None,
),
),
)
),
)
destination_suggestions = sgqlc.types.Field(
"AiNotificationsSuggestionsResponse",
graphql_name="destinationSuggestions",
args=sgqlc.types.ArgDict(
(
(
"constraints",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiNotificationsConstraint)
),
graphql_name="constraints",
default=None,
),
),
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"destination_type",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationType),
graphql_name="destinationType",
default=None,
),
),
(
"filter",
sgqlc.types.Arg(
AiNotificationsSuggestionFilter,
graphql_name="filter",
default=None,
),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
)
),
)
"""Arguments:
* `constraints` (`[AiNotificationsConstraint!]`): List of
key/value pairs indicating field constraints
* `cursor` (`String`): cursor to get the next batch of results
* `destination_type` (`AiNotificationsDestinationType!`):
Suggestions destination type
* `filter` (`AiNotificationsSuggestionFilter`): Filter for the
suggestions results
* `key` (`String!`): The field name for which the suggestions are
"""
destinations = sgqlc.types.Field(
"AiNotificationsDestinationsResponse",
graphql_name="destinations",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiNotificationsDestinationFilter,
graphql_name="filters",
default=None,
),
),
(
"sorter",
sgqlc.types.Arg(
AiNotificationsDestinationSorter,
graphql_name="sorter",
default=None,
),
),
)
),
)
o_auth_url = sgqlc.types.Field(
"AiNotificationsOAuthUrlResponse",
graphql_name="oAuthUrl",
args=sgqlc.types.ArgDict(
(
(
"redirect_url",
sgqlc.types.Arg(String, graphql_name="redirectUrl", default=None),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationType),
graphql_name="type",
default=None,
),
),
)
),
)
variables = sgqlc.types.Field(
"AiNotificationsVariableResult",
graphql_name="variables",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiNotificationsVariableFilter,
graphql_name="filters",
default=None,
),
),
(
"sorter",
sgqlc.types.Arg(
AiNotificationsVariableSorter,
graphql_name="sorter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor to get the next batch of results
* `filters` (`AiNotificationsVariableFilter`): Query filters
* `sorter` (`AiNotificationsVariableSorter`): Sort object for
results
"""94. AiNotificationsBasicAuth¶
Basic user and password authentication
Available fields:
authType: Authentication Type - Basicuser: Username
class AiNotificationsBasicAuth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("auth_type", "user")
auth_type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsAuthType), graphql_name="authType"
)
user = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="user")95. AiNotificationsChannel¶
Channel object
Available fields:
accountId: The accountId of the creator of the channelactive: Is channel activecreatedAt: Channel creation timedestinationId: Related destination typeid: Channel idname: Channel nameproduct: Related product typeproperties: List of destination property typesstatus: Channel Statustype: Channel typeupdatedAt: Channel last update timeupdatedBy: Message template creator userId
class AiNotificationsChannel(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"active",
"created_at",
"destination_id",
"id",
"name",
"product",
"properties",
"status",
"type",
"updated_at",
"updated_by",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
active = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="active")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
destination_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="destinationId"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
product = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsProduct), graphql_name="product"
)
properties = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiNotificationsProperty"))
),
graphql_name="properties",
)
status = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelStatus), graphql_name="status"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelType), graphql_name="type"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="updatedBy")96. AiNotificationsChannelResponse¶
Response for all channel related mutations. Includes relevant channel and/or errors
Available fields:
channel: Successfully mutated channelerror: Error in channel mutation
class AiNotificationsChannelResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("channel", "error")
channel = sgqlc.types.Field(AiNotificationsChannel, graphql_name="channel")
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")97. AiNotificationsChannelSchemaResult¶
Channel schema object
Available fields:
error: Error while querying channelSchemaresult: Result of channelSchema queryschema: Possible fields for the channel
class AiNotificationsChannelSchemaResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "result", "schema")
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")
result = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsResult), graphql_name="result"
)
schema = sgqlc.types.Field("AiNotificationsSchema", graphql_name="schema")98. AiNotificationsChannelTestResponse¶
Result of a notification test
Available fields:
details: Extra details (if available)error: Test response errorevidence: The evidence (url for example) of the channel being created.result: Test result - success or failure
class AiNotificationsChannelTestResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("details", "error", "evidence", "result")
details = sgqlc.types.Field(String, graphql_name="details")
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")
evidence = sgqlc.types.Field(String, graphql_name="evidence")
result = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsResult), graphql_name="result"
)99. AiNotificationsChannelsResponse¶
Channel result object
Available fields:
entities: Channel entitieserror: Error in channel entities fetchingnextCursor: Cursor to get the next batch of resultstotalCount: Count of all channel entities
class AiNotificationsChannelsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "error", "next_cursor", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsChannel))
),
graphql_name="entities",
)
error = sgqlc.types.Field("AiNotificationsResponseError", graphql_name="error")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)100. AiNotificationsConstraintError¶
Missing constraint error. Constraints can be retrieved using suggestion api
Available fields:
dependencies: Names of other constraints this constraint is dependent onname: Name of the missing constraint
class AiNotificationsConstraintError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("dependencies", "name")
dependencies = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="dependencies",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")101. AiNotificationsConstraintsError¶
Object for constraints errors
Available fields:
constraints: List of missing constraints for channel creation
class AiNotificationsConstraintsError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("constraints",)
constraints = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsConstraintError))
),
graphql_name="constraints",
)102. AiNotificationsCustomHeader¶
Custom header based authentication
Available fields:
key: Authentication Header Key
class AiNotificationsCustomHeader(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key",)
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")103. AiNotificationsCustomHeadersAuth¶
Custom header based authentication
Available fields:
authType: Authentication type - Custom headerscustomHeaders: List of custom headers
class AiNotificationsCustomHeadersAuth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("auth_type", "custom_headers")
auth_type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsAuthType), graphql_name="authType"
)
custom_headers = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsCustomHeader))
),
graphql_name="customHeaders",
)104. AiNotificationsDataValidationError¶
Object for validation errors
Available fields:
details: Top level error detailsfields: List of invalid fields
class AiNotificationsDataValidationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("details", "fields")
details = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="details")
fields = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiNotificationsFieldError"))
),
graphql_name="fields",
)105. AiNotificationsDeleteResponse¶
Delete response object
Available fields:
error: Error in object deletionids: Deleted object ids
class AiNotificationsDeleteResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "ids")
error = sgqlc.types.Field("AiNotificationsResponseError", graphql_name="error")
ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)), graphql_name="ids"
)106. AiNotificationsDestination¶
Destination Object
Available fields:
accountId: The accountId of the creator of the destinationactive: Destination activeauth: Authentication for this destinationcreatedAt: Destination created atguid: Entity Id of the Destinationid: Destination idisUserAuthenticated: Indicates whether the user is authenticated with the destinationlastSent: Last time a notification was sentname: Destination nameproperties: List of destination property typesscope: Scope of destinationsecureUrl: URL in secure formatstatus: Destination statustype: Destination typeupdatedAt: Destination updated atupdatedBy: Destination updated by
class AiNotificationsDestination(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"active",
"auth",
"created_at",
"guid",
"id",
"is_user_authenticated",
"last_sent",
"name",
"properties",
"scope",
"secure_url",
"status",
"type",
"updated_at",
"updated_by",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
active = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="active")
auth = sgqlc.types.Field("AiNotificationsAuth", graphql_name="auth")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
is_user_authenticated = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isUserAuthenticated"
)
last_sent = sgqlc.types.Field(DateTime, graphql_name="lastSent")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
properties = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiNotificationsProperty"))
),
graphql_name="properties",
)
scope = sgqlc.types.Field(
sgqlc.types.non_null("AiNotificationsEntityScope"), graphql_name="scope"
)
secure_url = sgqlc.types.Field("AiNotificationsSecureUrl", graphql_name="secureUrl")
status = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationStatus), graphql_name="status"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationType), graphql_name="type"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="updatedBy")107. AiNotificationsDestinationResponse¶
Response for all destinations related mutation. Includes relevant destination and/or errors
Available fields:
destination: Successfully mutated destinationerror: Error in destination mutation
class AiNotificationsDestinationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("destination", "error")
destination = sgqlc.types.Field(
AiNotificationsDestination, graphql_name="destination"
)
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")108. AiNotificationsDestinationTestResponse¶
Result of a connection test
Available fields:
details: Extra details (if available)error: Test response errorresult: Test result - success or failure
class AiNotificationsDestinationTestResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("details", "error", "result")
details = sgqlc.types.Field(String, graphql_name="details")
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")
result = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsResult), graphql_name="result"
)109. AiNotificationsDestinationsResponse¶
Destinations result object
Available fields:
entities: Destination entitieserror: Error in destinations entities fetchingnextCursor: Cursor to get the next batch of resultstotalCount: Count of all destination entities
class AiNotificationsDestinationsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "error", "next_cursor", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsDestination))
),
graphql_name="entities",
)
error = sgqlc.types.Field("AiNotificationsResponseError", graphql_name="error")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)110. AiNotificationsEntityScope¶
Entity Scope
Available fields:
id: Entity scope idtype: Entity scope type
class AiNotificationsEntityScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsEntityScopeType), graphql_name="type"
)111. AiNotificationsFieldError¶
Invalid field object
Available fields:
field: Field namemessage: Validation error
class AiNotificationsFieldError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("field", "message")
field = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="field")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")112. AiNotificationsOAuth2Auth¶
OAuth2 based authentication
Available fields:
accessTokenUrl: OAuth2 access token urlauthType: Authentication Type - Token or Oauth2authorizationUrl: OAuth2 authorization urlclientId: OAuth2 clientIdprefix: Token prefixrefreshInterval: Interval of how often should the access token be refreshedrefreshable: Is the OAuth2 access token refreshablescope: OAuth2 token’s scope
class AiNotificationsOAuth2Auth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"access_token_url",
"auth_type",
"authorization_url",
"client_id",
"prefix",
"refresh_interval",
"refreshable",
"scope",
)
access_token_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="accessTokenUrl"
)
auth_type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsAuthType), graphql_name="authType"
)
authorization_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="authorizationUrl"
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="clientId")
prefix = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="prefix")
refresh_interval = sgqlc.types.Field(Int, graphql_name="refreshInterval")
refreshable = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="refreshable"
)
scope = sgqlc.types.Field(String, graphql_name="scope")113. AiNotificationsOAuthUrlResponse¶
OAuth URL response
Available fields:
error: OAuth response errortransactionId: Transaction id to track OAuth flow withurl: OAuth URL for the user
class AiNotificationsOAuthUrlResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "transaction_id", "url")
error = sgqlc.types.Field("AiNotificationsResponseError", graphql_name="error")
transaction_id = sgqlc.types.Field(ID, graphql_name="transactionId")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")114. AiNotificationsOrganizationStitchedFields¶
Organization level queries
Available fields:
destinations: Fetch a Destinations by typeoAuthUrl: Get an OAuth URL by destination typeunverifiedEmails: Fetch all unverified emails for an Organization
class AiNotificationsOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("destinations", "o_auth_url", "unverified_emails")
destinations = sgqlc.types.Field(
AiNotificationsDestinationsResponse,
graphql_name="destinations",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiNotificationsDestinationFilter,
graphql_name="filters",
default=None,
),
),
(
"sorter",
sgqlc.types.Arg(
AiNotificationsDestinationSorter,
graphql_name="sorter",
default=None,
),
),
)
),
)
o_auth_url = sgqlc.types.Field(
AiNotificationsOAuthUrlResponse,
graphql_name="oAuthUrl",
args=sgqlc.types.ArgDict(
(
(
"extended_service",
sgqlc.types.Arg(
AiNotificationsExtendedScopeService,
graphql_name="extendedService",
default=None,
),
),
(
"redirect_url",
sgqlc.types.Arg(String, graphql_name="redirectUrl", default=None),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationType),
graphql_name="type",
default=None,
),
),
)
),
)
unverified_emails = sgqlc.types.Field(
"AiNotificationsUnverifiedEmailsResponse",
graphql_name="unverifiedEmails",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiNotificationsUnverifiedEmailsFilters,
graphql_name="filters",
default=None,
),
),
(
"sorter",
sgqlc.types.Arg(
AiNotificationsUnverifiedEmailsSorter,
graphql_name="sorter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): cursor to get the next batch of results
* `filters` (`AiNotificationsUnverifiedEmailsFilters`): Optional
filters to apply to unverified emails
* `sorter` (`AiNotificationsUnverifiedEmailsSorter`): Optional
sorting configuration
"""115. AiNotificationsProperty¶
Channel property Object
Available fields:
displayValue: Channel property display keykey: Channel property keylabel: Channel property display keyvalue: Channel property value
class AiNotificationsProperty(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_value", "key", "label", "value")
display_value = sgqlc.types.Field(String, graphql_name="displayValue")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
label = sgqlc.types.Field(String, graphql_name="label")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")116. AiNotificationsResponseError¶
Response error object
Available fields:
description: Error descriptiondetails: Error detailstype: Error type
class AiNotificationsResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "details", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
details = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="details")
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsErrorType), graphql_name="type"
)117. AiNotificationsSchema¶
Channel schema object
Available fields:
fields: Possible fields for the channel
class AiNotificationsSchema(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("fields",)
fields = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiNotificationsSchemaField"))
),
graphql_name="fields",
)118. AiNotificationsSchemaField¶
Schema field object
Available fields:
component: UI Component detailskey: Field keylabel: Field label shown in the UImandatory: Is the field mandatory
class AiNotificationsSchemaField(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("component", "key", "label", "mandatory")
component = sgqlc.types.Field(
sgqlc.types.non_null("AiNotificationsUiComponent"), graphql_name="component"
)
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
label = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="label")
mandatory = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="mandatory"
)119. AiNotificationsSecureUrl¶
URL in secure format
Available fields:
prefix: URL prefix
class AiNotificationsSecureUrl(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("prefix",)
prefix = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="prefix")120. AiNotificationsSelectComponentOptions¶
Additional options for SELECT type components
Available fields:
creatable: Is custom value creation alloweddependentOn: List of field keys their values are required in order to fetch suggestions for this fieldfilteredBy: List of field keys their values can be used to filter suggestions bylabel: Do we allow additional values as input other than suggested?multiple: Are we expecting a single or multiple valuessearchable: Is this component searchablesuggestions: Preloaded suggestions for
class AiNotificationsSelectComponentOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"creatable",
"dependent_on",
"filtered_by",
"label",
"multiple",
"searchable",
"suggestions",
)
creatable = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="creatable"
)
dependent_on = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="dependentOn",
)
filtered_by = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="filteredBy",
)
label = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="label")
multiple = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="multiple")
searchable = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="searchable"
)
suggestions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiNotificationsSuggestion"))
),
graphql_name="suggestions",
)121. AiNotificationsSuggestion¶
Suggestion object
Available fields:
displayValue: Suggestion labelicon: Should suggestion be the default selectionvalue: Suggestion key
class AiNotificationsSuggestion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_value", "icon", "value")
display_value = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayValue"
)
icon = sgqlc.types.Field(String, graphql_name="icon")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")122. AiNotificationsSuggestionError¶
Object for suggestion errors
Available fields:
class AiNotificationsSuggestionError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()123. AiNotificationsSuggestionsResponse¶
Possible values for a field by its key
Available fields:
entities: List of Suggestion objectserror: Error while fetching suggestionsnextCursor: Cursor to get the next batch of resultsresult: Suggestions request resulttotalCount: Count of all suggestion entities, -1 if unavailable
class AiNotificationsSuggestionsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "error", "next_cursor", "result", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsSuggestion))
),
graphql_name="entities",
)
error = sgqlc.types.Field("AiNotificationsError", graphql_name="error")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
result = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsResult), graphql_name="result"
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)124. AiNotificationsTokenAuth¶
Token based authentication
Available fields:
authType: Authentication Type - Token or Oauth2prefix: Token Prefix
class AiNotificationsTokenAuth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("auth_type", "prefix")
auth_type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsAuthType), graphql_name="authType"
)
prefix = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="prefix")125. AiNotificationsUiComponent¶
UI component object
Available fields:
allowTemplateVariables: Should we allow variables rendering in this componentdataValidation: Which data validation is applied to this componentdefaultValue: Default value of this componentselectOptions: Additional options for SELECT type componentstype: Component typevisibleByDefault: Is this component a part of the default fields
class AiNotificationsUiComponent(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"allow_template_variables",
"data_validation",
"default_value",
"select_options",
"type",
"visible_by_default",
)
allow_template_variables = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="allowTemplateVariables"
)
data_validation = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsUiComponentValidation),
graphql_name="dataValidation",
)
default_value = sgqlc.types.Field(
AiNotificationsSuggestion, graphql_name="defaultValue"
)
select_options = sgqlc.types.Field(
AiNotificationsSelectComponentOptions, graphql_name="selectOptions"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsUiComponentType), graphql_name="type"
)
visible_by_default = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="visibleByDefault"
)126. AiNotificationsUnverifiedEmail¶
Unverified email entity
Available fields:
email: Email addressid: Verification idstatus: Verification statusupdatedAt: updated at
class AiNotificationsUnverifiedEmail(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "id", "status", "updated_at")
email = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="email")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
status = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsEmailVerificationStatus),
graphql_name="status",
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)127. AiNotificationsUnverifiedEmailsResponse¶
Get All Unverified Emails Response
Available fields:
entities: List of emails with their verification statuserror: Response errornextCursor: next cursorresult: Response result - success or failuretotalCount: total count
class AiNotificationsUnverifiedEmailsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "error", "next_cursor", "result", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsUnverifiedEmail))
),
graphql_name="entities",
)
error = sgqlc.types.Field(AiNotificationsResponseError, graphql_name="error")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
result = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsResult), graphql_name="result"
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)128. AiNotificationsVariable¶
Variable object
Available fields:
active: Is variable activecategory: Variable categorycreatedAt: Variable creation timedescription: Variable descriptionexample: Variable exampleid: Variable idkey: Variable keylabel: Variable labelname: Variable nameproduct: Related product typetype: Variable typeupdatedAt: Variable update timeupdatedBy: Variable creator userId
class AiNotificationsVariable(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"active",
"category",
"created_at",
"description",
"example",
"id",
"key",
"label",
"name",
"product",
"type",
"updated_at",
"updated_by",
)
active = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="active")
category = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsVariableCategory), graphql_name="category"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
description = sgqlc.types.Field(String, graphql_name="description")
example = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="example")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
label = sgqlc.types.Field(String, graphql_name="label")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
product = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsProduct), graphql_name="product"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsVariableType), graphql_name="type"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="updatedBy")129. AiNotificationsVariableResult¶
Channel result object
Available fields:
entities: Variable entitiesnextCursor: Cursor to get the next batch of resultstotalCount: Count of all variable entities
class AiNotificationsVariableResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "next_cursor", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiNotificationsVariable))
),
graphql_name="entities",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)130. AiTopologyAccountStitchedFields¶
Available fields:
class AiTopologyAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()131. AiTopologyCollectorOperationResult¶
Result of an operation.
Available fields:
result: Status of the operation.
class AiTopologyCollectorOperationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("result",)
result = sgqlc.types.Field(
sgqlc.types.non_null(AiTopologyCollectorResultType), graphql_name="result"
)132. AiTopologyDefiningAttribute¶
A key-value entry representing an attribute name and value.
Available fields:
key: Key of entry.value: Value of entry.
class AiTopologyDefiningAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")133. AiTopologyEdge¶
A connection between two vertices within a graph
Available fields:
directed: Whether or not the direction of the edge has semantic meaning.fromVertexId: ID of parent vertex.fromVertexName: Name of parent vertex.id: ID of edge.toVertexId: ID of child vertex.toVertexName: Name of child vertex.updatedAt: Time rule was last updated.
class AiTopologyEdge(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"directed",
"from_vertex_id",
"from_vertex_name",
"id",
"to_vertex_id",
"to_vertex_name",
"updated_at",
)
directed = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="directed")
from_vertex_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="fromVertexId"
)
from_vertex_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="fromVertexName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
to_vertex_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="toVertexId"
)
to_vertex_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="toVertexName"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)134. AiTopologyEdgeListing¶
Listing of edges in a graph.
Available fields:
count: Number of edges returned by the query.cursor: Next cursor.edges: List of edges.
class AiTopologyEdgeListing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "cursor", "edges")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
cursor = sgqlc.types.Field(String, graphql_name="cursor")
edges = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(AiTopologyEdge))),
graphql_name="edges",
)135. AiTopologyGraph¶
Overview of a graph; all edges and vertices.
Available fields:
edges: List of all edges in this graph.vertices: List of all vertices in this graph.
class AiTopologyGraph(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("edges", "vertices")
edges = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(AiTopologyEdge))),
graphql_name="edges",
)
vertices = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiTopologyVertex"))
),
graphql_name="vertices",
)136. AiTopologyVertex¶
A vertex is a representation of a node in a graph: a host; an application; etc.
Available fields:
definingAttributes: The attributes used to define a vertex as a key-value entry.id: ID of vertex.name: Name of the vertex.updatedAt: Time rule was last updated.vertexClass: Class of the vertex.
class AiTopologyVertex(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"defining_attributes",
"id",
"name",
"updated_at",
"vertex_class",
)
defining_attributes = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiTopologyDefiningAttribute))
),
graphql_name="definingAttributes",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)
vertex_class = sgqlc.types.Field(
sgqlc.types.non_null(AiTopologyVertexClass), graphql_name="vertexClass"
)137. AiTopologyVertexListing¶
Listing of vertices in a graph.
Available fields:
count: Number of vertices returned by this query.cursor: Next cursor.vertices: List of vertices.
class AiTopologyVertexListing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "cursor", "vertices")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
cursor = sgqlc.types.Field(String, graphql_name="cursor")
vertices = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiTopologyVertex))
),
graphql_name="vertices",
)138. AiWorkflowsAccountStitchedFields¶
Available fields:
workflows: Returns a list of workflows with pagination cursor according to account id and filters
class AiWorkflowsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("workflows",)
workflows = sgqlc.types.Field(
"AiWorkflowsWorkflows",
graphql_name="workflows",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filters",
sgqlc.types.Arg(
AiWorkflowsFilters, graphql_name="filters", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor used to get the next page of results
* `filters` (`AiWorkflowsFilters`): Query filters
"""139. AiWorkflowsCreateWorkflowResponse¶
Create workflow mutation response including errors
Available fields:
errors: A list of errors that occurred while performing the create workflow actionworkflow: Successfully created workflow
class AiWorkflowsCreateWorkflowResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "workflow")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsCreateResponseError"))
),
graphql_name="errors",
)
workflow = sgqlc.types.Field("AiWorkflowsWorkflow", graphql_name="workflow")140. AiWorkflowsDeleteWorkflowResponse¶
Delete workflow mutation response including errors
Available fields:
errors: A list of errors that occurred while performing the delete workflow actionid: Id of the successfully deleted workflow
class AiWorkflowsDeleteWorkflowResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "id")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsDeleteResponseError"))
),
graphql_name="errors",
)
id = sgqlc.types.Field(ID, graphql_name="id")141. AiWorkflowsDestinationConfiguration¶
Destination Configuration Object
Available fields:
channelId: Channel Id of the Destination Configurationname: Name of the Destination ConfigurationnotificationTriggers: Notification triggers of the Destination Configurationtype: Type of the Destination ConfigurationupdateOriginalMessage: Update original notification message (Slack channels only)
class AiWorkflowsDestinationConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"channel_id",
"name",
"notification_triggers",
"type",
"update_original_message",
)
channel_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="channelId")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
notification_triggers = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AiWorkflowsNotificationTrigger)),
graphql_name="notificationTriggers",
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsDestinationType), graphql_name="type"
)
update_original_message = sgqlc.types.Field(
Boolean, graphql_name="updateOriginalMessage"
)142. AiWorkflowsEnrichment¶
Makes it possible to augment the notification with additional data from the New Relic platform
Available fields:
accountId: Account Id of the Enrichmentconfigurations: List of configurations for the enrichmentcreatedAt: The time the Enrichment was createdid: Enrichment Idname: Name of the Enrichmenttype: Type of the EnrichmentupdatedAt: The time the Enrichment was last updated
class AiWorkflowsEnrichment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"configurations",
"created_at",
"id",
"name",
"type",
"updated_at",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
configurations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsConfiguration"))
),
graphql_name="configurations",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsEnrichmentType), graphql_name="type"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)143. AiWorkflowsFilter¶
Filter Object
Available fields:
accountId: Account Id of this Filterid: Filter Idname: Name of the Filterpredicates: Expressions that determine which issues will be handledtype: The type of the Filter
class AiWorkflowsFilter(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "id", "name", "predicates", "type")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
predicates = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsPredicate"))
),
graphql_name="predicates",
)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsFilterType), graphql_name="type"
)144. AiWorkflowsNrqlConfiguration¶
NRQL enrichment configuration
Available fields:
query: NRQL query
class AiWorkflowsNrqlConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("query",)
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")145. AiWorkflowsPredicate¶
Predicate Object
Available fields:
attribute: Field name in the issue eventoperator: Type of operator used to match the valuesvalues: Values to compare
class AiWorkflowsPredicate(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute", "operator", "values")
attribute = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attribute"
)
operator = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsOperator), graphql_name="operator"
)
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)146. AiWorkflowsTestNotificationResponse¶
Notification response according to channel id
Available fields:
channelId: The id of the tested channelevidence: Evidence for a successful test notificationstatus: Whether the test notification succeeded
class AiWorkflowsTestNotificationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("channel_id", "evidence", "status")
channel_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="channelId")
evidence = sgqlc.types.Field(String, graphql_name="evidence")
status = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsTestNotificationResponseStatus),
graphql_name="status",
)147. AiWorkflowsTestWorkflowResponse¶
Test workflow mutation response including errors
Available fields:
errors: A list of errors that occurred while performing the test workflow actionnotificationResponses: List of responses by channel idstatus: Whether the test was a success or not
class AiWorkflowsTestWorkflowResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "notification_responses", "status")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsTestResponseError")),
graphql_name="errors",
)
notification_responses = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AiWorkflowsTestNotificationResponse)),
graphql_name="notificationResponses",
)
status = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsTestResponseStatus), graphql_name="status"
)148. AiWorkflowsUpdateWorkflowResponse¶
Update workflow mutation response including errors
Available fields:
errors: A list of errors that occurred while performing the update workflow actionworkflow: Successfully updated workflow
class AiWorkflowsUpdateWorkflowResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "workflow")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AiWorkflowsUpdateResponseError"))
),
graphql_name="errors",
)
workflow = sgqlc.types.Field("AiWorkflowsWorkflow", graphql_name="workflow")149. AiWorkflowsWorkflow¶
Workflow object
Available fields:
accountId: Account Id of this WorkflowcreatedAt: The time this workflow was createddestinationConfigurations: Specifies where to send the notificationsdestinationsEnabled: Are Destinations enabledenrichments: List of enrichments that are attached to the notificationsenrichmentsEnabled: Are Enrichments enabledguid: Entity Id of the workflowid: Workflow IdissuesFilter: Specifies which issues the workflow will handlelastRun: Last time a notification was sent regarding this workflowmutingRulesHandling: Describes how to handle muted issuesname: Name of the WorkflowupdatedAt: The time this workflow was updatedworkflowEnabled: Is Workflow enabled
class AiWorkflowsWorkflow(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"destination_configurations",
"destinations_enabled",
"enrichments",
"enrichments_enabled",
"guid",
"id",
"issues_filter",
"last_run",
"muting_rules_handling",
"name",
"updated_at",
"workflow_enabled",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
destination_configurations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AiWorkflowsDestinationConfiguration)
)
),
graphql_name="destinationConfigurations",
)
destinations_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="destinationsEnabled"
)
enrichments = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiWorkflowsEnrichment))
),
graphql_name="enrichments",
)
enrichments_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="enrichmentsEnabled"
)
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
issues_filter = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsFilter), graphql_name="issuesFilter"
)
last_run = sgqlc.types.Field(DateTime, graphql_name="lastRun")
muting_rules_handling = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsMutingRulesHandling),
graphql_name="mutingRulesHandling",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
workflow_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="workflowEnabled"
)150. AiWorkflowsWorkflows¶
Workflows query response
Available fields:
entities: List of all workflowsnextCursor: Cursor to get the next batch of resultstotalCount: Total count of all workflows
class AiWorkflowsWorkflows(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "next_cursor", "total_count")
entities = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AiWorkflowsWorkflow))
),
graphql_name="entities",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)151. AlertsAccountStitchedFields¶
Available fields:
asNrqlConditionsSearch: List classic conditions in a NRQL-converted format according to search criteria.compoundConditions: Fetch compound conditions and filtercrossAccountElection: Fetch the cross-account election status for the current account.crossAccountParticipants: Fetch the accounts within the current organization that have elected to allow their data to be the target of cross-account alert conditions in this account.mutingRule: Retrieve a muting rule for Alerts violations.mutingRules: List the muting rules for an account.nrqlCondition: Retrieve a specific NRQL condition.nrqlConditionsSearch: List NRQL conditions according to search criteria.policiesSearch: List Alerts policies according to search criteria.policy: Retrieve a specific Alerts policy.
class AlertsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"as_nrql_conditions_search",
"compound_conditions",
"cross_account_election",
"cross_account_participants",
"muting_rule",
"muting_rules",
"nrql_condition",
"nrql_conditions_search",
"policies_search",
"policy",
)
as_nrql_conditions_search = sgqlc.types.Field(
"AlertsAsNrqlConditionsSearchResultSet",
graphql_name="asNrqlConditionsSearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"search_criteria",
sgqlc.types.Arg(
AlertsAsNrqlConditionsSearchCriteriaInput,
graphql_name="searchCriteria",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous `asNrqlConditionsSearch` query.
* `search_criteria` (`AlertsAsNrqlConditionsSearchCriteriaInput`):
Search criteria used to filter the returned list of NRQL-
converted conditions.
"""
compound_conditions = sgqlc.types.Field(
"AlertsCompoundConditionsResultSet",
graphql_name="compoundConditions",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
AlertsCompoundConditionFilterInput,
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AlertsCompoundConditionSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous query.
* `filter` (`AlertsCompoundConditionFilterInput`): Filter search
results
* `sort` (`[AlertsCompoundConditionSortInput!]`): Order search
results by specific field
"""
cross_account_election = sgqlc.types.Field(
"AlertsCrossAccountElectionStatus", graphql_name="crossAccountElection"
)
cross_account_participants = sgqlc.types.Field(
sgqlc.types.list_of("AlertsCrossAccountParticipant"),
graphql_name="crossAccountParticipants",
)
muting_rule = sgqlc.types.Field(
"AlertsMutingRule",
graphql_name="mutingRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): Muting rule identifier.
"""
muting_rules = sgqlc.types.Field(
sgqlc.types.list_of("AlertsMutingRule"),
graphql_name="mutingRules",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
AlertsMutingRulesFilterCriteriaInput,
graphql_name="filter",
default=None,
),
),
)
),
)
nrql_condition = sgqlc.types.Field(
AlertsNrqlCondition,
graphql_name="nrqlCondition",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): NRQL condition identifier.
"""
nrql_conditions_search = sgqlc.types.Field(
"AlertsNrqlConditionsSearchResultSet",
graphql_name="nrqlConditionsSearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"search_criteria",
sgqlc.types.Arg(
AlertsNrqlConditionsSearchCriteriaInput,
graphql_name="searchCriteria",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous `NrqlConditionsSearch` query.
* `search_criteria` (`AlertsNrqlConditionsSearchCriteriaInput`):
Search criteria used to filter the returned list of NRQL
conditions.
"""
policies_search = sgqlc.types.Field(
"AlertsPoliciesSearchResultSet",
graphql_name="policiesSearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"search_criteria",
sgqlc.types.Arg(
AlertsPoliciesSearchCriteriaInput,
graphql_name="searchCriteria",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous `PoliciesSearch` query.
* `search_criteria` (`AlertsPoliciesSearchCriteriaInput`): Search
criteria used to filter the returned list of policies.
"""
policy = sgqlc.types.Field(
"AlertsPolicy",
graphql_name="policy",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): Policy identifier.
"""152. AlertsAsNrqlConditionsSearchResultSet¶
A collection of NRQL-converted conditions with pagination information.
Available fields:
nextCursor: Cursor pointing to the end of the current page of NrqlCondition records. Null if final page.nrqlConditions: A set ofNrqlConditionsfor the supplied cursor and criteria.totalCount: Total number ofNrqlConditionsfor the given search criteria.
class AlertsAsNrqlConditionsSearchResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "nrql_conditions", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
nrql_conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsAsNrqlCondition))
),
graphql_name="nrqlConditions",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)153. AlertsCampfireNotificationChannelConfig¶
Configuration for Campfire notification channel.
Available fields:
class AlertsCampfireNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()154. AlertsCompoundComponentCondition¶
The component condition to be combined with other component conditions in a CompoundCondition.
Available fields:
alias: The identifier that will be used in the compound alert condition’s triggerExpression e.g. ‘a’, ‘b’.condition: The condition whose evaluation will be used to combine with other conditions in a CompoundCondition.id: Component condition id.
class AlertsCompoundComponentCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("alias", "condition", "id")
alias = sgqlc.types.Field(String, graphql_name="alias")
condition = sgqlc.types.Field(AlertsAsNrqlCondition, graphql_name="condition")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")155. AlertsCompoundCondition¶
A New Relic compound alert condition. Allows combining evaluations from multiple alert conditions through a triggerExpression.
Available fields:
componentConditions: The list of conditions to be combined. Each component condition must be ‘enabled’.enabled: Whether or not the compound alert condition is enabled.facetMatchingBehavior: How the compound condition will take into account the component conditions’ facets during evaluation.id: Compound alert condition id.name: Compound alert condition name.policyId: Compound alert condition policy id.runbookUrl: Runbook URL.thresholdDuration: The duration, in seconds, that the triggerExpression must be true before the compound alert condition will activate.triggerExpression: Expression that defines how component condition evaluations are combined. Valid operators are ‘AND’, ‘OR’, ‘NOT’. For more complex expressions, use parentheses. Simple example: ‘A AND B AND C’ Complex example: ‘A AND (B OR C) AND NOT (D AND E)’
class AlertsCompoundCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"component_conditions",
"enabled",
"facet_matching_behavior",
"id",
"name",
"policy_id",
"runbook_url",
"threshold_duration",
"trigger_expression",
)
component_conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsCompoundComponentCondition))
),
graphql_name="componentConditions",
)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
facet_matching_behavior = sgqlc.types.Field(
AlertsCompoundConditionFacetMatchingBehavior,
graphql_name="facetMatchingBehavior",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
policy_id = sgqlc.types.Field(ID, graphql_name="policyId")
runbook_url = sgqlc.types.Field(String, graphql_name="runbookUrl")
threshold_duration = sgqlc.types.Field(
sgqlc.types.non_null(Seconds), graphql_name="thresholdDuration"
)
trigger_expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="triggerExpression"
)156. AlertsCompoundConditionsResultSet¶
A collection of Compound Alerts with pagination information.
Available fields:
items: A set ofCompoundConditionsfor the supplied cursor and criteria.nextCursor: Cursor pointing to the end of the current page of CompoundConditions records. Null if final page.totalCount: Total number ofCompoundConditionsfor the given search criteria.
class AlertsCompoundConditionsResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsCompoundCondition)),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)157. AlertsConditionDeleteResponse¶
Success response for deleting an Alerts condition.
Available fields:
id: ID of the deleted Alerts condition.
class AlertsConditionDeleteResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")158. AlertsCrossAccountElectionStatus¶
An object describing the current election status of an account with respect to cross-account alerting.
Available fields:
electionStatus: Whether the account has elected to allow their data to be the target of a cross-account alert.
class AlertsCrossAccountElectionStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("election_status",)
election_status = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="electionStatus"
)159. AlertsCrossAccountParticipant¶
An object describing an account that has elected to allow their data to be the target of a cross-account alert.
Available fields:
accountId: Account ID of an account that has elected to allow their data to be the target of a cross-account alert.
class AlertsCrossAccountParticipant(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id",)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")160. AlertsEmailNotificationChannelConfig¶
Configuration for Email notification channel.
Available fields:
emails: List of email recipients.includeJson: Include details about the violation as a JSON attachment.
class AlertsEmailNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("emails", "include_json")
emails = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="emails",
)
include_json = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="includeJson"
)161. AlertsHipChatNotificationChannelConfig¶
Configuration for HipChat notification channel.
Available fields:
class AlertsHipChatNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()162. AlertsMutingRule¶
A MutingRule for New Relic Alerts Violations.
Available fields:
accountId: The account id of the MutingRule.actionOnMutingRuleWindowEnded: The action when the muting rule window is ended or disabled.condition: The condition that defines which violations to target.createdAt: The timestamp of when the MutingRule was created.createdByUser: The user information that created the MutingRule.description: The description of the MutingRule.enabled: Whether the MutingRule is enabledid: The unique identifier for the MutingRule.mutingRuleLifecycleEventPublishedAt: The timestamp of when the MutingRule lifecycle event was last published.name: The name of the MutingRule.schedule: The time window when the MutingRule should actively mute violations.status: The status of a MutingRule based on whether it is Enabled and has a Schedule.updatedAt: The timestamp of when the MutingRule was last modified.updatedByUser: The user information that last modified the MutingRule.
class AlertsMutingRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"action_on_muting_rule_window_ended",
"condition",
"created_at",
"created_by_user",
"description",
"enabled",
"id",
"muting_rule_lifecycle_event_published_at",
"name",
"schedule",
"status",
"updated_at",
"updated_by_user",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
action_on_muting_rule_window_ended = sgqlc.types.Field(
AlertsActionOnMutingRuleWindowEnded,
graphql_name="actionOnMutingRuleWindowEnded",
)
condition = sgqlc.types.Field(
sgqlc.types.non_null("AlertsMutingRuleConditionGroup"), graphql_name="condition"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by_user = sgqlc.types.Field("UserReference", graphql_name="createdByUser")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
muting_rule_lifecycle_event_published_at = sgqlc.types.Field(
DateTime, graphql_name="mutingRuleLifecycleEventPublishedAt"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
schedule = sgqlc.types.Field("AlertsMutingRuleSchedule", graphql_name="schedule")
status = sgqlc.types.Field(
sgqlc.types.non_null(AlertsMutingRuleStatus), graphql_name="status"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by_user = sgqlc.types.Field("UserReference", graphql_name="updatedByUser")163. AlertsMutingRuleCondition¶
A condition which describes how to target a New Relic Alerts Violation.
Available fields:
attribute: The attribute on a violation. Expects one of:accountId - The account id
conditionId - The alert condition id
conditionName - The alert condition name
conditionRunbookUrl - The alert condition’s runbook url
conditionType - The alert condition type, such as
metricentity.guid - The entity GUID
nrqlEventType - The NRQL event type
nrqlQuery - The NRQL query string
policyId - The alert policy id
policyName - The alert policy name
product - The target product (e.g.,
SYNTHETICS)tags. - Arbitrary tags associated with some entity (e.g., FACET from a NRQL query, for example
tags.appNameortags.host)targetId - The ID of the alerts target
targetName - The name of the alerts target
operator: The operator used to compare the attribute’s value with the supplied value(s).values: The value(s) to compare against the attribute’s value.
class AlertsMutingRuleCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute", "operator", "values")
attribute = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attribute"
)
operator = sgqlc.types.Field(
sgqlc.types.non_null(AlertsMutingRuleConditionOperator), graphql_name="operator"
)
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(String)), graphql_name="values"
)164. AlertsMutingRuleConditionGroup¶
A group of MutingRuleConditions combined by an operator.
Available fields:
conditions: The individual MutingRuleConditions within the group.operator: The operator used to combine all the MutingRuleConditions within the group.
class AlertsMutingRuleConditionGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("conditions", "operator")
conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsMutingRuleCondition))
),
graphql_name="conditions",
)
operator = sgqlc.types.Field(
sgqlc.types.non_null(AlertsMutingRuleConditionGroupOperator),
graphql_name="operator",
)165. AlertsMutingRuleDeleteResponse¶
The success response for deleting a MutingRule.
Available fields:
id: The id of the deleted MutingRule.
class AlertsMutingRuleDeleteResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")166. AlertsMutingRuleSchedule¶
The time window when the MutingRule should actively mute violations.
Available fields:
endRepeat: The datetime stamp when the MutingRule schedule should stop repeating. This is in ISO 8601 format with offset.
Example: '2020-07-10T15:00:00-07:00'
Note: Either endRepeat or repeatCount should be used to end a MutingRule schedule.
Both fields should not be provided together.
endTime: The datetime stamp representing when the MutingRule should end. This is in ISO 8601 format with offset.
Example: '2020-07-10T15:00:00-07:00'
nextEndTime: The datetime stamp representing the next scheduled end of a recurring MutingRule. This is in ISO 8601 format with offset.
Example: '2020-07-08T14:30:00-07:00'
Note: If a MutingRule is not set to recur, this will match the endTime field.
nextStartTime: The datetime stamp representing the next scheduled start of a recurring MutingRule. This is in ISO 8601 format with offset.
Example: '2020-07-08T14:30:00-07:00'
Note: If a MutingRule is not set to recur, this will match the startTime field.
repeat: The frequency the MutingRule schedule repeats. If the MutingRule repeatsWEEKLY, be sure to setweeklyRepeatDays. If the MutingRule does not repeat, usenull.
Example: DAILY
repeatCount: The number of times the MutingRule schedule should repeat.
Note: Either repeatCount or endRepeat should be used to end a MutingRule schedule.
Both fields should not be provided together.
startTime: The datetime stamp representing when the MutingRule should start. This is in ISO 8601 format with offset.
Example: '2020-07-08T14:30:00-07:00'
timeZone: The time zone that applies to the MutingRule schedule.
Example: 'America/Los_Angeles'
See List of tz database time zones.
weeklyRepeatDays: The day(s) of the week that a MutingRule should repeat when the repeat field is set toWEEKLY.
Example: [MONDAY, WEDNESDAY]
class AlertsMutingRuleSchedule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"end_repeat",
"end_time",
"next_end_time",
"next_start_time",
"repeat",
"repeat_count",
"start_time",
"time_zone",
"weekly_repeat_days",
)
end_repeat = sgqlc.types.Field(DateTime, graphql_name="endRepeat")
end_time = sgqlc.types.Field(DateTime, graphql_name="endTime")
next_end_time = sgqlc.types.Field(DateTime, graphql_name="nextEndTime")
next_start_time = sgqlc.types.Field(DateTime, graphql_name="nextStartTime")
repeat = sgqlc.types.Field(AlertsMutingRuleScheduleRepeat, graphql_name="repeat")
repeat_count = sgqlc.types.Field(Int, graphql_name="repeatCount")
start_time = sgqlc.types.Field(DateTime, graphql_name="startTime")
time_zone = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="timeZone")
weekly_repeat_days = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsDayOfWeek)),
graphql_name="weeklyRepeatDays",
)167. AlertsNotificationChannelCreateError¶
The error for creating a notification channel.
Available fields:
description: Error description.errorType: Error type.
class AlertsNotificationChannelCreateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
error_type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelCreateErrorType),
graphql_name="errorType",
)168. AlertsNotificationChannelCreateResponse¶
The response for creating a notification channel.
Available fields:
error: Error.notificationChannel: Notification channel.
class AlertsNotificationChannelCreateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "notification_channel")
error = sgqlc.types.Field(
AlertsNotificationChannelCreateError, graphql_name="error"
)
notification_channel = sgqlc.types.Field(
"AlertsNotificationChannelMutation", graphql_name="notificationChannel"
)169. AlertsNotificationChannelDeleteError¶
The error for deleting a notification channel.
Available fields:
description: Error description.errorType: Error type.notificationChannelId: Notification channel ID.
class AlertsNotificationChannelDeleteError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_type", "notification_channel_id")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
error_type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelDeleteErrorType),
graphql_name="errorType",
)
notification_channel_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="notificationChannelId"
)170. AlertsNotificationChannelDeleteResponse¶
The response for deleting a notification channel.
Available fields:
error: Error.id: Notification channel ID.
class AlertsNotificationChannelDeleteResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "id")
error = sgqlc.types.Field(
AlertsNotificationChannelDeleteError, graphql_name="error"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")171. AlertsNotificationChannelId¶
A notification channel ID - temporarily until addToPolicy will support returning full notification channels.
Available fields:
class AlertsNotificationChannelId(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()172. AlertsNotificationChannelPoliciesResultSet¶
A result set containing associated policies information for a notification channel.
Available fields:
policies: A set of policies associated with the channel.totalCount: Total number of policies associated with the channel.
class AlertsNotificationChannelPoliciesResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("policies", "total_count")
policies = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("AlertsNotificationChannelPolicy"))
),
graphql_name="policies",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)173. AlertsNotificationChannelPolicy¶
Information about a policy associated with a notification channel.
Available fields:
id: Policy ID.name: Policy name.
class AlertsNotificationChannelPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")174. AlertsNotificationChannelUpdateError¶
The error for updating a notification channel.
Available fields:
description: Error description.errorType: Error type.notificationChannelId: Notification channel ID.
class AlertsNotificationChannelUpdateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_type", "notification_channel_id")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
error_type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelUpdateErrorType),
graphql_name="errorType",
)
notification_channel_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="notificationChannelId"
)175. AlertsNotificationChannelUpdateResponse¶
The response for updating a notification channel.
Available fields:
error: Error.notificationChannel: Notification channel.
class AlertsNotificationChannelUpdateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "notification_channel")
error = sgqlc.types.Field(
AlertsNotificationChannelUpdateError, graphql_name="error"
)
notification_channel = sgqlc.types.Field(
"AlertsNotificationChannelMutation", graphql_name="notificationChannel"
)176. AlertsNotificationChannelsAddToPolicyError¶
The error for associating notification channels with a policy.
Available fields:
description: Error description.errorType: Error type.notificationChannelId: Notification channel ID.
class AlertsNotificationChannelsAddToPolicyError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_type", "notification_channel_id")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
error_type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelsAddToPolicyErrorType),
graphql_name="errorType",
)
notification_channel_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="notificationChannelId"
)177. AlertsNotificationChannelsAddToPolicyResponse¶
The response for associating notification channels with a policy.
Available fields:
errors: Errors.notificationChannels: Notification channels.policyId: Policy ID.
class AlertsNotificationChannelsAddToPolicyResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "notification_channels", "policy_id")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AlertsNotificationChannelsAddToPolicyError)
)
),
graphql_name="errors",
)
notification_channels = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsNotificationChannelId))
),
graphql_name="notificationChannels",
)
policy_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="policyId")178. AlertsNotificationChannelsRemoveFromPolicyError¶
The error for dissociating notification channels from a policy.
Available fields:
description: Error description.errorType: Error type.notificationChannelId: Notification channel ID.
class AlertsNotificationChannelsRemoveFromPolicyError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "error_type", "notification_channel_id")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
error_type = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNotificationChannelsRemoveFromPolicyErrorType),
graphql_name="errorType",
)
notification_channel_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="notificationChannelId"
)179. AlertsNotificationChannelsRemoveFromPolicyResponse¶
The response for dissociating notification channels from a policy.
Available fields:
errors: Errors.notificationChannels: Notification channels.policyId: Policy ID.
class AlertsNotificationChannelsRemoveFromPolicyResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "notification_channels", "policy_id")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AlertsNotificationChannelsRemoveFromPolicyError)
)
),
graphql_name="errors",
)
notification_channels = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsNotificationChannelId))
),
graphql_name="notificationChannels",
)
policy_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="policyId")180. AlertsNotificationChannelsResultSet¶
A result set containing multiple notification channels and pagination info.
Available fields:
channels: A set of channels.nextCursor: Cursor pointing to the end of the current page of channels. Null if final page.totalCount: Total number of channels available.
class AlertsNotificationChannelsResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("channels", "next_cursor", "total_count")
channels = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsNotificationChannel))
),
graphql_name="channels",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)181. AlertsNrqlConditionExpiration¶
Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.
Available fields:
closeViolationsOnExpiration: Whether to close all open violations when the signal expires. Defaults to true.expirationDuration: The amount of time (in seconds) to wait before considering if the signal has been lost. Max value of 172800 (48 hours).ignoreOnExpectedTermination: Indicates whether an alert condition should ignore expected termination of a signal when considering whether to create a loss of signal incident. Defaults to false.openViolationOnExpiration: Whether to create a new “lost signal” violation to capture that the signal expired. Defaults to false.
class AlertsNrqlConditionExpiration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"close_violations_on_expiration",
"expiration_duration",
"ignore_on_expected_termination",
"open_violation_on_expiration",
)
close_violations_on_expiration = sgqlc.types.Field(
Boolean, graphql_name="closeViolationsOnExpiration"
)
expiration_duration = sgqlc.types.Field(Seconds, graphql_name="expirationDuration")
ignore_on_expected_termination = sgqlc.types.Field(
Boolean, graphql_name="ignoreOnExpectedTermination"
)
open_violation_on_expiration = sgqlc.types.Field(
Boolean, graphql_name="openViolationOnExpiration"
)182. AlertsNrqlConditionPrediction¶
Values used to generate the prediction for predictive alerting.
Available fields:
predictBy: The duration, in seconds, that the prediction should look into the future.preferPredictionViolation: If a prediction incident is open when a term’s static threshold is breached by the actual signal, default behavior is to close the prediction incident and open a static incident. SettingpreferPredictionViolationtotrueoverrides this behavior leaving the prediction incident open and preventing a static incident from opening.
class AlertsNrqlConditionPrediction(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("predict_by", "prefer_prediction_violation")
predict_by = sgqlc.types.Field(Seconds, graphql_name="predictBy")
prefer_prediction_violation = sgqlc.types.Field(
Boolean, graphql_name="preferPredictionViolation"
)183. AlertsNrqlConditionQuery¶
Information for generating the condition NRQL query. Output from the evaluated NRQL query will be compared to the condition terms to detect violations.
Available fields:
dataAccountId: The New Relic account ID to use as the basis for the NRQL alert condition’squery; will default to the condition’s account ID if unspecified.query: NRQL syntax that defines the query.
class AlertsNrqlConditionQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_account_id", "query")
data_account_id = sgqlc.types.Field(Int, graphql_name="dataAccountId")
query = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="query")184. AlertsNrqlConditionSignal¶
Configuration that defines the signal that the NRQL condition will use to evaluate.
Available fields:
aggregationDelay: How long we wait for data that belongs in each aggregation window. Depending on your data, a longer delay may increase accuracy but delay notifications.
Use aggregationDelay with the EVENT_FLOW and CADENCE methods. The maximum
delay is 1200 seconds (20 minutes) when using EVENT_FLOW and 3600 seconds
(60 minutes) when using CADENCE. In both cases, the minimum delay is 0 seconds
and the default is 120 seconds.
aggregationMethod: The method that determines when we consider an aggregation window to be complete so that we can evaluate the signal for violations. Default isEVENT_FLOW.aggregationTimer: How long we wait after each data point arrives to make sure we’ve processed the whole batch.
Use aggregationTimer with the EVENT_TIMER method. The timer value can range
from 5 seconds to 1200 seconds (20 minutes); the default is 60 seconds.
aggregationWindow: Aggregation window controls the duration of the time window used to evaluate the NRQL query, in seconds. The value must be at least 30 seconds, and no more than 15 minutes (900 seconds). Default is 60 seconds.evaluationDelay: How long we wait until the signal starts evaluating. The maximum delay is 7200 seconds (120 minutes).fillOption: Option that determines the type of value that should be used to fill gaps (empty windows). Defaults to STATIC.
Outlier NRQL conditions may only use NONE.
fillValue: If using the static fill option, this the value used for filling. Defaults to 0.pollingFrequency: The frequency at which the NRQL will be executed and the results will be evaluated, in seconds.
Polling cannot happen more frequently than 3600 seconds (1 hour), and must be specified in whole hour increments. Example: Frequency may be 3600 seconds (1 hour), but not 5400 seconds (1.5 hours).
Polling cannot happen less frequently than the duration of the warning term, critical term, or 24 hours, whichever is shortest. Example: If the warning term duration is 2 days and the critical term duration is 3 days, the polling must be no less frequent than once every 86400 seconds (24 hours). Example: If the warning term duration is 6 hours and the critical term duration is 12 hours, the polling must be no less frequent than once every 21600 seconds (6 hours).
Default polling frequency will be 3600 seconds (1 hour).
Only valid for NRQL conditions with CloudCost, KubernetesCost, or CloudCostEstimate event types. Conditions for these event types are evaluated in a polling fashion.
slideBy: This setting gathers data in overlapping time windows to smooth the chart line, making it easier to spot trends.
Not used for Outlier NRQL conditions.
class AlertsNrqlConditionSignal(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"aggregation_delay",
"aggregation_method",
"aggregation_timer",
"aggregation_window",
"evaluation_delay",
"fill_option",
"fill_value",
"polling_frequency",
"slide_by",
)
aggregation_delay = sgqlc.types.Field(Seconds, graphql_name="aggregationDelay")
aggregation_method = sgqlc.types.Field(
AlertsSignalAggregationMethod, graphql_name="aggregationMethod"
)
aggregation_timer = sgqlc.types.Field(Seconds, graphql_name="aggregationTimer")
aggregation_window = sgqlc.types.Field(Seconds, graphql_name="aggregationWindow")
evaluation_delay = sgqlc.types.Field(Seconds, graphql_name="evaluationDelay")
fill_option = sgqlc.types.Field(AlertsFillOption, graphql_name="fillOption")
fill_value = sgqlc.types.Field(Float, graphql_name="fillValue")
polling_frequency = sgqlc.types.Field(Seconds, graphql_name="pollingFrequency")
slide_by = sgqlc.types.Field(Seconds, graphql_name="slideBy")185. AlertsNrqlConditionsSearchResultSet¶
A collection of NRQL conditions with pagination information.
Available fields:
nextCursor: Cursor pointing to the end of the current page of NrqlCondition records. Null if final page.nrqlConditions: A set ofNrqlConditionsfor the supplied cursor and criteria.totalCount: Total number ofNrqlConditionsfor the given search criteria.
class AlertsNrqlConditionsSearchResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "nrql_conditions", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
nrql_conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsNrqlCondition))
),
graphql_name="nrqlConditions",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)186. AlertsOpsGenieNotificationChannelConfig¶
Configuration for OpsGenie notification channel.
Available fields:
apiKey: API key.dataCenterRegion: OpsGenie data center region.recipients: List of email recipients.tags: Tags.teams: Teams.
class AlertsOpsGenieNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key", "data_center_region", "recipients", "tags", "teams")
api_key = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="apiKey"
)
data_center_region = sgqlc.types.Field(
sgqlc.types.non_null(AlertsOpsGenieDataCenterRegion),
graphql_name="dataCenterRegion",
)
recipients = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="recipients"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="tags"
)
teams = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="teams"
)187. AlertsPagerDutyNotificationChannelConfig¶
Configuration for PagerDuty notification channel.
Available fields:
apiKey: API key.
class AlertsPagerDutyNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key",)
api_key = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="apiKey"
)188. AlertsPoliciesSearchResultSet¶
Collection of policies with pagination information.
Available fields:
nextCursor: Cursor pointing to the end of the current page of policy records. Null if final page.policies: Set of policies returned for the supplied cursor and criteria.totalCount: Total number of policy records for the given search criteria.
class AlertsPoliciesSearchResultSet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "policies", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
policies = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null("AlertsPolicy"))),
graphql_name="policies",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)189. AlertsPolicy¶
Container for conditions with associated notifications channels.
Available fields:
accountId: Account ID of the policy.id: Primary key for policies.incidentPreference: Determines how incidents are created for critical violations of the conditions contained in the policy.name: Description of the policy.
class AlertsPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "id", "incident_preference", "name")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
incident_preference = sgqlc.types.Field(
sgqlc.types.non_null(AlertsIncidentPreference),
graphql_name="incidentPreference",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")190. AlertsPolicyDeleteResponse¶
Success response when deleting an Alerts policy.
Available fields:
id: ID of the deleted policy.
class AlertsPolicyDeleteResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")191. AlertsSlackNotificationChannelConfig¶
Configuration for Slack notification channel.
Available fields:
teamChannel: Slack channel name.url: Slack channel URL.
class AlertsSlackNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("team_channel", "url")
team_channel = sgqlc.types.Field(String, graphql_name="teamChannel")
url = sgqlc.types.Field(sgqlc.types.non_null(SecureValue), graphql_name="url")192. AlertsUserNotificationChannelConfig¶
Configuration for user notification channel.
Available fields:
class AlertsUserNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()193. AlertsVictorOpsNotificationChannelConfig¶
Configuration for VictorOps notification channel.
Available fields:
key: Key.routeKey: Route key.
class AlertsVictorOpsNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "route_key")
key = sgqlc.types.Field(sgqlc.types.non_null(SecureValue), graphql_name="key")
route_key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="routeKey")194. AlertsWebhookBasicAuthInput¶
Webhook basic auth
Available fields:
password: Passwordusername: Username
class AlertsWebhookBasicAuthInput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("password", "username")
password = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="password"
)
username = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="username")195. AlertsWebhookCustomHeaderInput¶
Webhook header
Available fields:
name: Header namevalue: Header value
class AlertsWebhookCustomHeaderInput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(SecureValue), graphql_name="value")196. AlertsWebhookNotificationChannelConfig¶
Configuration for Webhook notification channel.
Available fields:
baseUrl: Base URL.basicAuth: Basic auth.customHttpHeaders: Custom HTTP headers.customPayloadBody: Custom payload body.customPayloadType: Custom payload type.
class AlertsWebhookNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"base_url",
"basic_auth",
"custom_http_headers",
"custom_payload_body",
"custom_payload_type",
)
base_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="baseUrl")
basic_auth = sgqlc.types.Field(
AlertsWebhookBasicAuthInput, graphql_name="basicAuth"
)
custom_http_headers = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AlertsWebhookCustomHeaderInput)),
graphql_name="customHttpHeaders",
)
custom_payload_body = sgqlc.types.Field(String, graphql_name="customPayloadBody")
custom_payload_type = sgqlc.types.Field(
AlertsWebhookCustomPayloadType, graphql_name="customPayloadType"
)197. AlertsXMattersNotificationChannelConfig¶
Configuration for xMatters notification channel.
Available fields:
integrationUrl: Integration URL.
class AlertsXMattersNotificationChannelConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("integration_url",)
integration_url = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="integrationUrl"
)198. ApiAccessActorStitchedFields¶
Available fields:
key: Fetch a single key by ID and type.keySearch: A list of keys scoped to the current actor and filter arguments. You can read more about managing keys on this documentation page.
class ApiAccessActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "key_search")
key = sgqlc.types.Field(
ApiAccessKey,
graphql_name="key",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"key_type",
sgqlc.types.Arg(
sgqlc.types.non_null(ApiAccessKeyType),
graphql_name="keyType",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The `id` of the key. This can be used to identify
a key without revealing the key itself (used to update and
delete).
* `key_type` (`ApiAccessKeyType!`): The type of key.
"""
key_search = sgqlc.types.Field(
"ApiAccessKeySearchResult",
graphql_name="keySearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"query",
sgqlc.types.Arg(
sgqlc.types.non_null(ApiAccessKeySearchQuery),
graphql_name="query",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): The cursor.
* `query` (`ApiAccessKeySearchQuery!`): The criteria for the key
search.
"""199. ApiAccessCreateKeyResponse¶
The response of the create keys mutation.
Available fields:
createdKeys: Lists all successfully created keys.errors: Lists all errors for keys that could not be created. Each error maps to a single key input.
class ApiAccessCreateKeyResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_keys", "errors")
created_keys = sgqlc.types.Field(
sgqlc.types.list_of(ApiAccessKey), graphql_name="createdKeys"
)
errors = sgqlc.types.Field(
sgqlc.types.list_of(ApiAccessKeyError), graphql_name="errors"
)200. ApiAccessDeleteKeyResponse¶
The response of the key delete mutation.
Available fields:
deletedKeys: Theids of the successfully deleted ingest keys and any errors that occurred when deleting keys.errors: Lists all errors for keys that could not be deleted. Each error maps to a single key input.
class ApiAccessDeleteKeyResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deleted_keys", "errors")
deleted_keys = sgqlc.types.Field(
sgqlc.types.list_of("ApiAccessDeletedKey"), graphql_name="deletedKeys"
)
errors = sgqlc.types.Field(
sgqlc.types.list_of(ApiAccessKeyError), graphql_name="errors"
)201. ApiAccessDeletedKey¶
The deleted key response of the key delete mutation.
Available fields:
id: Theidof the deleted key.
class ApiAccessDeletedKey(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(String, graphql_name="id")202. ApiAccessKeySearchResult¶
A list of all keys scoped to the current actor.
Available fields:
count: The total number of keys found in scope, irrespective of pagination.keys: A list of all keys scoped to the current actor.nextCursor: The next cursor, used for pagination. If a cursor is present, it means more keys can be fetched.
class ApiAccessKeySearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "keys", "next_cursor")
count = sgqlc.types.Field(Int, graphql_name="count")
keys = sgqlc.types.Field(sgqlc.types.list_of(ApiAccessKey), graphql_name="keys")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")203. ApiAccessUpdateKeyResponse¶
The response of the update keys mutation.
Available fields:
errors: Lists all errors for keys that could not be updated. Each error maps to a single key input.updatedKeys: Lists all successfully updated keys.
class ApiAccessUpdateKeyResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "updated_keys")
errors = sgqlc.types.Field(
sgqlc.types.list_of(ApiAccessKeyError), graphql_name="errors"
)
updated_keys = sgqlc.types.Field(
sgqlc.types.list_of(ApiAccessKey), graphql_name="updatedKeys"
)204. ApmApplicationDeployment¶
An APM application deployment marker
Available fields:
changelog: The changelog of the deploymentdescription: Description of the deploymentpermalink: A link to view the deployment in the UIrevision: The revision of the app that was deployedtimestamp: The moment the deployment occureduser: The user who triggered the deployment
class ApmApplicationDeployment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"changelog",
"description",
"permalink",
"revision",
"timestamp",
"user",
)
changelog = sgqlc.types.Field(String, graphql_name="changelog")
description = sgqlc.types.Field(String, graphql_name="description")
permalink = sgqlc.types.Field(String, graphql_name="permalink")
revision = sgqlc.types.Field(String, graphql_name="revision")
timestamp = sgqlc.types.Field(EpochMilliseconds, graphql_name="timestamp")
user = sgqlc.types.Field(String, graphql_name="user")205. ApmApplicationEntitySettingsResult¶
The updated settings of an ApmApplicationEntity.
Available fields:
entity: The updated entity. You can view the updated apdex target in thesettingsfield of an ApmApplicationEntity.
class ApmApplicationEntitySettingsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field("ApmApplicationEntity", graphql_name="entity")206. ApmApplicationRunningAgentVersions¶
Represents the currently running agent versions in an APM Application. An application could be running multiple versions of an agent (across different hosts, for example).
Available fields:
maxVersion: The maximum (newest) language agent version running in the APM Application.minVersion: The minimum (oldest) language agent version running in the APM Application.
class ApmApplicationRunningAgentVersions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("max_version", "min_version")
max_version = sgqlc.types.Field(String, graphql_name="maxVersion")
min_version = sgqlc.types.Field(String, graphql_name="minVersion")207. ApmApplicationSettings¶
Configuration settings for the APM Application
Available fields:
apdexTarget: The current Apdex target settingserverSideConfig: State of server-side configuration setting
class ApmApplicationSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("apdex_target", "server_side_config")
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")
server_side_config = sgqlc.types.Field(Boolean, graphql_name="serverSideConfig")208. ApmApplicationSummaryData¶
Summary statistics about the APM App.
Available fields:
apdexScore: The apdex score. For more details on the use of apdex, visit our docs.errorRate: The percentage of responses to all transactions with an error.hostCount: The number of hosts this application is running on.instanceCount: The number of instances of this application running.nonWebResponseTimeAverage: The average response time for non-web transactions in seconds.nonWebThroughput: The number of non-web transactions per minute.responseTimeAverage: The average response time for all transactions in seconds.throughput: The number of all transactions per minute.webResponseTimeAverage: The average response time for web transactions in seconds.webThroughput: The number of web transactions per minute.
class ApmApplicationSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"apdex_score",
"error_rate",
"host_count",
"instance_count",
"non_web_response_time_average",
"non_web_throughput",
"response_time_average",
"throughput",
"web_response_time_average",
"web_throughput",
)
apdex_score = sgqlc.types.Field(Float, graphql_name="apdexScore")
error_rate = sgqlc.types.Field(Float, graphql_name="errorRate")
host_count = sgqlc.types.Field(Int, graphql_name="hostCount")
instance_count = sgqlc.types.Field(Int, graphql_name="instanceCount")
non_web_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="nonWebResponseTimeAverage"
)
non_web_throughput = sgqlc.types.Field(Float, graphql_name="nonWebThroughput")
response_time_average = sgqlc.types.Field(
Seconds, graphql_name="responseTimeAverage"
)
throughput = sgqlc.types.Field(Float, graphql_name="throughput")
web_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="webResponseTimeAverage"
)
web_throughput = sgqlc.types.Field(Float, graphql_name="webThroughput")209. ApmBrowserApplicationSummaryData¶
Summary statistics about the Browser App injected by the APM Application.
Available fields:
ajaxRequestThroughput: The number of AJAX requests per minuteajaxResponseTimeAverage: The average AJAX response time in seconds.jsErrorRate: The percentage of page views with a JS error.pageLoadThroughput: The number of page loads per minutepageLoadTimeAverage: The average page view time in seconds.
class ApmBrowserApplicationSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"ajax_request_throughput",
"ajax_response_time_average",
"js_error_rate",
"page_load_throughput",
"page_load_time_average",
)
ajax_request_throughput = sgqlc.types.Field(
Float, graphql_name="ajaxRequestThroughput"
)
ajax_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="ajaxResponseTimeAverage"
)
js_error_rate = sgqlc.types.Field(Float, graphql_name="jsErrorRate")
page_load_throughput = sgqlc.types.Field(Float, graphql_name="pageLoadThroughput")
page_load_time_average = sgqlc.types.Field(
Float, graphql_name="pageLoadTimeAverage"
)210. ApmExternalServiceSummaryData¶
Summary statistics about an External Service called by an APM App.
Available fields:
responseTimeAverage: The average response time for external service calls in seconds.throughput: The number of external service calls per minute.
class ApmExternalServiceSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("response_time_average", "throughput")
response_time_average = sgqlc.types.Field(
Seconds, graphql_name="responseTimeAverage"
)
throughput = sgqlc.types.Field(Float, graphql_name="throughput")211. AuthenticationDomainType¶
An authentication domain
Available fields:
id: The id of the authentication domain
class AuthenticationDomainType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")212. AuthorizationManagementAccessGrant¶
An Access Grant defines the access a group has to an entity
Available fields:
id: a value that uniquely identifies this object
class AuthorizationManagementAccessGrant(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")213. AuthorizationManagementAuthenticationDomain¶
An “authentication domain” is a grouping of New Relic users governed by the same user management settings, like how they’re provisioned (added and updated), how they’re authenticated (logged in), session settings, and how user upgrades are managed.
Available fields:
groups: container for groups enabling cursor based paginationid: a value that uniquely identifies this objectname: the name of the object
class AuthorizationManagementAuthenticationDomain(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups", "id", "name")
groups = sgqlc.types.Field(
sgqlc.types.non_null("AuthorizationManagementGroupSearch"),
graphql_name="groups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): an optional list of ids to filter by
"""
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")214. AuthorizationManagementAuthenticationDomainSearch¶
container for authentication domains enabling cursor based pagination
Available fields:
authenticationDomains: containers of users and groupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class AuthorizationManagementAuthenticationDomainSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domains", "next_cursor", "total_count")
authentication_domains = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AuthorizationManagementAuthenticationDomain)
)
),
graphql_name="authenticationDomains",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)215. AuthorizationManagementDataAccessPolicy¶
A Data Access Policy defines what data is allowed
Available fields:
id: a value that uniquely identifies this object
class AuthorizationManagementDataAccessPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")216. AuthorizationManagementGrant¶
An access grant defines the access given to a group or user.
Available fields:
dataAccessPolicy: the data access policy that defines the data access for this grantid: a value that uniquely identifies this object
class AuthorizationManagementGrant(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_access_policy", "id")
data_access_policy = sgqlc.types.Field(
AuthorizationManagementDataAccessPolicy, graphql_name="dataAccessPolicy"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")217. AuthorizationManagementGrantAccessPayload¶
Autogenerated return type of GrantAccess.
Available fields:
accessGrants: the access grants that were createdroles: the roles that were granted to this group
class AuthorizationManagementGrantAccessPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("access_grants", "roles")
access_grants = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AuthorizationManagementAccessGrant)
)
),
graphql_name="accessGrants",
)
roles = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("AuthorizationManagementGrantedRole")
)
),
graphql_name="roles",
)218. AuthorizationManagementGrantedRole¶
A Granted Role represents the access given to a group.
Available fields:
accountId: the account that this role grants access todataAccessPolicyId: the data access policy that defines the data accessdisplayName: the name of the objectgroupId: the group that this role grants access toid: a value that uniquely identifies this objectname: the name of the objectorganizationId: the organization this role grants access toroleId: the role that defines this accesstype: the type of the role
class AuthorizationManagementGrantedRole(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"data_access_policy_id",
"display_name",
"group_id",
"id",
"name",
"organization_id",
"role_id",
"type",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
data_access_policy_id = sgqlc.types.Field(ID, graphql_name="dataAccessPolicyId")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
group_id = sgqlc.types.Field(ID, graphql_name="groupId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
role_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="roleId")
type = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="type")219. AuthorizationManagementGrantedRoleSearch¶
container for roles enabling cursor based pagination
Available fields:
nextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagesroles: the roles granted to this grouptotalCount: the total number of results
class AuthorizationManagementGrantedRoleSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "roles", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
roles = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AuthorizationManagementGrantedRole)
)
),
graphql_name="roles",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)220. AuthorizationManagementGroup¶
For users on our New Relic One user model, a “group” represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this objectroles: container for roles enabling cursor based pagination
class AuthorizationManagementGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id", "roles")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
roles = sgqlc.types.Field(
sgqlc.types.non_null(AuthorizationManagementGrantedRoleSearch),
graphql_name="roles",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
(
"role_id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="roleId",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): a list of ids to filter returned objects by
* `role_id` (`[ID!]`): a list of ids to filter returned objects by
"""221. AuthorizationManagementGroupSearch¶
container for groups enabling cursor based pagination
Available fields:
groups: contains roles granted to users’s groupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class AuthorizationManagementGroupSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups", "next_cursor", "total_count")
groups = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AuthorizationManagementGroup))
),
graphql_name="groups",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)222. AuthorizationManagementOrganizationStitchedFields¶
Available fields:
authenticationDomains: list of authentication domainsroles: list of roles
class AuthorizationManagementOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domains", "roles")
authentication_domains = sgqlc.types.Field(
AuthorizationManagementAuthenticationDomainSearch,
graphql_name="authenticationDomains",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): an optional list of ids to filter by
"""
roles = sgqlc.types.Field(
"AuthorizationManagementRoleSearch",
graphql_name="roles",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): an optional list of ids to filter by
"""223. AuthorizationManagementRevokeAccessPayload¶
Autogenerated return type of RevokeAccess.
Available fields:
accessGrants: the access grants that were revokedroles: the roles that were revoked from this group
class AuthorizationManagementRevokeAccessPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("access_grants", "roles")
access_grants = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AuthorizationManagementAccessGrant)
)
),
graphql_name="accessGrants",
)
roles = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AuthorizationManagementGrantedRole)
)
),
graphql_name="roles",
)224. AuthorizationManagementRole¶
a role grants access on an account or organization to groups of users
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this objectname: the name of the objectscope: the scope of the roletype: the type of the role
class AuthorizationManagementRole(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id", "name", "scope", "type")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="scope")
type = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="type")225. AuthorizationManagementRoleSearch¶
container for roles enabling cursor based pagination
Available fields:
nextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagesroles: control the access granted to groupstotalCount: the total number of results
class AuthorizationManagementRoleSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "roles", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
roles = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AuthorizationManagementRole))
),
graphql_name="roles",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)226. AuthorizationManagementUpdateAccessPayload¶
Autogenerated return type of UpdateAccess.
Available fields:
grants: The updated access grants
class AuthorizationManagementUpdateAccessPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("grants",)
grants = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(AuthorizationManagementGrant))
),
graphql_name="grants",
)227. BrowserApplicationRunningAgentVersions¶
Represents the currently running agent versions in a Browser App. An app could be running multiple versions of an agent (across different browsers, for example).
Available fields:
maxSemanticVersion: The maximum (newest) agent version running in the Browser App, represented as a semantic version string.maxVersion: The maximum (newest) agent version running in the Browser App.minSemanticVersion: The minimum (oldest) agent version running in the Browser App, represented as a semantic version string.minVersion: The minimum (oldest) agent version running in the Browser App.
class BrowserApplicationRunningAgentVersions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"max_semantic_version",
"max_version",
"min_semantic_version",
"min_version",
)
max_semantic_version = sgqlc.types.Field(SemVer, graphql_name="maxSemanticVersion")
max_version = sgqlc.types.Field(Int, graphql_name="maxVersion")
min_semantic_version = sgqlc.types.Field(SemVer, graphql_name="minSemanticVersion")
min_version = sgqlc.types.Field(Int, graphql_name="minVersion")228. BrowserApplicationSettings¶
Configuration settings for the Browser App
Available fields:
apdexTarget: The current Apdex target setting
class BrowserApplicationSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("apdex_target",)
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")229. BrowserApplicationSummaryData¶
Summary statistics about the Browser App.
Available fields:
ajaxRequestThroughput: The number of AJAX requests per minuteajaxResponseTimeAverage: The average AJAX response time in seconds.jsErrorRate: The percentage of page views with a JS error.pageLoadThroughput: The number of page loads per minutepageLoadTimeAverage: The average page view time in seconds.pageLoadTimeMedian: The median page view time in seconds.spaResponseTimeAverage: The average SPA response time in seconds.spaResponseTimeMedian: The median SPA response time in seconds.
class BrowserApplicationSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"ajax_request_throughput",
"ajax_response_time_average",
"js_error_rate",
"page_load_throughput",
"page_load_time_average",
"page_load_time_median",
"spa_response_time_average",
"spa_response_time_median",
)
ajax_request_throughput = sgqlc.types.Field(
Float, graphql_name="ajaxRequestThroughput"
)
ajax_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="ajaxResponseTimeAverage"
)
js_error_rate = sgqlc.types.Field(Float, graphql_name="jsErrorRate")
page_load_throughput = sgqlc.types.Field(Float, graphql_name="pageLoadThroughput")
page_load_time_average = sgqlc.types.Field(
Float, graphql_name="pageLoadTimeAverage"
)
page_load_time_median = sgqlc.types.Field(Float, graphql_name="pageLoadTimeMedian")
spa_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="spaResponseTimeAverage"
)
spa_response_time_median = sgqlc.types.Field(
Seconds, graphql_name="spaResponseTimeMedian"
)230. ChangeTrackingActorStitchedFields¶
Available fields:
changeTrackingSearch: Coming soon! If you’d like to sign up to receive access to our Public Preview, you can sign up under Administration -> Previews & Trial.
US, AMEA, LATAM: Sign Up Here EU: Sign Up Here
Search for change tracking event(s) across all authorized accounts. Ordered by timestamp DESC.
class ChangeTrackingActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("change_tracking_search",)
change_tracking_search = sgqlc.types.Field(
"ChangeTrackingChangeTrackingSearchResult",
graphql_name="changeTrackingSearch",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
ChangeTrackingChangeTrackingSearchFilter,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `filter` (`ChangeTrackingChangeTrackingSearchFilter`): Contains
the set of filters to apply to the query.
"""231. ChangeTrackingChangeTrackingSearchResult¶
The result of the change tracking search query.
Available fields:
changeEvents: The list of change tracking events in the given time window.
class ChangeTrackingChangeTrackingSearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("change_events",)
change_events = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(ChangeTrackingEvent)),
graphql_name="changeEvents",
)232. ChangeTrackingCreateEventResponse¶
The response for creating a ChangeTrackingEvent.
Available fields:
changeTrackingEvent: The change tracking event that was created.messages: Any related messages associated with creation of the change tracking event. Track these to see if there are details to consider for future calls to this mutation.
class ChangeTrackingCreateEventResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("change_tracking_event", "messages")
change_tracking_event = sgqlc.types.Field(
ChangeTrackingEvent, graphql_name="changeTrackingEvent"
)
messages = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="messages"
)233. ChangeTrackingDeployment¶
A deployment.
Available fields:
changelog: A URL to the changelog or, if not linkable, a list of changes.commit: The commit identifier, for example, a Git commit SHA.deepLink: A link to the system that generated the deployment.deploymentId: A unique deployment identifier.deploymentType: The type of deployment, for example, ‘Blue green’ or ‘Rolling’.description: A description of the deployment.entityGuid: The NR entity that was deployed.groupId: An identifier used to correlate account-wide changes across entities. These changes are shown together in theChanges in groupsection of the change event details UI.timestamp: The start time of the deployment as the number of milliseconds since the Unix epoch.user: The username of the deployer or bot.version: The version of the deployed software, for example, something like v1.1.
class ChangeTrackingDeployment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"changelog",
"commit",
"deep_link",
"deployment_id",
"deployment_type",
"description",
"entity_guid",
"group_id",
"timestamp",
"user",
"version",
)
changelog = sgqlc.types.Field(String, graphql_name="changelog")
commit = sgqlc.types.Field(String, graphql_name="commit")
deep_link = sgqlc.types.Field(String, graphql_name="deepLink")
deployment_id = sgqlc.types.Field(String, graphql_name="deploymentId")
deployment_type = sgqlc.types.Field(
ChangeTrackingDeploymentType, graphql_name="deploymentType"
)
description = sgqlc.types.Field(String, graphql_name="description")
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
group_id = sgqlc.types.Field(String, graphql_name="groupId")
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
user = sgqlc.types.Field(String, graphql_name="user")
version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="version")234. ChangeTrackingDeploymentSearchResult¶
The result of the deployment search query.
Available fields:
results: The list of deployment events in the given time window.
class ChangeTrackingDeploymentSearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("results",)
results = sgqlc.types.Field(
sgqlc.types.list_of(ChangeTrackingDeployment), graphql_name="results"
)235. CloudAccountFields¶
Cloud integrations related data, including configured integrations and all available cloud provider service integrations.
Available fields:
linkedAccount: Get one linked provider account.linkedAccounts: Get all linked cloud provider accounts.ociCompartmentInstrumentationDetails: OCI ProviderociLogGroupInstrumentationDetails: OCI ProviderociTenancyDetails: OCI Providerprovider: Get one cloud provider by short name.providers: Get all available cloud providers.
class CloudAccountFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"linked_account",
"linked_accounts",
"oci_compartment_instrumentation_details",
"oci_log_group_instrumentation_details",
"oci_tenancy_details",
"provider",
"providers",
)
linked_account = sgqlc.types.Field(
"CloudLinkedAccount",
graphql_name="linkedAccount",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(Int, graphql_name="id", default=None)),)
),
)
"""Arguments:
* `id` (`Int`): The linked cloud provider account's ID.
"""
linked_accounts = sgqlc.types.Field(
sgqlc.types.list_of("CloudLinkedAccount"), graphql_name="linkedAccounts"
)
oci_compartment_instrumentation_details = sgqlc.types.Field(
sgqlc.types.list_of("CloudOciCompartmentInstrumentationDetails"),
graphql_name="ociCompartmentInstrumentationDetails",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"linked_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="linkedAccountId",
default=None,
),
),
(
"oci_region",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociRegion",
default=None,
),
),
(
"oci_tenant_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociTenantId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID.
* `linked_account_id` (`Int!`): The linked account identifier.
* `oci_region` (`String!`): The OCI compartment region.
* `oci_tenant_id` (`String!`): The OCI tenant identifier.
"""
oci_log_group_instrumentation_details = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("CloudOciLogGroupInstrumentationDetails")
),
graphql_name="ociLogGroupInstrumentationDetails",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"linked_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="linkedAccountId",
default=None,
),
),
(
"oci_region",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociRegion",
default=None,
),
),
(
"oci_tenant_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociTenantId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `linked_account_id` (`Int!`): The linked account identifier.
* `oci_region` (`String!`): The OCI log group region.
* `oci_tenant_id` (`String!`): The OCI tenant identifier.
"""
oci_tenancy_details = sgqlc.types.Field(
"CloudOciTenancyDetails",
graphql_name="ociTenancyDetails",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"linked_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="linkedAccountId",
default=None,
),
),
(
"oci_home_region",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociHomeRegion",
default=None,
),
),
(
"oci_tenant_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociTenantId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID.
* `linked_account_id` (`Int!`): The linked account identifier.
* `oci_home_region` (`String!`): The home region of the OCI
tenant.
* `oci_tenant_id` (`String!`): The OCI tenant identifier.
"""
provider = sgqlc.types.Field(
CloudProvider,
graphql_name="provider",
args=sgqlc.types.ArgDict(
(("slug", sgqlc.types.Arg(String, graphql_name="slug", default=None)),)
),
)
"""Arguments:
* `slug` (`String`): The cloud provider short name. Values
include `aws`, `gcp`, foobar?
"""
providers = sgqlc.types.Field(
sgqlc.types.list_of(CloudProvider), graphql_name="providers"
)236. CloudAccountMutationError¶
Account Mutation Error
Available fields:
linkedAccountId: The passed linked account identifier.message: The error message.nrAccountId: The passed newrelic account identifier.providerSlug: The passed provider slug.type: The error status.
class CloudAccountMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"linked_account_id",
"message",
"nr_account_id",
"provider_slug",
"type",
)
linked_account_id = sgqlc.types.Field(Int, graphql_name="linkedAccountId")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
provider_slug = sgqlc.types.Field(String, graphql_name="providerSlug")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")237. CloudActorFields¶
Available fields:
linkedAccounts: Get all linked cloud provider accounts scoped to the Actor.
class CloudActorFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("linked_accounts",)
linked_accounts = sgqlc.types.Field(
sgqlc.types.list_of("CloudLinkedAccount"),
graphql_name="linkedAccounts",
args=sgqlc.types.ArgDict(
(
(
"provider",
sgqlc.types.Arg(String, graphql_name="provider", default=None),
),
)
),
)
"""Arguments:
* `provider` (`String`): The cloud provider short name.
"""238. CloudConfigureIntegrationPayload¶
Autogenerated return type of ConfigureIntegration
Available fields:
errors: The list of errors.integrations: The created/modified service integrations.
class CloudConfigureIntegrationPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "integrations")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("CloudIntegrationMutationError"))
),
graphql_name="errors",
)
integrations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudIntegration))
),
graphql_name="integrations",
)239. CloudCostIntelligenceAwsConfig¶
AWS-specific configuration
Available fields:
class CloudCostIntelligenceAwsConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()240. CloudCostIntelligenceAzureConfig¶
Azure-specific configuration
Available fields:
class CloudCostIntelligenceAzureConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()241. CloudCostIntelligenceGcpConfig¶
GCP-specific configuration
Available fields:
class CloudCostIntelligenceGcpConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()242. CloudCostIntelligenceIntegrationResponse¶
Integration response with common fields and provider-specific configuration
Available fields:
class CloudCostIntelligenceIntegrationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()243. CloudCostIntelligenceIssueDetail¶
Issue detail with message and resolution guidance
Available fields:
class CloudCostIntelligenceIssueDetail(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()244. CloudCostIntelligenceMetadata¶
Metadata for integration timestamps
Available fields:
class CloudCostIntelligenceMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()245. CloudCostIntelligenceScopeResponse¶
Scope information for integrations
Available fields:
class CloudCostIntelligenceScopeResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()246. CloudDashboardTemplate¶
A cloud service dashboard template.
Available fields:
createdAt: The object creation date, in epoch (Unix) timelayout: The dashboard layout position.name: The dashboard template name.slug: The dashboard template slug.updatedAt: The object last update date, in epoch (Unix) time
class CloudDashboardTemplate(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "layout", "name", "slug", "updated_at")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="createdAt"
)
layout = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="layout")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
slug = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="slug")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="updatedAt"
)247. CloudDisableIntegrationPayload¶
Autogenerated return type of DisableIntegration
Available fields:
disabledIntegrations: The list of disabled cloud service integrations.errors: The list of errors.
class CloudDisableIntegrationPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("disabled_integrations", "errors")
disabled_integrations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudIntegration))
),
graphql_name="disabledIntegrations",
)
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("CloudIntegrationMutationError"))
),
graphql_name="errors",
)248. CloudIntegrationMutationError¶
Integration Mutation Error
Available fields:
integrationSlug: The passed integration slug.linkedAccountId: The passed linked account identifier.message: The error message.nrAccountId: The passed newrelic account identifier.type: The error status.
class CloudIntegrationMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"integration_slug",
"linked_account_id",
"message",
"nr_account_id",
"type",
)
integration_slug = sgqlc.types.Field(String, graphql_name="integrationSlug")
linked_account_id = sgqlc.types.Field(Int, graphql_name="linkedAccountId")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")249. CloudLinkAccountPayload¶
Autogenerated return type of LinkAccount
Available fields:
errors: The list of errors.linkedAccounts: The created Linked accounts.
class CloudLinkAccountPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "linked_accounts")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudAccountMutationError))
),
graphql_name="errors",
)
linked_accounts = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("CloudLinkedAccount"))
),
graphql_name="linkedAccounts",
)250. CloudLinkedAccount¶
A cloud account linked to a NewRelic account.
Available fields:
authLabel: The credential. This is a Role ARN for AWS, an application ID for Azure and a service account ID or user account email for GCP.createdAt: The object creation date, in epoch (Unix) timedisabled: Indicates whether the account disabled.externalId: The cloud account identifier. This is the Account ID in AWS, the Subscription ID in Azure and the Project ID in GCP.id: The linked account identifier in NewRelic.integration: Get details of one cloud service integration.integrations: Get details of all cloud service integrations.metricCollectionMode: Indicate how the metrics will be collected (PUSH/PULL)name: The linked account name in NewRelic.nrAccountId: The New Relic account identifier.provider: The cloud provider.updatedAt: The object last update date, in epoch (Unix) time
class CloudLinkedAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"auth_label",
"created_at",
"disabled",
"external_id",
"id",
"integration",
"integrations",
"metric_collection_mode",
"name",
"nr_account_id",
"provider",
"updated_at",
)
auth_label = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="authLabel"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="createdAt"
)
disabled = sgqlc.types.Field(Boolean, graphql_name="disabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
integration = sgqlc.types.Field(
sgqlc.types.non_null(CloudIntegration),
graphql_name="integration",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`Int!`): The cloud service integration identifier.
"""
integrations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudIntegration))
),
graphql_name="integrations",
args=sgqlc.types.ArgDict(
(
(
"service",
sgqlc.types.Arg(String, graphql_name="service", default=None),
),
)
),
)
"""Arguments:
* `service` (`String`): The cloud integration service slug.
"""
metric_collection_mode = sgqlc.types.Field(
sgqlc.types.non_null(CloudMetricCollectionMode),
graphql_name="metricCollectionMode",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
provider = sgqlc.types.Field(
sgqlc.types.non_null(CloudProvider), graphql_name="provider"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="updatedAt"
)251. CloudLogGroupInstrumentationStatus¶
Instrumentation status for a log group.
Available fields:
id: The log group OCID.instrumented: Whether the log group is instrumented.logGroup: The namespace name.
class CloudLogGroupInstrumentationStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "instrumented", "log_group")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
instrumented = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="instrumented"
)
log_group = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="logGroup")252. CloudMigrateAwsGovCloudToAssumeRolePayload¶
Autogenerated return type of MigrateAwsGovCloudToAssumeRole
Available fields:
errors: The list of errors.linkedAccounts: The updated linked accounts.
class CloudMigrateAwsGovCloudToAssumeRolePayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "linked_accounts")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudAccountMutationError))
),
graphql_name="errors",
)
linked_accounts = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudLinkedAccount))
),
graphql_name="linkedAccounts",
)253. CloudNamespaceInstrumentationStatus¶
Instrumentation status for a namespace.
Available fields:
instrumented: Whether the namespace is instrumented.namespace: The namespace name.
class CloudNamespaceInstrumentationStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("instrumented", "namespace")
instrumented = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="instrumented"
)
namespace = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="namespace"
)254. CloudOciCompartmentInstrumentationDetails¶
Compartment instrumentation details object.
Available fields:
id: The OCID of the compartment.instrumentedNamespace: The number of instrumented namespaces.name: The name of the compartment.namespaceInstrumentationStatuses: The instrumentation status for each namespace.nonInstrumentedNamespace: The number of non-instrumented namespaces.ociHomeRegion: The home region of the compartment.totalActiveNamespaceCount: The total number of active namespaces.
class CloudOciCompartmentInstrumentationDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"id",
"instrumented_namespace",
"name",
"namespace_instrumentation_statuses",
"non_instrumented_namespace",
"oci_home_region",
"total_active_namespace_count",
)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
instrumented_namespace = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="instrumentedNamespace"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
namespace_instrumentation_statuses = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(CloudNamespaceInstrumentationStatus)
)
),
graphql_name="namespaceInstrumentationStatuses",
)
non_instrumented_namespace = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nonInstrumentedNamespace"
)
oci_home_region = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="ociHomeRegion"
)
total_active_namespace_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalActiveNamespaceCount"
)255. CloudOciInstrumentedPayloadUrlPayload¶
Response payload for OCI instrumented payload URL generation.
Available fields:
nrAccountId: The NewRelic account identifier.s3Url: The s3 pre signed url having uploaded payload.tfZipUrl: The terraform zip file url which will be used for oci stack creation.
class CloudOciInstrumentedPayloadUrlPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nr_account_id", "s3_url", "tf_zip_url")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
s3_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="s3Url")
tf_zip_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="tfZipUrl"
)256. CloudOciLogGroupInstrumentationDetails¶
Compartment Log Group instrumentation details object.
Available fields:
id: The OCID of the compartment.instrumentedLogGroup: The number of instrumented log groups.logGroupInstrumentationStatuses: The instrumentation status for each namespace.name: The name of the compartment.nonInstrumentedLogGroup: The number of non-instrumented log groups.ociHomeRegion: The home region of the compartment.totalActiveLogGroupCount: The total number of active log groups.
class CloudOciLogGroupInstrumentationDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"id",
"instrumented_log_group",
"log_group_instrumentation_statuses",
"name",
"non_instrumented_log_group",
"oci_home_region",
"total_active_log_group_count",
)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
instrumented_log_group = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="instrumentedLogGroup"
)
log_group_instrumentation_statuses = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(CloudLogGroupInstrumentationStatus)
)
),
graphql_name="logGroupInstrumentationStatuses",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
non_instrumented_log_group = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nonInstrumentedLogGroup"
)
oci_home_region = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="ociHomeRegion"
)
total_active_log_group_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalActiveLogGroupCount"
)257. CloudOciLogGroupInstrumentedPayloadUrlPayload¶
Response payload for OCI Log Group instrumented payload URL generation.
Available fields:
nrAccountId: The NewRelic account identifier.s3Url: The s3 pre signed url having uploaded payload.tfZipUrl: The terraform zip file url which will be used for oci stack creation.
class CloudOciLogGroupInstrumentedPayloadUrlPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nr_account_id", "s3_url", "tf_zip_url")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
s3_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="s3Url")
tf_zip_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="tfZipUrl"
)258. CloudOciTenancyDetails¶
Tenancy details object.
Available fields:
id: The OCID of the tenancy.linkedAccountId: The linked account identifier.name: The name of the tenancy.nrAccountId: The parent NewRelic account identifier.ociHomeRegion: The home region of the tenancy.subscribedRegions: The list of subscribed regions.
class CloudOciTenancyDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"id",
"linked_account_id",
"name",
"nr_account_id",
"oci_home_region",
"subscribed_regions",
)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
linked_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="linkedAccountId"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nr_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="nrAccountId"
)
oci_home_region = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="ociHomeRegion"
)
subscribed_regions = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="subscribedRegions",
)259. CloudRenameAccountPayload¶
Autogenerated return type of RenameAccount
Available fields:
errors: The list of errors.linkedAccounts: The updated linked accounts.
class CloudRenameAccountPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "linked_accounts")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudAccountMutationError))
),
graphql_name="errors",
)
linked_accounts = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudLinkedAccount))
),
graphql_name="linkedAccounts",
)260. CloudService¶
A Cloud Provider service available for monitoring.
Available fields:
createdAt: The object creation date, in epoch (Unix) timedashboards: The cloud service dashboard templates.icon: The cloud service icon name.id: The cloud service identifier in NewRelic.isEnabled: Shows if the cloud service is enabled for integrating.name: The cloud service name.provider: The cloud provider.slug: The cloud service unique short name.updatedAt: The object last update date, in epoch (Unix) time
class CloudService(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"dashboards",
"icon",
"id",
"is_enabled",
"name",
"provider",
"slug",
"updated_at",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="createdAt"
)
dashboards = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudDashboardTemplate))
),
graphql_name="dashboards",
)
icon = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="icon")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
is_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isEnabled"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
provider = sgqlc.types.Field(
sgqlc.types.non_null(CloudProvider), graphql_name="provider"
)
slug = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="slug")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="updatedAt"
)261. CloudTemplateParam¶
Provider template form params
Available fields:
autocomplete: The provider template param autocomplete.immutable: The provider template param immutable.label: The provider template param label.name: The provider template param name.placeholder: The provider template param placeholder.type: The provider template param type.
class CloudTemplateParam(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"autocomplete",
"immutable",
"label",
"name",
"placeholder",
"type",
)
autocomplete = sgqlc.types.Field(String, graphql_name="autocomplete")
immutable = sgqlc.types.Field(Boolean, graphql_name="immutable")
label = sgqlc.types.Field(String, graphql_name="label")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
placeholder = sgqlc.types.Field(String, graphql_name="placeholder")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")262. CloudUnlinkAccountPayload¶
Autogenerated return type of UnlinkAccount
Available fields:
errors: The list of errors.unlinkedAccounts: The unlinked accounts.
class CloudUnlinkAccountPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "unlinked_accounts")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudAccountMutationError))
),
graphql_name="errors",
)
unlinked_accounts = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudLinkedAccount))
),
graphql_name="unlinkedAccounts",
)263. CloudUpdateAccountPayload¶
Autogenerated return type of UpdateAccount
Available fields:
linkedAccounts: The updated Linked accounts.
class CloudUpdateAccountPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("linked_accounts",)
linked_accounts = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(CloudLinkedAccount))
),
graphql_name="linkedAccounts",
)264. CollaborationActorStitchedFields¶
Available fields:
botResponsesByIds: Get BotResponses by idscodeMarksByIds: Get codeMarks by idscommentById: Find a single comment by IDcommentsByIds: Find multiple comments by comment IDscommentsByThreadId: Find multiple comments by a single thread IDcommentsByThreadIds: Find multiple comments by multiple thread IDscontextById: Retrive a context by IDcontextsByEntityGuid: Retrieve multiple contexts by multiple entity GUIDscontextsByIds: Retrieve multiple contexts by multiple IDsemailByAddress: Get email by addressemailById: Get an email by the email IDemailsByIds: Get multiple emails with a list of email IDsexternalServiceConnectionById: Get external service connection by IDfileById: Get file by idgrokMessagesByIds: Find multiple Grok messages by idsmentionById: Look a single mention by IDmentionsByIds: Look up multiple mentions by IDsearchThreadsSimple: Search threads by a query term.subscriberById: Get a single subscriber by IDsubscribersByThreadId: Get the subscribers for a given threadsubscribersByUserId: Get all subscriptions for a given usersubscriptions: Get my subscriptionssubscriptionsUnread: Get my unread subscriptions for a given contextthreadById: Fetch a thread by IDthreadsAll: Get all threads for your organizationthreadsByContextId: Get threads for a given contextthreadsByContextIds: Get threads for multiple contextsthreadsByIds: Get multiple threads from a list of IDsthreadsCountByContextId: Fetch threads count per status by context idwebSocketConnectUrl: Returns a URL and connection ID for socket connections
class CollaborationActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"bot_responses_by_ids",
"code_marks_by_ids",
"comment_by_id",
"comments_by_ids",
"comments_by_thread_id",
"comments_by_thread_ids",
"context_by_id",
"contexts_by_entity_guid",
"contexts_by_ids",
"email_by_address",
"email_by_id",
"emails_by_ids",
"external_service_connection_by_id",
"file_by_id",
"grok_messages_by_ids",
"mention_by_id",
"mentions_by_ids",
"search_threads_simple",
"subscriber_by_id",
"subscribers_by_thread_id",
"subscribers_by_user_id",
"subscriptions",
"subscriptions_unread",
"thread_by_id",
"threads_all",
"threads_by_context_id",
"threads_by_context_ids",
"threads_by_ids",
"threads_count_by_context_id",
"web_socket_connect_url",
)
bot_responses_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationBotResponse"),
graphql_name="botResponsesByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): BotResponse IDs
"""
code_marks_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationCodeMark"),
graphql_name="codeMarksByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): File id
"""
comment_by_id = sgqlc.types.Field(
"CollaborationComment",
graphql_name="commentById",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
comments_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationComment"),
graphql_name="commentsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of comment IDs
"""
comments_by_thread_id = sgqlc.types.Field(
"CollaborationCommentConnection",
graphql_name="commentsByThreadId",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `thread_id` (`ID!`): Thread ID
"""
comments_by_thread_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationCommentConnection"),
graphql_name="commentsByThreadIds",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"thread_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="threadIds",
default=None,
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `thread_ids` (`[ID]!`): Array of thread IDs
"""
context_by_id = sgqlc.types.Field(
"CollaborationContext",
graphql_name="contextById",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
contexts_by_entity_guid = sgqlc.types.Field(
"CollaborationLinkedContexts",
graphql_name="contextsByEntityGuid",
args=sgqlc.types.ArgDict(
(
(
"entity_guid",
sgqlc.types.Arg(
EntityGuid, graphql_name="entityGuid", default=None
),
),
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
)
),
)
"""Arguments:
* `entity_guid` (`EntityGuid`): Array of entity Guid
* `first` (`Int`): How many in the page - max 50 (default: `10`)
* `next_cursor` (`String`): Pagination Cursor
"""
contexts_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationContext"),
graphql_name="contextsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(ID), graphql_name="ids", default=None
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]`): Array of context IDs
"""
email_by_address = sgqlc.types.Field(
"CollaborationEmail",
graphql_name="emailByAddress",
args=sgqlc.types.ArgDict(
(
(
"email_address",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="emailAddress",
default=None,
),
),
)
),
)
email_by_id = sgqlc.types.Field(
"CollaborationEmail",
graphql_name="emailById",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
emails_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationEmail"),
graphql_name="emailsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of email IDs
"""
external_service_connection_by_id = sgqlc.types.Field(
"CollaborationExternalServiceConnection",
graphql_name="externalServiceConnectionById",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
file_by_id = sgqlc.types.Field(
"CollaborationFile",
graphql_name="fileById",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"thumbnail",
sgqlc.types.Arg(Boolean, graphql_name="thumbnail", default=None),
),
)
),
)
grok_messages_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationGrokMessage"),
graphql_name="grokMessagesByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of Grok Message IDs
"""
mention_by_id = sgqlc.types.Field(
"CollaborationMention",
graphql_name="mentionById",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
mentions_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationMention"),
graphql_name="mentionsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(ID), graphql_name="ids", default=None
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]`): Array of mention IDs
"""
search_threads_simple = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationThread"),
graphql_name="searchThreadsSimple",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"context_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(ID), graphql_name="contextIds", default=None
),
),
(
"max_results",
sgqlc.types.Arg(Int, graphql_name="maxResults", default=None),
),
(
"query",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="query", default=None
),
),
(
"visibility",
sgqlc.types.Arg(String, graphql_name="visibility", default=None),
),
)
),
)
"""Arguments:
* `account_id` (`Int`): Account ID
* `context_ids` (`[ID]`): Array of context IDs
* `max_results` (`Int`): An optional maximum number of results to
return (e.g., for a simple sidebar).
* `query` (`String!`): The search term to query against thread
content, title, or metadata.
* `visibility` (`String`): Indicate to get PRIVATE, PROTECTED,
CUSTOMER_SERVICE or PUBLIC threads
"""
subscriber_by_id = sgqlc.types.Field(
"CollaborationSubscriber",
graphql_name="subscriberById",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
subscribers_by_thread_id = sgqlc.types.Field(
"CollaborationSubscriberConnection",
graphql_name="subscribersByThreadId",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `thread_id` (`ID!`): Thread ID
"""
subscribers_by_user_id = sgqlc.types.Field(
"CollaborationSubscriberConnection",
graphql_name="subscribersByUserId",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"subscriber_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="subscriberId",
default=None,
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `subscriber_id` (`ID!`): User ID
"""
subscriptions = sgqlc.types.Field(
"CollaborationSubscriberConnection",
graphql_name="subscriptions",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
subscriptions_unread = sgqlc.types.Field(
"CollaborationSubscriptionsWithUnread",
graphql_name="subscriptionsUnread",
args=sgqlc.types.ArgDict(
(
(
"context_id",
sgqlc.types.Arg(ID, graphql_name="contextId", default=None),
),
)
),
)
thread_by_id = sgqlc.types.Field(
"CollaborationThread",
graphql_name="threadById",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
threads_all = sgqlc.types.Field(
"CollaborationThreadConnection",
graphql_name="threadsAll",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(String, graphql_name="filter", default=None),
),
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `filter` (`String`): Filter name to use
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
threads_by_context_id = sgqlc.types.Field(
"CollaborationThreadConnection",
graphql_name="threadsByContextId",
args=sgqlc.types.ArgDict(
(
(
"context_id",
sgqlc.types.Arg(ID, graphql_name="contextId", default=None),
),
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"visibility",
sgqlc.types.Arg(String, graphql_name="visibility", default=None),
),
)
),
)
"""Arguments:
* `context_id` (`ID`): Context ID
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `visibility` (`String`): Indicate to get PRIVATE, PROTECTED,
CUSTOMER_SERVICE or PUBLIC threads
"""
threads_by_context_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationThreadConnection"),
graphql_name="threadsByContextIds",
args=sgqlc.types.ArgDict(
(
(
"context_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(ID), graphql_name="contextIds", default=None
),
),
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"visibility",
sgqlc.types.Arg(String, graphql_name="visibility", default=None),
),
)
),
)
"""Arguments:
* `context_ids` (`[ID]`): Array of context IDs
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `visibility` (`String`): Indicate to get PRIVATE, PROTECTED,
CUSTOMER_SERVICE or PUBLIC threads
"""
threads_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationThread"),
graphql_name="threadsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(ID), graphql_name="ids", default=None
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]`): Array of thread IDs
"""
threads_count_by_context_id = sgqlc.types.Field(
"CollaborationThreadsCount",
graphql_name="threadsCountByContextId",
args=sgqlc.types.ArgDict(
(
(
"context_id",
sgqlc.types.Arg(ID, graphql_name="contextId", default=None),
),
)
),
)
web_socket_connect_url = sgqlc.types.Field(
"CollaborationSocketConnection", graphql_name="webSocketConnectUrl"
)265. CollaborationBotResponse¶
Files uploaded by user
Available fields:
accountId: Account IDcreatedAt: Time the thread was createddeactivated: Indicates whether or not a comment is deactivatedid: Bot Response IDmodifiedAt: Time the thread was modifiedorganizationId: Organization IDpayload: JSON payload for the bot response in string format
class CollaborationBotResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"deactivated",
"id",
"modified_at",
"organization_id",
"payload",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
payload = sgqlc.types.Field(String, graphql_name="payload")266. CollaborationBotResponseFeedback¶
Feedback on bot reponse
Available fields:
rating: ratingresponseId: Bot Response ID
class CollaborationBotResponseFeedback(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("rating", "response_id")
rating = sgqlc.types.Field(Int, graphql_name="rating")
response_id = sgqlc.types.Field(ID, graphql_name="responseId")267. CollaborationCodeMark¶
Code mark created in CodeStream
Available fields:
accountId: Account IDcode: The actual codecreatedAt: Time the code mark was createdcreatorId: Creator IDdeactivated: Code mark statusfile: File to which this code block appliesid: Codemark IDmodifiedAt: Time the code mark was modifiedorganizationId: Organization IDpermalink: The permalink used to jump to this code mark in codestreamrepo: Path to the repo to which this code block appliessha: The git commit sha the code was at when the code block was captured
class CollaborationCodeMark(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"code",
"created_at",
"creator_id",
"deactivated",
"file",
"id",
"modified_at",
"organization_id",
"permalink",
"repo",
"sha",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
code = sgqlc.types.Field(String, graphql_name="code")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
creator_id = sgqlc.types.Field(ID, graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
file = sgqlc.types.Field(String, graphql_name="file")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
permalink = sgqlc.types.Field(String, graphql_name="permalink")
repo = sgqlc.types.Field(String, graphql_name="repo")
sha = sgqlc.types.Field(String, graphql_name="sha")268. CollaborationComment¶
Comment tied to a thread
Available fields:
accountId: Account that owns the commentagentId: Agent ID associated with the commentattributes: Special attributes of the commentbody: The message of the commentcapabilityId: Capability Id at the time of comment creationcontextId: ID of the context where the comment’s thread livescontextMetadata: Context Meta DatacreatedAt: Comment creation timecreator: Comment creator detailscreatorId: ID of the creator of the commentcreatorRole: Role of the comment creatordeactivated: Indicates whether or not a comment is deactivateddisplayName: Display name at the time of comment creationedited: Indicates whether or not a comment was editedexternalApplicationType: External appliation type which comment is originated fromexternalCreator: External creator if comment is from external applicationexternalCreatorId: External creator id if comment is from external applicationid: Comment IDmentions: Mentions associated with a commentmodifiedAt: Comment modified timeorganizationId: Organization that owns the commentreferenceUrl: Reference URL of the commentreplyTo: Indicates the comment is a reply to some other commentrunId: Run ID associated with the commentstepId: Step ID associated with the commentsyncStatuses: List of sync statuses to external applicationssystemMessageType: Denotes system message and type of commentthreadId: ID of the thread where the comment livestimePickerFrom: Timer picker start timetimePickerTo: Timer picker end time
class CollaborationComment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"agent_id",
"attributes",
"body",
"capability_id",
"context_id",
"context_metadata",
"created_at",
"creator",
"creator_id",
"creator_role",
"deactivated",
"display_name",
"edited",
"external_application_type",
"external_creator",
"external_creator_id",
"id",
"mentions",
"modified_at",
"organization_id",
"reference_url",
"reply_to",
"run_id",
"step_id",
"sync_statuses",
"system_message_type",
"thread_id",
"time_picker_from",
"time_picker_to",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
agent_id = sgqlc.types.Field(String, graphql_name="agentId")
attributes = sgqlc.types.Field(String, graphql_name="attributes")
body = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="body")
capability_id = sgqlc.types.Field(String, graphql_name="capabilityId")
context_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="contextId")
context_metadata = sgqlc.types.Field(
CollaborationRawContextMetadata, graphql_name="contextMetadata"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator = sgqlc.types.Field("CollaborationCommentCreator", graphql_name="creator")
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
creator_role = sgqlc.types.Field(String, graphql_name="creatorRole")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
edited = sgqlc.types.Field(Boolean, graphql_name="edited")
external_application_type = sgqlc.types.Field(
String, graphql_name="externalApplicationType"
)
external_creator = sgqlc.types.Field(
"CollaborationExternalCommentCreator", graphql_name="externalCreator"
)
external_creator_id = sgqlc.types.Field(ID, graphql_name="externalCreatorId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
mentions = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationMention"), graphql_name="mentions"
)
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
reference_url = sgqlc.types.Field(String, graphql_name="referenceUrl")
reply_to = sgqlc.types.Field(ID, graphql_name="replyTo")
run_id = sgqlc.types.Field(ID, graphql_name="runId")
step_id = sgqlc.types.Field(ID, graphql_name="stepId")
sync_statuses = sgqlc.types.Field(
sgqlc.types.list_of("CollaborationCommentSyncStatus"),
graphql_name="syncStatuses",
)
system_message_type = sgqlc.types.Field(String, graphql_name="systemMessageType")
thread_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="threadId")
time_picker_from = sgqlc.types.Field(
EpochMilliseconds, graphql_name="timePickerFrom"
)
time_picker_to = sgqlc.types.Field(EpochMilliseconds, graphql_name="timePickerTo")269. CollaborationCommentConnection¶
Cursor pagination object
Available fields:
entities: Array of resultshasNextPage: has next pagehasPreviousPage: has previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total amount paginatable
class CollaborationCommentConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationComment), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")270. CollaborationCommentCreator¶
Creator of the comment
Available fields:
email: Email of the comment creatorname: Name of the comment creatoruserId: ID of the comment creator
class CollaborationCommentCreator(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "name", "user_id")
email = sgqlc.types.Field(String, graphql_name="email")
name = sgqlc.types.Field(String, graphql_name="name")
user_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="userId")271. CollaborationCommentSyncStatus¶
Comment sync status to external application
Available fields:
appType: External application typeerror: Error as cause for not okok: Sync success or not, undefined indicates pending
class CollaborationCommentSyncStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("app_type", "error", "ok")
app_type = sgqlc.types.Field(String, graphql_name="appType")
error = sgqlc.types.Field(String, graphql_name="error")
ok = sgqlc.types.Field(Boolean, graphql_name="ok")272. CollaborationContext¶
Context represents a page or construct where threads can be created and conversations can happen
Available fields:
accountId: Account IDcontextMetadata: Metadata added to contextcreatedAt: Time the context was createdcreatorId: Creator IDdeactivated: Indicates whether or not the context has been deactivatedentityGuid: URL state entity GUID associated with the contextid: Context IDlatestThreadCommentCreatorId: Creator ID of the latest comment on the latest threadlatestThreadCommentId: Comment ID of the latest comment on the latest threadlatestThreadCommentTime: Time of the latest comment on the latest threadlatestThreadId: ID of the thread with latest activitymodifiedAt: Time the context was modifiedorganizationId: Organization IDreferenceUrl: URL that represents the contextthread: Get a thread associated with this contextthreadCount: Number of threads about this contextthreads: Threads for a given context
class CollaborationContext(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"context_metadata",
"created_at",
"creator_id",
"deactivated",
"entity_guid",
"id",
"latest_thread_comment_creator_id",
"latest_thread_comment_id",
"latest_thread_comment_time",
"latest_thread_id",
"modified_at",
"organization_id",
"reference_url",
"thread",
"thread_count",
"threads",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
context_metadata = sgqlc.types.Field(
CollaborationRawContextMetadata, graphql_name="contextMetadata"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
entity_guid = sgqlc.types.Field(EntityGuid, graphql_name="entityGuid")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
latest_thread_comment_creator_id = sgqlc.types.Field(
ID, graphql_name="latestThreadCommentCreatorId"
)
latest_thread_comment_id = sgqlc.types.Field(
ID, graphql_name="latestThreadCommentId"
)
latest_thread_comment_time = sgqlc.types.Field(
EpochMilliseconds, graphql_name="latestThreadCommentTime"
)
latest_thread_id = sgqlc.types.Field(ID, graphql_name="latestThreadId")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
reference_url = sgqlc.types.Field(String, graphql_name="referenceUrl")
thread = sgqlc.types.Field(
"CollaborationThread",
graphql_name="thread",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
thread_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="threadCount"
)
threads = sgqlc.types.Field(
"CollaborationThreadConnection",
graphql_name="threads",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
"""273. CollaborationEmail¶
Email object to store any mentioned email addresses
Available fields:
createdAt: Time the email was createdcreatorId: Creator IDemailAddress: Email address that was mentionedid: Email IDmodifiedAt: Time the addresse was modifiedorganizationId: Organization IDregisteredAt: Time the user registered this emailstatus: Status of the email addressuserId: If someone eventually registers with this email address, their user ID is stored here
class CollaborationEmail(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"creator_id",
"email_address",
"id",
"modified_at",
"organization_id",
"registered_at",
"status",
"user_id",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
email_address = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="emailAddress"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
registered_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="registeredAt")
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")
user_id = sgqlc.types.Field(ID, graphql_name="userId")274. CollaborationExternalCommentCreator¶
Creator of the comment from a 3rd party
Available fields:
createdAt: External comment creator created timeemailAddress: Email address registered in external applicationid: Unique ID of external comment creatormodifiedAt: External comment creator modified timeuserId: New Relic user ID if existinguserName: User display name from external application
class CollaborationExternalCommentCreator(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"email_address",
"id",
"modified_at",
"user_id",
"user_name",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
email_address = sgqlc.types.Field(String, graphql_name="emailAddress")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
user_id = sgqlc.types.Field(Int, graphql_name="userId")
user_name = sgqlc.types.Field(String, graphql_name="userName")275. CollaborationExternalServiceConnection¶
External Service represents a link between a New Relic thread and a thread on an external service
Available fields:
accountId: Account IDchannelId: 3rd party channel IDcreatedAt: Time the external service connection was createdcreatorId: Creator IDdeactivated: Indicates whether or not the external service connection has been deactivatedexternalId: External ID provided by the external serviceid: External Service Connection IDorganizationId: Organization IDsessionId: Session ID provided by the notifications gateway when creating the first external messagethreadId: Thread ID where messages from the external service will be createdtype: Connection type. One of [‘SLACK’, ‘TEAMS’, ‘EMAIL’]
class CollaborationExternalServiceConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"channel_id",
"created_at",
"creator_id",
"deactivated",
"external_id",
"id",
"organization_id",
"session_id",
"thread_id",
"type",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
channel_id = sgqlc.types.Field(ID, graphql_name="channelId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
external_id = sgqlc.types.Field(ID, graphql_name="externalId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
session_id = sgqlc.types.Field(ID, graphql_name="sessionId")
thread_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="threadId")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")276. CollaborationExternalServiceConnectionGroup¶
Cursor pagination object
Available fields:
entities: Array of resultshasNextPage: has next pagehasPreviousPage: has previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total amount paginatable
class CollaborationExternalServiceConnectionGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationExternalServiceConnection),
graphql_name="entities",
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")277. CollaborationFile¶
Files uploaded by user
Available fields:
accountId: Account IDcreatedAt: Time the thread was createdcreatorId: Creator IDdeactivated: File statusexternalApplicationType: The type of external applicationexternalCreatorId: The user id of the external userfileName: Name of filefilePath: File PathhasThumbnail: Does image have thumbnail versionid: Thread IDisScreenshot: Is image NR screenshotmodifiedAt: Time the thread was modifiedorganizationId: Organization IDuploadUrl: Upload Url
class CollaborationFile(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"creator_id",
"deactivated",
"external_application_type",
"external_creator_id",
"file_name",
"file_path",
"has_thumbnail",
"id",
"is_screenshot",
"modified_at",
"organization_id",
"upload_url",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(ID, graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
external_application_type = sgqlc.types.Field(
String, graphql_name="externalApplicationType"
)
external_creator_id = sgqlc.types.Field(String, graphql_name="externalCreatorId")
file_name = sgqlc.types.Field(String, graphql_name="fileName")
file_path = sgqlc.types.Field(String, graphql_name="filePath")
has_thumbnail = sgqlc.types.Field(Boolean, graphql_name="hasThumbnail")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
is_screenshot = sgqlc.types.Field(Boolean, graphql_name="isScreenshot")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
upload_url = sgqlc.types.Field(String, graphql_name="uploadUrl")278. CollaborationGrokMessage¶
Messages generated from Grok
Available fields:
accountId: Account IDcard: The card included with Groks responsecontent: The message contentcontext: Indicates whether or not the message is deactivatedcreatedAt: Time the message was createdcreatorId: Creator IDid: Message IDmodifiedAt: Time the message was modifiedrole: Role of the message creatorthreadId: Thread ID
class CollaborationGrokMessage(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"card",
"content",
"context",
"created_at",
"creator_id",
"id",
"modified_at",
"role",
"thread_id",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
card = sgqlc.types.Field(String, graphql_name="card")
content = sgqlc.types.Field(String, graphql_name="content")
context = sgqlc.types.Field(CollaborationRawContextMetadata, graphql_name="context")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(ID, graphql_name="creatorId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
role = sgqlc.types.Field(String, graphql_name="role")
thread_id = sgqlc.types.Field(ID, graphql_name="threadId")279. CollaborationLinkedContexts¶
Contains contexts and cursor information
Available fields:
entities: Array of contextsnextCursor: Cursor to fetch next page
class CollaborationLinkedContexts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "next_cursor")
entities = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationContext), graphql_name="entities"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")280. CollaborationMention¶
A mention represents a mentionable item like a user, file, graph, etc
Available fields:
commentId: The comment that mentioned this itemcreatedAt: The time the mention was createdcreatorId: Creator IDdeactivated: Indicates whether or not the mention has been deactivatedemail: Email object if mentionable thing is an emailexternalApplicationType: The type of external application associated with this mention (e.g.: SLACK)externalCreatorId: The user id of the user mentioning this itemid: Mention IDmentionableItemId: ID of thing being mentionedmodifiedAt: The time the mention was last modifiedtype: The type of item being mentioned
class CollaborationMention(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"comment_id",
"created_at",
"creator_id",
"deactivated",
"email",
"external_application_type",
"external_creator_id",
"id",
"mentionable_item_id",
"modified_at",
"type",
)
comment_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="commentId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
deactivated = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="deactivated"
)
email = sgqlc.types.Field(CollaborationEmail, graphql_name="email")
external_application_type = sgqlc.types.Field(
CollaborationExternalApplicationType, graphql_name="externalApplicationType"
)
external_creator_id = sgqlc.types.Field(ID, graphql_name="externalCreatorId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
mentionable_item_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="mentionableItemId"
)
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")281. CollaborationMessageSent¶
Message shared to external application
Available fields:
id: Message IDsentAt: Message creation timesyncStatuses: List of sync statuses to external applications
class CollaborationMessageSent(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "sent_at", "sync_statuses")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
sent_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="sentAt"
)
sync_statuses = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationCommentSyncStatus), graphql_name="syncStatuses"
)282. CollaborationSocketConnection¶
Websocket subscriber connection data
Available fields:
nrConnectionId: New Relic Connection IDurl: The URL that the client should connect to
class CollaborationSocketConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nr_connection_id", "url")
nr_connection_id = sgqlc.types.Field(String, graphql_name="nrConnectionId")
url = sgqlc.types.Field(SecureValue, graphql_name="url")283. CollaborationSubscriber¶
A subscriber represents a user subscribed to a thread
Available fields:
accountId: Account IDactivelySubscribed: Indicates whether or not the subscription is activecommentsReadCount: Number of comments this subscriber has read in this threadcontextId: Context IDcreatedAt: Time subscription was createdexternalApplicationType: The type of external application associated with this subscription (e.g.: SLACK)externalCreatorId: The non NR user id associated to this subscriptionid: Subscriber IDlastCommentReadId: ID of the last comment readmentionCount: Number of mentions in this threadmentionsReadCount: Number of mentions the user has readmodifiedAt: Time subscription was modifiedorganizationId: Organization IDthread: Get the thread that this subscriber is forthreadId: Thread IDunreadCommentDeletedCount: Number of comments deleted before the user read themuserId: User ID
class CollaborationSubscriber(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"actively_subscribed",
"comments_read_count",
"context_id",
"created_at",
"external_application_type",
"external_creator_id",
"id",
"last_comment_read_id",
"mention_count",
"mentions_read_count",
"modified_at",
"organization_id",
"thread",
"thread_id",
"unread_comment_deleted_count",
"user_id",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
actively_subscribed = sgqlc.types.Field(Boolean, graphql_name="activelySubscribed")
comments_read_count = sgqlc.types.Field(Int, graphql_name="commentsReadCount")
context_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="contextId")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
external_application_type = sgqlc.types.Field(
String, graphql_name="externalApplicationType"
)
external_creator_id = sgqlc.types.Field(ID, graphql_name="externalCreatorId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
last_comment_read_id = sgqlc.types.Field(ID, graphql_name="lastCommentReadId")
mention_count = sgqlc.types.Field(Int, graphql_name="mentionCount")
mentions_read_count = sgqlc.types.Field(Int, graphql_name="mentionsReadCount")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
thread = sgqlc.types.Field("CollaborationThread", graphql_name="thread")
thread_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="threadId")
unread_comment_deleted_count = sgqlc.types.Field(
Int, graphql_name="unreadCommentDeletedCount"
)
user_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="userId")284. CollaborationSubscriberConnection¶
Cursor pagination object
Available fields:
entities: Array of resultshasNextPage: has next pagehasPreviousPage: has previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total amount paginatable
class CollaborationSubscriberConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationSubscriber), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")285. CollaborationSubscriptionsWithUnread¶
Only subscriptions with unread messages
Available fields:
subscriptions: A list of subscriptionsunreadCommentCount: The number of unread comments for this userunreadThreadCount: The number of unread threads for this user
class CollaborationSubscriptionsWithUnread(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("subscriptions", "unread_comment_count", "unread_thread_count")
subscriptions = sgqlc.types.Field(String, graphql_name="subscriptions")
unread_comment_count = sgqlc.types.Field(Int, graphql_name="unreadCommentCount")
unread_thread_count = sgqlc.types.Field(Int, graphql_name="unreadThreadCount")286. CollaborationThread¶
Thread tied to a context
Available fields:
accountId: Account IDcomment: Query for a single comment within a threadcommentCount: Number of comments in the threadcomments: Query for multiple comments on a threadcontextId: Context IDcontextMetadata: Metadata added to threadcreatedAt: Time the thread was createdcreatorId: Creator IDdeactivated: Indicates whether or not the thread was deactivateddeletedCommentCount: The count of deleted commentsexternalApplicationType: Indicate that thread is linked to a external application typeexternalServiceConnections: External Service Connections for a threadfirstCommentId: The ID of the first comment in the threadid: Thread IDlatestCommentCreatorId: The latest comment’s creator IDlatestCommentId: The latest comment IDlatestCommentTime: The time the latest comment was postedmodifiedAt: Time the thread was modifiedorganizationId: Organization IDreferenceUrl: Reference URLstatus: Defines if the threads is OPEN, CLOSED or ARCHIVEDsubscriber: Get a specific subscribersubscribers: Get the subscribers for this thread
class CollaborationThread(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"comment",
"comment_count",
"comments",
"context_id",
"context_metadata",
"created_at",
"creator_id",
"deactivated",
"deleted_comment_count",
"external_application_type",
"external_service_connections",
"first_comment_id",
"id",
"latest_comment_creator_id",
"latest_comment_id",
"latest_comment_time",
"modified_at",
"organization_id",
"reference_url",
"status",
"subscriber",
"subscribers",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
comment = sgqlc.types.Field(
CollaborationComment,
graphql_name="comment",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
comment_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="commentCount"
)
comments = sgqlc.types.Field(
CollaborationCommentConnection,
graphql_name="comments",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
"""
context_id = sgqlc.types.Field(ID, graphql_name="contextId")
context_metadata = sgqlc.types.Field(
CollaborationRawContextMetadata, graphql_name="contextMetadata"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(ID, graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
deleted_comment_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="deletedCommentCount"
)
external_application_type = sgqlc.types.Field(
String, graphql_name="externalApplicationType"
)
external_service_connections = sgqlc.types.Field(
CollaborationExternalServiceConnectionGroup,
graphql_name="externalServiceConnections",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page - desc - max 50
"""
first_comment_id = sgqlc.types.Field(ID, graphql_name="firstCommentId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
latest_comment_creator_id = sgqlc.types.Field(
ID, graphql_name="latestCommentCreatorId"
)
latest_comment_id = sgqlc.types.Field(ID, graphql_name="latestCommentId")
latest_comment_time = sgqlc.types.Field(
EpochMilliseconds, graphql_name="latestCommentTime"
)
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
reference_url = sgqlc.types.Field(String, graphql_name="referenceUrl")
status = sgqlc.types.Field(String, graphql_name="status")
subscriber = sgqlc.types.Field(
CollaborationSubscriber,
graphql_name="subscriber",
args=sgqlc.types.ArgDict(
(("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),)
),
)
subscribers = sgqlc.types.Field(
CollaborationSubscriberConnection,
graphql_name="subscribers",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many pages per page 'desc' - max 50
"""287. CollaborationThreadConnection¶
Cursor pagination object
Available fields:
entities: Array of resultshasNextPage: has next pagehasPreviousPage: has previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total amount paginatable
class CollaborationThreadConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(CollaborationThread), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")288. CollaborationThreadsCount¶
Threads count per status
Available fields:
closed: Threads count in closed statusopen: Threads count in open status
class CollaborationThreadsCount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("closed", "open")
closed = sgqlc.types.Field(Int, graphql_name="closed")
open = sgqlc.types.Field(Int, graphql_name="open")289. Consumption¶
Available fields:
customerId: TheConsumptionobject provides consumption data about a user.
class Consumption(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("customer_id",)
customer_id = sgqlc.types.Field(ID, graphql_name="customerId")290. CrossAccountNrdbResultContainer¶
A data structure that contains the results of the multi account NRDB query along with other capabilities that enhance those results.
Direct query results are available through results, totalResult and
otherResult. The query you made is accessible through nrql, along with
metadata about the query itself.
Available fields:
currentResults: In aCOMPARE WITHquery, thecurrentResultscontain the results for the current comparison time window.metadata: Metadata about the query and result.nrql: The NRQL query that was executed to yield these results.otherResult: In aFACETquery, theotherResultcontains the aggregates representing the events not contained in an individualresultsfacet.previousResults: In aCOMPARE WITHquery, thepreviousResultscontain the results for the previous comparison time window.queryProgress: Metadata about the execution of an asynchronous NRQL query.rawResponse: The raw query results exactly as they are returned from NRDB. NerdGraph provides no additional transformation.results: The query results. This is a flat list of objects who’s structure matches the query submitted.totalResult: In aFACETquery, thetotalResultcontains the aggregates representing all the events, whether or not they are contained in an individualresultsfacet.
class CrossAccountNrdbResultContainer(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"current_results",
"metadata",
"nrql",
"other_result",
"previous_results",
"query_progress",
"raw_response",
"results",
"total_result",
)
current_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="currentResults"
)
metadata = sgqlc.types.Field("NrdbMetadata", graphql_name="metadata")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
other_result = sgqlc.types.Field(NrdbResult, graphql_name="otherResult")
previous_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="previousResults"
)
query_progress = sgqlc.types.Field(
"NrdbQueryProgress", graphql_name="queryProgress"
)
raw_response = sgqlc.types.Field(NrdbRawResults, graphql_name="rawResponse")
results = sgqlc.types.Field(sgqlc.types.list_of(NrdbResult), graphql_name="results")
total_result = sgqlc.types.Field(NrdbResult, graphql_name="totalResult")291. CustomRoleRoleMutationResult¶
The ID of the affected Role
Available fields:
id: The ID of the role
class CustomRoleRoleMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(Int, graphql_name="id")292. CustomerAdministration¶
The CustomerAdministration object contains fields for managing the configuration that defines the business relationships between New Relic, partners, and customers.
Available fields:
accountShares: Accessible account sharesaccounts: accountsauthenticationDomains: Authentication domainsconsumption: Theconsumptionfield is the entry point into a customer’s consumption data that is scoped to the ID of the customer.contracts: Accessible contractsdataAccessPolicies: Fetches a list of data access policies with sorting, filtering, and pagination.grants: list of grantsgroups: Named sets of New Relic users within an authentication domainjobs: This provides access to fields you can use to check the status of asynchronous jobs related to customer administration.organizationMembers: Organization Member Searchorganizations: Accessible organizationspermissions: list of permissionsroles: list of rolessecret: Retrieves secret except value of secret with given namespace and key(required)secretVersions: Retrieves secret versions info with given namespace and key(required)secrets: Returns a collection of secrets with next cursor to allow paginationsystemIdentities: Query for a collection of System IdentitiessystemIdentityGroups: System Identity Groupsuser: The authenticatedUserwho made this request.users: A collection of New Relic users
class CustomerAdministration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_shares",
"accounts",
"authentication_domains",
"consumption",
"contracts",
"data_access_policies",
"grants",
"groups",
"jobs",
"organization_members",
"organizations",
"permissions",
"roles",
"secret",
"secret_versions",
"secrets",
"system_identities",
"system_identity_groups",
"user",
"users",
)
account_shares = sgqlc.types.Field(
"OrganizationAccountShareCollection",
graphql_name="accountShares",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationAccountShareFilterInput),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(OrganizationAccountShareSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationAccountShareFilterInput!`): The filter
* `sort` (`[OrganizationAccountShareSortInput!]`): Sort account
share results
"""
accounts = sgqlc.types.Field(
"OrganizationAccountCollection",
graphql_name="accounts",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationAccountFilterInput),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(OrganizationAccountSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationAccountFilterInput!`): The filter
* `sort` (`[OrganizationAccountSortInput!]`): Sort Accounts
"""
authentication_domains = sgqlc.types.Field(
"OrganizationAuthenticationDomainCollection",
graphql_name="authenticationDomains",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(
OrganizationAuthenticationDomainFilterInput
),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(
OrganizationAuthenticationDomainSortInput
)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationAuthenticationDomainFilterInput!`):
Filter authentication domain results
* `sort` (`[OrganizationAuthenticationDomainSortInput!]`): Order
authentication domain results
"""
consumption = sgqlc.types.Field(
Consumption,
graphql_name="consumption",
args=sgqlc.types.ArgDict(
(
(
"customer_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="customerId",
default=None,
),
),
)
),
)
"""Arguments:
* `customer_id` (`ID!`): The ID of the customer.
"""
contracts = sgqlc.types.Field(
"OrganizationCustomerContractWrapper",
graphql_name="contracts",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
OrganizationCustomerContractFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationCustomerContractFilterInput`): The filter
"""
data_access_policies = sgqlc.types.Field(
"DataAccessPolicyCollection",
graphql_name="dataAccessPolicies",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(DataAccessPolicyFilterInput),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
DataAccessPolicySortInput, graphql_name="sort", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination.
* `filter` (`DataAccessPolicyFilterInput!`): Filtering options for
the data access policies.
* `sort` (`DataAccessPolicySortInput`): Sorting options for the
data access policies.
"""
grants = sgqlc.types.Field(
"MultiTenantAuthorizationGrantCollection",
graphql_name="grants",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(
MultiTenantAuthorizationGrantFilterInputExpression
),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(MultiTenantAuthorizationGrantSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter`
(`MultiTenantAuthorizationGrantFilterInputExpression!`): allows
filtering of the data
* `sort` (`[MultiTenantAuthorizationGrantSortInput!]`): allows
sorting of the data
"""
groups = sgqlc.types.Field(
"MultiTenantIdentityGroupCollection",
graphql_name="groups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(MultiTenantIdentityGroupFilterInput),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(MultiTenantIdentityGroupSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`MultiTenantIdentityGroupFilterInput!`): Filter groups
* `sort` (`[MultiTenantIdentityGroupSortInput!]`): Sort groups
"""
jobs = sgqlc.types.Field("CustomerAdministrationJobs", graphql_name="jobs")
organization_members = sgqlc.types.Field(
"OrganizationMembersOrganizationMemberCollection",
graphql_name="organizationMembers",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(
OrganizationMembersOrganizationMemberFilter
),
graphql_name="filter",
default=None,
),
),
)
),
)
organizations = sgqlc.types.Field(
"OrganizationCustomerOrganizationWrapper",
graphql_name="organizations",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
OrganizationCustomerOrganizationFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationCustomerOrganizationFilterInput`): The
filter
"""
permissions = sgqlc.types.Field(
"MultiTenantAuthorizationPermissionCollection",
graphql_name="permissions",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
MultiTenantAuthorizationPermissionFilter,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`MultiTenantAuthorizationPermissionFilter`): allows
filtering of the data
"""
roles = sgqlc.types.Field(
"MultiTenantAuthorizationRoleCollection",
graphql_name="roles",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(
MultiTenantAuthorizationRoleFilterInputExpression
),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(MultiTenantAuthorizationRoleSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`MultiTenantAuthorizationRoleFilterInputExpression!`):
allows filtering of the data
* `sort` (`[MultiTenantAuthorizationRoleSortInput!]`): allows
sorting of the data
"""
secret = sgqlc.types.Field(
"SecretsManagementSecretQueryResponse",
graphql_name="secret",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
(
"unlock",
sgqlc.types.Arg(Boolean, graphql_name="unlock", default=False),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `key` (`String!`): The `key` field of the secret to retrieve
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `scope` (`SecretsManagementScope!`): The scope of the secret
* `unlock` (`Boolean`): Whether to `unlock` and retrieve the
secret's value; defaults to false. (default: `false`)
* `version` (`Int`): The `version` of the secret to retrieve, if
left null the latest version is returned
"""
secret_versions = sgqlc.types.Field(
"SecretsManagementSecretVersionsQueryResponse",
graphql_name="secretVersions",
args=sgqlc.types.ArgDict(
(
(
"fetch_deleted",
sgqlc.types.Arg(
Boolean, graphql_name="fetchDeleted", default=False
),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
)
),
)
"""Arguments:
* `fetch_deleted` (`Boolean`): Indicated if the deleted secret
versions should also be returned, default value is false
(default: `false`)
* `key` (`String!`): The `key` field of the secret to retrieve
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `scope` (`SecretsManagementScope!`): The scope of the secret
"""
secrets = sgqlc.types.Field(
"SecretsManagementSecretsCollectionQueryResponse",
graphql_name="secrets",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementSecretsCollectionFilter),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
SecretsManagementSecretsCollectionSort,
graphql_name="sort",
default={"direction": "DESC", "key": "CREATED_AT"},
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): The cursor for pagination
* `filter` (`SecretsManagementSecretsCollectionFilter!`): The
filter to apply to the secrets collection query
* `sort` (`SecretsManagementSecretsCollectionSort`): The sort
criteria for the secrets collection (default: `{direction: DESC,
key: CREATED_AT}`)
"""
system_identities = sgqlc.types.Field(
"SystemIdentityIdentityCollection",
graphql_name="systemIdentities",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(SystemIdentityIdentityFilter),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
SystemIdentityIdentitySort, graphql_name="sort", default=None
),
),
)
),
)
system_identity_groups = sgqlc.types.Field(
"SystemIdentityGroupCollection",
graphql_name="systemIdentityGroups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(SystemIdentityGroupFilter),
graphql_name="filter",
default=None,
),
),
)
),
)
user = sgqlc.types.Field("User", graphql_name="user")
users = sgqlc.types.Field(
"MultiTenantIdentityUserCollection",
graphql_name="users",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(MultiTenantIdentityUserFilterInput),
graphql_name="filter",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(MultiTenantIdentityUserSortInput)
),
graphql_name="sort",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`MultiTenantIdentityUserFilterInput!`): Filter users
* `sort` (`[MultiTenantIdentityUserSortInput!]`): Sort users
"""293. CustomerAdministrationJobs¶
Available fields:
organizationCreateAsyncResults: Organization Create job results
class CustomerAdministrationJobs(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("organization_create_async_results",)
organization_create_async_results = sgqlc.types.Field(
"OrganizationOrganizationCreateAsyncResultCollection",
graphql_name="organizationCreateAsyncResults",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(
OrganizationOrganizationCreateAsyncResultFilterInput
),
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter`
(`OrganizationOrganizationCreateAsyncResultFilterInput!`):
Filter organization create job results
"""294. DashboardActorStitchedFields¶
Type defined so its fields will be merged directly into NerdGraph’s Actor type.
Available fields:
liveUrlCreationPolicies: Fetch the list of live URL creation policies.liveUrls: Fetch the list of live URLs created by the API user.
class DashboardActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("live_url_creation_policies", "live_urls")
live_url_creation_policies = sgqlc.types.Field(
"DashboardLiveUrlCreationPoliciesResult",
graphql_name="liveUrlCreationPolicies",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
DashboardLiveUrlCreationPoliciesFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `filter` (`DashboardLiveUrlCreationPoliciesFilterInput`): Filter
the live URL creation policies to fetch.
"""
live_urls = sgqlc.types.Field(
"DashboardLiveUrlResult",
graphql_name="liveUrls",
args=sgqlc.types.ArgDict(
(
(
"filter",
sgqlc.types.Arg(
DashboardLiveUrlsFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `filter` (`DashboardLiveUrlsFilterInput`): Filter the live URLs
to fetch.
"""295. DashboardAddWidgetsToPageError¶
Expected errors that can be returned by addWidgetsToPage operation.
Available fields:
description: Error description.type: Error type.
class DashboardAddWidgetsToPageError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardAddWidgetsToPageErrorType), graphql_name="type"
)296. DashboardAddWidgetsToPageResult¶
Result of addWidgetsToPage operation.
Available fields:
errors: Expected errors while processing request. No errors means successful request.
class DashboardAddWidgetsToPageResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardAddWidgetsToPageError), graphql_name="errors"
)297. DashboardAreaWidgetConfiguration¶
Configuration for visualization type ‘viz.area’
Available fields:
nrqlQueries: NRQL queries.
class DashboardAreaWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries",)
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)298. DashboardBarWidgetConfiguration¶
class DashboardBarWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries",)
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)299. DashboardBillboardWidgetConfiguration¶
Configuration for visualization type ‘viz.billboard’
Available fields:
nrqlQueries: NRQL queries.thresholds: Array of thresholds to categorize the results of the query in different groups.
class DashboardBillboardWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries", "thresholds")
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)
thresholds = sgqlc.types.Field(
sgqlc.types.list_of("DashboardBillboardWidgetThreshold"),
graphql_name="thresholds",
)300. DashboardBillboardWidgetThreshold¶
Billboard widget threshold.
Available fields:
alertSeverity: Alert severity.value: Alert value.
class DashboardBillboardWidgetThreshold(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("alert_severity", "value")
alert_severity = sgqlc.types.Field(
DashboardAlertSeverity, graphql_name="alertSeverity"
)
value = sgqlc.types.Field(Float, graphql_name="value")301. DashboardCreateError¶
Expected errors that can be returned by create operation.
Available fields:
description: Error description.type: Error type.
class DashboardCreateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardCreateErrorType), graphql_name="type"
)302. DashboardCreateResult¶
Result of create operation.
Available fields:
entityResult: Dashboard creation result.errors: Expected errors while processing request.
class DashboardCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity_result", "errors")
entity_result = sgqlc.types.Field(
"DashboardEntityResult", graphql_name="entityResult"
)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardCreateError), graphql_name="errors"
)303. DashboardDeleteError¶
Expected error types that can be returned by delete operation.
Available fields:
description: Error description.type: Error type.
class DashboardDeleteError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardDeleteErrorType), graphql_name="type"
)304. DashboardDeleteResult¶
Result of delete operation.
Available fields:
errors: Expected errors while processing request.status: The status of the attempted delete.
class DashboardDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "status")
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardDeleteError), graphql_name="errors"
)
status = sgqlc.types.Field(DashboardDeleteResultStatus, graphql_name="status")305. DashboardEntityOwnerInfo¶
Dashboard owner
Available fields:
email: The email of the dashboard owneruserId: The user ID of the dashboard owner
class DashboardEntityOwnerInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "user_id")
email = sgqlc.types.Field(String, graphql_name="email")
user_id = sgqlc.types.Field(Int, graphql_name="userId")306. DashboardEntityResult¶
Public schema - DashboardEntity result representation for mutations. It’s a subset of the DashboardEntity that inherits from the Entity type, but a complete different type.
Available fields:
accountId: The New Relic account where the dashboard is created.createdAt: Dashboard creation timestamp.description: Brief text describing the dashboard.guid: Unique entity identifier.name: The name of the dashboard.owner: Information of the user that owns the dashboard.pages: A nested block of all pages belonging to the dashboard.permissions: Dashboard permissions configuration.updatedAt: Dashboard update timestamp.variables: Dashboard-local variable definitions.
class DashboardEntityResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"description",
"guid",
"name",
"owner",
"pages",
"permissions",
"updated_at",
"variables",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
description = sgqlc.types.Field(String, graphql_name="description")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
name = sgqlc.types.Field(String, graphql_name="name")
owner = sgqlc.types.Field("DashboardOwnerInfo", graphql_name="owner")
pages = sgqlc.types.Field(
sgqlc.types.list_of("DashboardPage"), graphql_name="pages"
)
permissions = sgqlc.types.Field(DashboardPermissions, graphql_name="permissions")
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
variables = sgqlc.types.Field(
sgqlc.types.list_of("DashboardVariable"), graphql_name="variables"
)307. DashboardLineWidgetConfiguration¶
Configuration for visualization type ‘viz.line’
Available fields:
nrqlQueries: NRQL queries.
class DashboardLineWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries",)
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)308. DashboardLiveUrl¶
Live URL.
Available fields:
accounts: The account(s) of the Live URL. For live dashboards only one account is presentauth: The authorization policies that will be used to protect the Live URLcreatedAt: Creation date.createdBy: Information of the user that created the LiveUrl.expiresOn: Date when the Live Url will become unavailabletitle: Title that describes the source entity that is accessible through the public live URL.type: Live URL type.url: Public URL.uuid: The unique identifier of the public live URL.
class DashboardLiveUrl(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"accounts",
"auth",
"created_at",
"created_by",
"expires_on",
"title",
"type",
"url",
"uuid",
)
accounts = sgqlc.types.Field(
sgqlc.types.list_of(AccountReference), graphql_name="accounts"
)
auth = sgqlc.types.Field("DashboardLiveUrlAuth", graphql_name="auth")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
expires_on = sgqlc.types.Field(EpochMilliseconds, graphql_name="expiresOn")
title = sgqlc.types.Field(String, graphql_name="title")
type = sgqlc.types.Field(DashboardLiveUrlType, graphql_name="type")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")
uuid = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="uuid")309. DashboardLiveUrlAuth¶
The authorization policies that will be used to protect the Live URL
Available fields:
factors: The different authorization factors that will be used to protect the Live URL
class DashboardLiveUrlAuth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("factors",)
factors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("DashboardLiveUrlAuthFactor"))
),
graphql_name="factors",
)310. DashboardLiveUrlAuthFactor¶
Live URL authentication factor.
Available fields:
password: Details for the Live URL authentication factor of typePASSWORDtype: Type of authentication factor.
class DashboardLiveUrlAuthFactor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("password", "type")
password = sgqlc.types.Field(
"DashboardLiveUrlAuthPasswordDetails", graphql_name="password"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardLiveUrlAuthType), graphql_name="type"
)311. DashboardLiveUrlAuthPasswordDetails¶
Live URL authentication details.
Available fields:
value: The actual password of the Live URL, contains value only upon public link creation
class DashboardLiveUrlAuthPasswordDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("value",)
value = sgqlc.types.Field(SecureValue, graphql_name="value")312. DashboardLiveUrlCreationPoliciesResult¶
Result of fetching list of live URL creation policies.
Available fields:
liveUrlCreationPolicies: List of live URL creation policies.
class DashboardLiveUrlCreationPoliciesResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("live_url_creation_policies",)
live_url_creation_policies = sgqlc.types.Field(
sgqlc.types.list_of("DashboardLiveUrlCreationPolicy"),
graphql_name="liveUrlCreationPolicies",
)313. DashboardLiveUrlCreationPolicy¶
Represents a live URL creation policy. A live URL creation policy controls whether creating Live URLs is allowed or not for an account.
Available fields:
accountId: The account id for which the policy applies.liveUrlCreationAllowed: Whether or not live URL creation is allowed for the account.
class DashboardLiveUrlCreationPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "live_url_creation_allowed")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
live_url_creation_allowed = sgqlc.types.Field(
Boolean, graphql_name="liveUrlCreationAllowed"
)314. DashboardLiveUrlError¶
Live URL error.
Available fields:
description: Description of the error.type: Type of error.
class DashboardLiveUrlError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(DashboardLiveUrlErrorType, graphql_name="type")315. DashboardLiveUrlResult¶
Live URL result.
Available fields:
errors: The list of errors, if any.liveUrls: Live URL.nextCursor: The next cursor for fetching additional Live URL results.totalCount: The total number of live urls that match the criteria. May not necessarily be the same as number of elements in liveUrls due to pagination.
class DashboardLiveUrlResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "live_urls", "next_cursor", "total_count")
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardLiveUrlError), graphql_name="errors"
)
live_urls = sgqlc.types.Field(
sgqlc.types.list_of(DashboardLiveUrl), graphql_name="liveUrls"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")316. DashboardMarkdownWidgetConfiguration¶
Configuration for visualization type ‘viz.markdown’
Available fields:
text: Markdown content of the widget.
class DashboardMarkdownWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("text",)
text = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="text")317. DashboardOwnerInfo¶
Information on the owner of a dashboard or page.
Available fields:
email: New Relic user email.userId: New Relic user ID.
class DashboardOwnerInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "user_id")
email = sgqlc.types.Field(String, graphql_name="email")
user_id = sgqlc.types.Field(Int, graphql_name="userId")318. DashboardPage¶
Page in a dashboard entity.
Available fields:
createdAt: Page creation timestamp.description: Brief text describing the page.guid: Unique entity identifier.name: The name of the page.owner: Information of the user that owns the page.updatedAt: Page update timestamp.widgets: A nested block of all widgets belonging to the page.
class DashboardPage(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"description",
"guid",
"name",
"owner",
"updated_at",
"widgets",
)
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
description = sgqlc.types.Field(String, graphql_name="description")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
name = sgqlc.types.Field(String, graphql_name="name")
owner = sgqlc.types.Field(DashboardOwnerInfo, graphql_name="owner")
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
widgets = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidget"), graphql_name="widgets"
)319. DashboardPieWidgetConfiguration¶
Configuration for visualization type ‘viz.pie’
Available fields:
nrqlQueries: NRQL queries.
class DashboardPieWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries",)
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)320. DashboardResetLiveUrlPasswordResult¶
Live URL reset password result.
Available fields:
password: The newly generated password for the Live URL
class DashboardResetLiveUrlPasswordResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("password",)
password = sgqlc.types.Field(
sgqlc.types.non_null(SecureValue), graphql_name="password"
)321. DashboardRevokeLiveDashboardUrlResult¶
Result of revokeLiveUrl operation.
Available fields:
id: The unique identifier of the public live dashboard URL if revoked successfully, null otherwise.
class DashboardRevokeLiveDashboardUrlResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(ID, graphql_name="id")322. DashboardRevokeLiveUrlResult¶
Revoke live URL result.
Available fields:
errors: The list of errors, if any.uuid: The unique identifier of the public live URL if revoked successfully, null otherwise.
class DashboardRevokeLiveUrlResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "uuid")
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardLiveUrlError), graphql_name="errors"
)
uuid = sgqlc.types.Field(ID, graphql_name="uuid")323. DashboardTableWidgetConfiguration¶
Configuration for visualization type ‘viz.table’
Available fields:
nrqlQueries: NRQL queries.
class DashboardTableWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_queries",)
nrql_queries = sgqlc.types.Field(
sgqlc.types.list_of("DashboardWidgetNrqlQuery"), graphql_name="nrqlQueries"
)324. DashboardUndeleteError¶
Expected error types that can be returned by undelete operation.
Available fields:
description: Error description.type: Error type.
class DashboardUndeleteError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardUndeleteErrorType), graphql_name="type"
)325. DashboardUndeleteResult¶
Result of undelete operation.
Available fields:
errors: Expected errors while processing request. No errors means successful request.
class DashboardUndeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardUndeleteError), graphql_name="errors"
)326. DashboardUpdateError¶
Expected errors that can be returned by update operation.
Available fields:
description: Error description.type: Error type.
class DashboardUpdateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardUpdateErrorType), graphql_name="type"
)327. DashboardUpdatePageError¶
Expected errors that can be returned by updatePage operation.
Available fields:
description: Error description.type: Error type.
class DashboardUpdatePageError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardUpdatePageErrorType), graphql_name="type"
)328. DashboardUpdatePageResult¶
Result of updatePage operation.
Available fields:
errors: Expected errors while processing request. No errors means successful request.
class DashboardUpdatePageResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardUpdatePageError), graphql_name="errors"
)329. DashboardUpdateResult¶
Result of update operation.
Available fields:
entityResult: Dashboard update result.errors: Expected errors while processing request.
class DashboardUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity_result", "errors")
entity_result = sgqlc.types.Field(
DashboardEntityResult, graphql_name="entityResult"
)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardUpdateError), graphql_name="errors"
)330. DashboardUpdateWidgetsInPageError¶
Expected errors that can be returned by updateWidgetsInPage operation.
Available fields:
description: Error description.type: Error type.
class DashboardUpdateWidgetsInPageError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(String, graphql_name="description")
type = sgqlc.types.Field(
sgqlc.types.non_null(DashboardUpdateWidgetsInPageErrorType), graphql_name="type"
)331. DashboardUpdateWidgetsInPageResult¶
Result of updateWidgetsInPage operation.
Available fields:
errors: Expected errors while processing request. No errors means successful request.
class DashboardUpdateWidgetsInPageResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(DashboardUpdateWidgetsInPageError), graphql_name="errors"
)332. DashboardVariable¶
Definition of a variable that is local to this dashboard. Variables are placeholders for dynamic values in widget NRQLs.
Available fields:
defaultValues: Default values for this variable. The actual value to be used will depend on the type.isMultiSelection: Indicates whether this variable supports multiple selection or not. Only applies to variables of type NRQL or ENUM.items: List of possible values for variables of type ENUM.name: Variable identifier.nrqlQuery: Configuration for variables of type NRQL.options: Options applied to the variable.replacementStrategy: Indicates the strategy to apply when replacing a variable in a NRQL query.title: Human-friendly display string for this variable.type: Specifies the data type of the variable and where its possible values may come from.
class DashboardVariable(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"default_values",
"is_multi_selection",
"items",
"name",
"nrql_query",
"options",
"replacement_strategy",
"title",
"type",
)
default_values = sgqlc.types.Field(
sgqlc.types.list_of("DashboardVariableDefaultItem"),
graphql_name="defaultValues",
)
is_multi_selection = sgqlc.types.Field(Boolean, graphql_name="isMultiSelection")
items = sgqlc.types.Field(
sgqlc.types.list_of("DashboardVariableEnumItem"), graphql_name="items"
)
name = sgqlc.types.Field(String, graphql_name="name")
nrql_query = sgqlc.types.Field(
"DashboardVariableNrqlQuery", graphql_name="nrqlQuery"
)
options = sgqlc.types.Field("DashboardVariableOptions", graphql_name="options")
replacement_strategy = sgqlc.types.Field(
DashboardVariableReplacementStrategy, graphql_name="replacementStrategy"
)
title = sgqlc.types.Field(String, graphql_name="title")
type = sgqlc.types.Field(DashboardVariableType, graphql_name="type")333. DashboardVariableDefaultItem¶
Represents a possible default value item.
Available fields:
value: The value of this default item.
class DashboardVariableDefaultItem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("value",)
value = sgqlc.types.Field("DashboardVariableDefaultValue", graphql_name="value")334. DashboardVariableDefaultValue¶
Specifies a default value for variables.
Available fields:
string: Default string value.
class DashboardVariableDefaultValue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("string",)
string = sgqlc.types.Field(String, graphql_name="string")335. DashboardVariableEnumItem¶
Represents a possible value for a variable of type ENUM.
Available fields:
title: A human-friendly display string for this value.value: A possible variable value.
class DashboardVariableEnumItem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("title", "value")
title = sgqlc.types.Field(String, graphql_name="title")
value = sgqlc.types.Field(String, graphql_name="value")336. DashboardVariableNrqlQuery¶
Configuration for variables of type NRQL.
Available fields:
accountIds: New Relic account ID(s) to issue the query against.query: NRQL formatted query.
class DashboardVariableNrqlQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids", "query")
account_ids = sgqlc.types.Field(sgqlc.types.list_of(Int), graphql_name="accountIds")
query = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="query")337. DashboardVariableOptions¶
Options applied to the variable.
Available fields:
excluded: With this turned on, query condition defined with the variable will not be included in the query.hiddenOnVariablesBar: Controls whether this variable is visible in the UI when not in edit mode.ignoreTimeRange: Only applies to variables of type NRQL. With this turned on, the time range for the NRQL query will override the time picker on dashboards and other pages. Turn this off to use the time picker as normal.showApplyAction: Determines whether or not an Apply action will be shown when selecting multiple values in ENUM and NRQL variables.
class DashboardVariableOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"excluded",
"hidden_on_variables_bar",
"ignore_time_range",
"show_apply_action",
)
excluded = sgqlc.types.Field(Boolean, graphql_name="excluded")
hidden_on_variables_bar = sgqlc.types.Field(
Boolean, graphql_name="hiddenOnVariablesBar"
)
ignore_time_range = sgqlc.types.Field(Boolean, graphql_name="ignoreTimeRange")
show_apply_action = sgqlc.types.Field(Boolean, graphql_name="showApplyAction")338. DashboardWidget¶
Widgets in a Dashboard Page.
Available fields:
configuration: Typed widgets are area, bar, billboard, line, markdown, pie, and table.description: A description of the widget, will be displayed in a tooltip.id: ID of the widget.layout: The widget’s position and size in the dashboard.link: Link configuration for the widget. The URL will be rendered as a clickable link.linkedEntities: Entities related to the widget. Currently only supports one Dashboard entity guid, but may allow other cases in the future.rawConfiguration: Untyped widgets are all other widgets, such as bullet, histogram, inventory, etc.title: A title for the widget.visualization: Specifies how this widget will be visualized.
class DashboardWidget(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"configuration",
"description",
"id",
"layout",
"link",
"linked_entities",
"raw_configuration",
"title",
"visualization",
)
configuration = sgqlc.types.Field(
"DashboardWidgetConfiguration", graphql_name="configuration"
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
layout = sgqlc.types.Field("DashboardWidgetLayout", graphql_name="layout")
link = sgqlc.types.Field("DashboardWidgetLink", graphql_name="link")
linked_entities = sgqlc.types.Field(
sgqlc.types.list_of(EntityOutline), graphql_name="linkedEntities"
)
raw_configuration = sgqlc.types.Field(
sgqlc.types.non_null(DashboardWidgetRawConfiguration),
graphql_name="rawConfiguration",
)
title = sgqlc.types.Field(String, graphql_name="title")
visualization = sgqlc.types.Field(
sgqlc.types.non_null("DashboardWidgetVisualization"),
graphql_name="visualization",
)339. DashboardWidgetConfiguration¶
Typed configuration for known visualizations. Only one (at most) will be populated for a given widget.
Available fields:
area: Configuration for visualization type ‘viz.area’bar: Configuration for visualization type ‘viz.bar’billboard: Configuration for visualization type ‘viz.billboard’line: Configuration for visualization type ‘viz.line’markdown: Configuration for visualization type ‘viz.markdown’pie: Configuration for visualization type ‘viz.pie’table: Configuration for visualization type ‘viz.table’
class DashboardWidgetConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("area", "bar", "billboard", "line", "markdown", "pie", "table")
area = sgqlc.types.Field(DashboardAreaWidgetConfiguration, graphql_name="area")
bar = sgqlc.types.Field(DashboardBarWidgetConfiguration, graphql_name="bar")
billboard = sgqlc.types.Field(
DashboardBillboardWidgetConfiguration, graphql_name="billboard"
)
line = sgqlc.types.Field(DashboardLineWidgetConfiguration, graphql_name="line")
markdown = sgqlc.types.Field(
DashboardMarkdownWidgetConfiguration, graphql_name="markdown"
)
pie = sgqlc.types.Field(DashboardPieWidgetConfiguration, graphql_name="pie")
table = sgqlc.types.Field(DashboardTableWidgetConfiguration, graphql_name="table")340. DashboardWidgetLayout¶
Widget layout.
Available fields:
column: Column position of widget from top left, starting at 1.height: Height of the widget. Valid values are 1 to 12 inclusive. Defaults to 3.row: Row position of widget from top left, starting at 1.width: Width of the widget. Valid values are 1 to 12 inclusive. Defaults to 4.
class DashboardWidgetLayout(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("column", "height", "row", "width")
column = sgqlc.types.Field(Int, graphql_name="column")
height = sgqlc.types.Field(Int, graphql_name="height")
row = sgqlc.types.Field(Int, graphql_name="row")
width = sgqlc.types.Field(Int, graphql_name="width")341. DashboardWidgetLink¶
Configuration for a link displayed in the widget. The URL is rendered as a clickable link in the widget, allowing users to navigate to related resources or documentation.
Available fields:
url: The target URL for the link.
class DashboardWidgetLink(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")342. DashboardWidgetNrqlQuery¶
Single NRQL query for a widget.
Available fields:
accountId: New Relic account ID to issue the query against.query: NRQL formatted query.
class DashboardWidgetNrqlQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "query")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
query = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="query")343. DashboardWidgetVisualization¶
Visualization configuration.
Available fields:
id: This field can either have a known type likeviz.areaor<nerdpack-id>.<visualization-id>in the case of custom visualizations.
class DashboardWidgetVisualization(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(String, graphql_name="id")344. DataAccessPolicy¶
Represents a data access policy entity.
Available fields:
assigned: The assigned status of the policy.id: The unique identifier of the policy.name: The name of the policy.organizationId: The ID of the organization associated with the policy.policy: The policy details and configuration.status: The status of the policy.version: The version of the policy.
class DataAccessPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"assigned",
"id",
"name",
"organization_id",
"policy",
"status",
"version",
)
assigned = sgqlc.types.Field(
sgqlc.types.non_null(DataAccessPolicyAssignedStatus), graphql_name="assigned"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
policy = sgqlc.types.Field(DataAccessPolicyRawDocument, graphql_name="policy")
status = sgqlc.types.Field(
sgqlc.types.non_null(DataAccessPolicyStatus), graphql_name="status"
)
version = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="version")345. DataAccessPolicyCollection¶
Paginated collection of data access policies.
Available fields:
items: The list of data access policies in the current page.nextCursor: The cursor for the next page of results.totalCount: The total count of data access policies matching the query.
class DataAccessPolicyCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of(DataAccessPolicy), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")346. DataAccessPolicyCreatePayload¶
Response payload for the createDataAccessPolicy mutation.
Available fields:
dataAccessPolicy: The newly created data access policy.
class DataAccessPolicyCreatePayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_access_policy",)
data_access_policy = sgqlc.types.Field(
DataAccessPolicy, graphql_name="dataAccessPolicy"
)347. DataAccessPolicyDeletePayload¶
Response payload for the deleteDataAccessPolicy mutation.
Available fields:
dataAccessPolicy: The deleted data access policy.
class DataAccessPolicyDeletePayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_access_policy",)
data_access_policy = sgqlc.types.Field(
DataAccessPolicy, graphql_name="dataAccessPolicy"
)348. DataAccessPolicyUpdatePayload¶
Response payload for the updateDataAccessPolicy mutation.
Available fields:
dataAccessPolicy: The updated data access policy.
class DataAccessPolicyUpdatePayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_access_policy",)
data_access_policy = sgqlc.types.Field(
DataAccessPolicy, graphql_name="dataAccessPolicy"
)349. DataDictionaryAttribute¶
Attribute object that contains data about the attribute
Available fields:
definition: Description of what this attribute represents, how it’s measured, etcdocsUrl: URL of this attribute on the New Relic docs siteevents: List of events using this attributename: The official name of this attributeunits: Unit this attribute is measuring (if applicable)
class DataDictionaryAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition", "docs_url", "events", "name", "units")
definition = sgqlc.types.Field(
sgqlc.types.non_null(String),
graphql_name="definition",
args=sgqlc.types.ArgDict(
(
(
"format",
sgqlc.types.Arg(
DataDictionaryTextFormat, graphql_name="format", default="PLAIN"
),
),
)
),
)
docs_url = sgqlc.types.Field(String, graphql_name="docsUrl")
events = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="events",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
units = sgqlc.types.Field("DataDictionaryUnit", graphql_name="units")350. DataDictionaryDataSource¶
The source generating the event data
Available fields:
name: Name of the source
class DataDictionaryDataSource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name",)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")351. DataDictionaryDocsStitchedFields¶
Event data definitions, where they come from, and information about the attributes they contain
Available fields:
events: List of events
class DataDictionaryDocsStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("events",)
events = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("DataDictionaryEvent")),
graphql_name="events",
args=sgqlc.types.ArgDict(
(
(
"names",
sgqlc.types.Arg(
sgqlc.types.list_of(String), graphql_name="names", default=None
),
),
)
),
)
"""Arguments:
* `names` (`[String]`): The official name of this event
"""352. DataDictionaryEvent¶
Event object that contains data about the event and its attributes
Available fields:
attributes: List of attributes in this eventdataSources: List of places where this event comes fromdefinition: A description of the eventname: The official name of this event
class DataDictionaryEvent(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "data_sources", "definition", "name")
attributes = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(DataDictionaryAttribute))
),
graphql_name="attributes",
)
data_sources = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(DataDictionaryDataSource))
),
graphql_name="dataSources",
)
definition = sgqlc.types.Field(
String,
graphql_name="definition",
args=sgqlc.types.ArgDict(
(
(
"format",
sgqlc.types.Arg(
DataDictionaryTextFormat, graphql_name="format", default="PLAIN"
),
),
)
),
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")353. DataDictionaryUnit¶
The unit of measurement
Available fields:
label: Name and abbreviation (if applicable) of the unit
class DataDictionaryUnit(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("label",)
label = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="label")354. DataManagementAccountLimit¶
Account Limit
Available fields:
category: Category for the limitdescription: Description of the uses for this limitdocumentationLink: Link to documentation for this limitlimitReachedBehaviorDescription: What happens when the limit is reached?name: Unique name for the limittimeInterval: Time between limit resetstype: Type of limit for aggregation and reportingunit: Unit for the limit valuevalue: Value for the limit
class DataManagementAccountLimit(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"category",
"description",
"documentation_link",
"limit_reached_behavior_description",
"name",
"time_interval",
"type",
"unit",
"value",
)
category = sgqlc.types.Field(DataManagementCategory, graphql_name="category")
description = sgqlc.types.Field(String, graphql_name="description")
documentation_link = sgqlc.types.Field(String, graphql_name="documentationLink")
limit_reached_behavior_description = sgqlc.types.Field(
String, graphql_name="limitReachedBehaviorDescription"
)
name = sgqlc.types.Field(String, graphql_name="name")
time_interval = sgqlc.types.Field(Nrql, graphql_name="timeInterval")
type = sgqlc.types.Field(DataManagementType, graphql_name="type")
unit = sgqlc.types.Field(DataManagementUnit, graphql_name="unit")
value = sgqlc.types.Field(Int, graphql_name="value")355. DataManagementAccountStitchedFields¶
Available fields:
customizableRetention: List all customizable event namespaceseventRetentionPolicies: Get the event retention policies for an accounteventRetentionRule: Get the event retention rule for a namespace on an account, if it existseventRetentionRules: List all the event retention rules for an accountfeatureSettings: Query for all feature settingslimits: Query for all limitsretentionAudit: Audit of retention values per namespace for an accountretentions: List of all namespaces
class DataManagementAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"customizable_retention",
"event_retention_policies",
"event_retention_rule",
"event_retention_rules",
"feature_settings",
"limits",
"retention_audit",
"retentions",
)
customizable_retention = sgqlc.types.Field(
"DataManagementCustomizableRetention", graphql_name="customizableRetention"
)
event_retention_policies = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementRenderedRetention"),
graphql_name="eventRetentionPolicies",
)
event_retention_rule = sgqlc.types.Field(
"DataManagementRule",
graphql_name="eventRetentionRule",
args=sgqlc.types.ArgDict(
(
(
"namespace",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="namespace",
default=None,
),
),
)
),
)
event_retention_rules = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementRule"), graphql_name="eventRetentionRules"
)
feature_settings = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementFeatureSetting"),
graphql_name="featureSettings",
)
limits = sgqlc.types.Field(
sgqlc.types.list_of(DataManagementAccountLimit), graphql_name="limits"
)
retention_audit = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementRetentionValues"),
graphql_name="retentionAudit",
)
retentions = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementRetention"), graphql_name="retentions"
)356. DataManagementAppliedRules¶
Applied rules
Available fields:
accountId: The account id for namespace ruleretentionInDays: Length of time data will be retained (in days)
class DataManagementAppliedRules(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "retention_in_days")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
retention_in_days = sgqlc.types.Field(Int, graphql_name="retentionInDays")357. DataManagementBulkCopyResult¶
Result for bulk retention copy to an account
Available fields:
failure: The failure destination accountssuccess: The successful destination accounts
class DataManagementBulkCopyResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failure", "success")
failure = sgqlc.types.Field(sgqlc.types.list_of(Int), graphql_name="failure")
success = sgqlc.types.Field(sgqlc.types.list_of(Int), graphql_name="success")358. DataManagementCustomizableRetention¶
Wrapper object for customizable retention namespaces
Available fields:
eventNamespaces: List of customizable event namespaces
class DataManagementCustomizableRetention(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("event_namespaces",)
event_namespaces = sgqlc.types.Field(
sgqlc.types.list_of("DataManagementEventNamespaces"),
graphql_name="eventNamespaces",
)359. DataManagementEventNamespaces¶
Event namespace
Available fields:
maxRetentionInDays: The upper limit for the retention valueminRetentionInDays: The lower limit for the retention valuenamespace: The name of a namespace
class DataManagementEventNamespaces(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("max_retention_in_days", "min_retention_in_days", "namespace")
max_retention_in_days = sgqlc.types.Field(Int, graphql_name="maxRetentionInDays")
min_retention_in_days = sgqlc.types.Field(Int, graphql_name="minRetentionInDays")
namespace = sgqlc.types.Field(String, graphql_name="namespace")360. DataManagementFeatureSetting¶
Feature Setting
Available fields:
enabled: Enabled state for the feature settingkey: Key to identify the feature settinglocked: Locked state for the feature settingname: Unique name for the feature setting
class DataManagementFeatureSetting(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "key", "locked", "name")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
key = sgqlc.types.Field(String, graphql_name="key")
locked = sgqlc.types.Field(Boolean, graphql_name="locked")
name = sgqlc.types.Field(String, graphql_name="name")361. DataManagementLimit¶
Limit
Available fields:
category: Category for the limitdescription: Description of the uses for this limitdocumentationLink: Link to documentation for this limitlimitReachedBehaviorDescription: What happens when the limit is reached?name: Unique name for the limittimeInterval: Time between limit resetstype: Type of limit for aggregation and reporting
class DataManagementLimit(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"category",
"description",
"documentation_link",
"limit_reached_behavior_description",
"name",
"time_interval",
"type",
)
category = sgqlc.types.Field(DataManagementCategory, graphql_name="category")
description = sgqlc.types.Field(String, graphql_name="description")
documentation_link = sgqlc.types.Field(String, graphql_name="documentationLink")
limit_reached_behavior_description = sgqlc.types.Field(
String, graphql_name="limitReachedBehaviorDescription"
)
name = sgqlc.types.Field(String, graphql_name="name")
time_interval = sgqlc.types.Field(Nrql, graphql_name="timeInterval")
type = sgqlc.types.Field(DataManagementType, graphql_name="type")362. DataManagementLimitOverride¶
Limit Override for an organization
Available fields:
enforceViolations: Whether violations should be enforced for this overrideisDefaultOverride: Whether this override is the default for users in the organizationlimit: The limit associated with this overrideorganizationId: The id of the organization for which this override appliesoverrideReason: The reason for the overrideoverrideValue: The overridden value for the limituserId: The id of the user for whom this override applies
class DataManagementLimitOverride(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"enforce_violations",
"is_default_override",
"limit",
"organization_id",
"override_reason",
"override_value",
"user_id",
)
enforce_violations = sgqlc.types.Field(Boolean, graphql_name="enforceViolations")
is_default_override = sgqlc.types.Field(Boolean, graphql_name="isDefaultOverride")
limit = sgqlc.types.Field(DataManagementLimit, graphql_name="limit")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
override_reason = sgqlc.types.Field(String, graphql_name="overrideReason")
override_value = sgqlc.types.Field(Int, graphql_name="overrideValue")
user_id = sgqlc.types.Field(Int, graphql_name="userId")363. DataManagementNamespaceLevelRetention¶
Namespace level retention
Available fields:
retentionInDays: Length of time data will be retained (in days)
class DataManagementNamespaceLevelRetention(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("retention_in_days",)
retention_in_days = sgqlc.types.Field(Int, graphql_name="retentionInDays")364. DataManagementOrganizationStitchedFields¶
Available fields:
limitOverride: Query limit for a specific user within an organizationlistLimitOverrides: List Limit Overrides for an organization
class DataManagementOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("limit_override", "list_limit_overrides")
limit_override = sgqlc.types.Field(
DataManagementLimitOverride,
graphql_name="limitOverride",
args=sgqlc.types.ArgDict(
(
(
"is_default_override",
sgqlc.types.Arg(
Boolean, graphql_name="isDefaultOverride", default=None
),
),
(
"limit",
sgqlc.types.Arg(
sgqlc.types.non_null(DataManagementLimitLookupInput),
graphql_name="limit",
default=None,
),
),
("user_id", sgqlc.types.Arg(Int, graphql_name="userId", default=None)),
)
),
)
"""Arguments:
* `is_default_override` (`Boolean`): Set to true, without user_id,
to lookup the default user override for the organization
* `limit` (`DataManagementLimitLookupInput!`): Unique limit
identifier
* `user_id` (`Int`): The user within the organization for this
override
"""
list_limit_overrides = sgqlc.types.Field(
sgqlc.types.list_of(DataManagementLimitOverride),
graphql_name="listLimitOverrides",
args=sgqlc.types.ArgDict(
(
(
"limit",
sgqlc.types.Arg(
sgqlc.types.non_null(DataManagementLimitLookupInput),
graphql_name="limit",
default=None,
),
),
)
),
)
"""Arguments:
* `limit` (`DataManagementLimitLookupInput!`): Unique limit
identifier
"""365. DataManagementRenderedRetention¶
An account’s current retention values for a namespace
Available fields:
accountId: The account id for the event retentionnamespace: The namespace for the event retentionnamespaceLevelRetention: Base retention value for an event namespaceupdatedAt: The UNIX timestamp when the retention was last updated
class DataManagementRenderedRetention(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"namespace",
"namespace_level_retention",
"updated_at",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
namespace_level_retention = sgqlc.types.Field(
DataManagementNamespaceLevelRetention, graphql_name="namespaceLevelRetention"
)
updated_at = sgqlc.types.Field(EpochSeconds, graphql_name="updatedAt")366. DataManagementRetention¶
Wrapper object for retention namespaces
Available fields:
customizable: Is this field customizable?displayName: The name as displayed in the UImaxRetentionInDays: The upper limit for the retention valueminRetentionInDays: The lower limit for the retention valuenamespace: The name of a namespacesource: The source of the namespace
class DataManagementRetention(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"customizable",
"display_name",
"max_retention_in_days",
"min_retention_in_days",
"namespace",
"source",
)
customizable = sgqlc.types.Field(Boolean, graphql_name="customizable")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
max_retention_in_days = sgqlc.types.Field(Int, graphql_name="maxRetentionInDays")
min_retention_in_days = sgqlc.types.Field(Int, graphql_name="minRetentionInDays")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
source = sgqlc.types.Field(String, graphql_name="source")367. DataManagementRetentionValues¶
Wrapper object for namespace retention values
Available fields:
appliedRules: List of rules applied to a namespacenamespace: The name of a namespacesubscriptionRetentionInDays: The retention value from the subscription (in days)
class DataManagementRetentionValues(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("applied_rules", "namespace", "subscription_retention_in_days")
applied_rules = sgqlc.types.Field(
sgqlc.types.list_of(DataManagementAppliedRules), graphql_name="appliedRules"
)
namespace = sgqlc.types.Field(String, graphql_name="namespace")
subscription_retention_in_days = sgqlc.types.Field(
Int, graphql_name="subscriptionRetentionInDays"
)368. DataManagementRule¶
A rule for setting a data retention value for a particular event namespace on an account
Available fields:
createdAt: The UNIX timestamp when the event retention rule went into effectcreatedById: The New Relic ID of the user who created the event retention ruledeletedAt: The UNIX timestamp when the event retention rule was deleteddeletedById: The New Relic ID of the user who deleted the event retention ruleid: The event retention rule’s unique identifiernamespace: The namespace the event retention rule applies toretentionInDays: Length of time data will be retained (in days)
class DataManagementRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by_id",
"deleted_at",
"deleted_by_id",
"id",
"namespace",
"retention_in_days",
)
created_at = sgqlc.types.Field(EpochSeconds, graphql_name="createdAt")
created_by_id = sgqlc.types.Field(Int, graphql_name="createdById")
deleted_at = sgqlc.types.Field(EpochSeconds, graphql_name="deletedAt")
deleted_by_id = sgqlc.types.Field(Int, graphql_name="deletedById")
id = sgqlc.types.Field(ID, graphql_name="id")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
retention_in_days = sgqlc.types.Field(Int, graphql_name="retentionInDays")369. DataSourceGapsActorStitchedFields¶
Available fields:
gaps: Retrieve data source gaps that match the provided query.
If no query is provided, data source gaps from all authorized accounts will be included.
class DataSourceGapsActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("gaps",)
gaps = sgqlc.types.Field(
"DataSourceGapsGapsResult",
graphql_name="gaps",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"query",
sgqlc.types.Arg(
DataSourceGapsGapsQuery, graphql_name="query", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): The cursor used to fetch paginated results.
* `query` (`DataSourceGapsGapsQuery`): The query parameters used
to filter data source gaps.
"""370. DataSourceGapsGap¶
A single data source gap associated with an account. The data source gap may also include a specific entity, but not always.
Available fields:
account: The account associated with the data source gap.detectedAt: The time when the data source gap was first detected.entity: The entity associated with the data source gap.gapType: The type of the data source gap.
class DataSourceGapsGap(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account", "detected_at", "entity", "gap_type")
account = sgqlc.types.Field(AccountReference, graphql_name="account")
detected_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="detectedAt"
)
entity = sgqlc.types.Field(EntityOutline, graphql_name="entity")
gap_type = sgqlc.types.Field(
sgqlc.types.non_null("DataSourceGapsGapType"), graphql_name="gapType"
)371. DataSourceGapsGapType¶
A descriptor of the data source needing instrumentation.
Available fields:
dataSourceId: The unique identifier of the data source associated with this gap type. This can be used with theactor.nr1Catalog.dataSourcefield.displayName: The human-readable name of this data source gap type.id: The unique identifier of this data source gap type.
class DataSourceGapsGapType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_source_id", "display_name", "id")
data_source_id = sgqlc.types.Field(ID, graphql_name="dataSourceId")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
id = sgqlc.types.Field(
sgqlc.types.non_null(DataSourceGapsGapTypeIdentifier), graphql_name="id"
)372. DataSourceGapsGapsResult¶
A data structure that contains the detailed response of a query for data source gaps.
The direct query result is available through results.
Available fields:
nextCursor: The cursor used to fetch the next set of paginated results.results: The list of data source gaps that match the provided query.totalCount: The total number of data source gaps that match the provided query, regardless of pagination.
class DataSourceGapsGapsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(DataSourceGapsGap)),
graphql_name="results",
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")373. DistributedTracingActorStitchedFields¶
Available fields:
trace: Look up the details of a trace based upon the traceId and optional start time.traceSummaries: Look up a summary of traces based upon a collection of trace IDs and time window.
class DistributedTracingActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("trace", "trace_summaries")
trace = sgqlc.types.Field(
"DistributedTracingTrace",
graphql_name="trace",
args=sgqlc.types.ArgDict(
(
(
"timestamp",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="timestamp", default=None
),
),
(
"trace_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="traceId",
default=None,
),
),
)
),
)
"""Arguments:
* `timestamp` (`EpochMilliseconds`): The start time of the trace.
This will default to 1 hour ago and will look for traces within
that window. If you are looking for a preserved trace then it is
required to pass in a timestamp.
* `trace_id` (`String!`): Unique identifier shared by all spans
within a single trace.
"""
trace_summaries = sgqlc.types.Field(
sgqlc.types.list_of("DistributedTracingTraceSummary"),
graphql_name="traceSummaries",
args=sgqlc.types.ArgDict(
(
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
(
"trace_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(String))
),
graphql_name="traceIds",
default=None,
),
),
)
),
)
"""Arguments:
* `time_window` (`TimeWindowInput`): A time window to query traces
for. If not provided, defaults to the last 30 minutes.
* `trace_ids` (`[String!]!`): A collection of trace IDs to query
for.
"""374. DistributedTracingEntityTracingSummary¶
Details tracing summary data for the provided EntityGuid that occurred during the provided startTime and endTime
Available fields:
errorTraceCount: The number of traces where this entity produced an errorpercentOfAllErrorTraces: The percentage of error traces produced by this entity compared to all error traces in the system
class DistributedTracingEntityTracingSummary(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_trace_count", "percent_of_all_error_traces")
error_trace_count = sgqlc.types.Field(Int, graphql_name="errorTraceCount")
percent_of_all_error_traces = sgqlc.types.Field(
Float, graphql_name="percentOfAllErrorTraces"
)375. DistributedTracingLinkedSpan¶
The SpanLinks type defines connections between spans of different traces, including identifiers and timestamps.
Available fields:
spanId: Unique Identifier of the linked span facilitating the link between traces.timestamp: The timestamp when the link was created, represented in milliseconds since the Unix epoch.traceId: The unique identifier for the trace containing the linked span.
class DistributedTracingLinkedSpan(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("span_id", "timestamp", "trace_id")
span_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="spanId")
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
trace_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="traceId")376. DistributedTracingSpan¶
The primary building block of a distributed trace. An individual unit of work.
Available fields:
attributes: All attributes for this span. This field is a map of string keys to attributes values.backwardSpanLinks: Span links are used to connect spans across traces. This field is a list of all backward span links for this span.clientType: When the span represents a call to another entity, clientType indicates the type of the entity that was called.durationMs: The duration of this span in milliseconds.entityGuid: Unique identifier for the entity that created this span. This value has a corresponding entry in the entities field of the trace.forwardSpanLinks: Span links are used to connect spans across traces. This field is a list of all forward span links for this span.id: Unique identifier for this span.name: The name of this span.parentId: The identifier of the caller of this span (null if this is the root span).processBoundary: The position of a span with respect to the boundaries between processes in the trace.spanAnomalies: Anomalies detected for this span, compared to similar spans that occurred over the previous hours before this span occurred.subcomponentEntityGuid: Unique identifier for the AI Agent/Tool entity that created this span. This value has a corresponding entry in the entities field of the trace.subcomponentEntityName: The name of the AI Agent/Tool entity name that created this span.timestamp: Epoch milliseconds timestamp represents this span’s start time.traceId: Unique identifier shared by all spans within a single trace.transactionName: The transaction name for this span.
class DistributedTracingSpan(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"attributes",
"backward_span_links",
"client_type",
"duration_ms",
"entity_guid",
"forward_span_links",
"id",
"name",
"parent_id",
"process_boundary",
"span_anomalies",
"subcomponent_entity_guid",
"subcomponent_entity_name",
"timestamp",
"trace_id",
"transaction_name",
)
attributes = sgqlc.types.Field(
DistributedTracingSpanAttributes, graphql_name="attributes"
)
backward_span_links = sgqlc.types.Field(
sgqlc.types.list_of(DistributedTracingLinkedSpan),
graphql_name="backwardSpanLinks",
)
client_type = sgqlc.types.Field(
DistributedTracingSpanClientType, graphql_name="clientType"
)
duration_ms = sgqlc.types.Field(Milliseconds, graphql_name="durationMs")
entity_guid = sgqlc.types.Field(String, graphql_name="entityGuid")
forward_span_links = sgqlc.types.Field(
sgqlc.types.list_of(DistributedTracingLinkedSpan),
graphql_name="forwardSpanLinks",
)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
parent_id = sgqlc.types.Field(String, graphql_name="parentId")
process_boundary = sgqlc.types.Field(
sgqlc.types.non_null(DistributedTracingSpanProcessBoundary),
graphql_name="processBoundary",
)
span_anomalies = sgqlc.types.Field(
sgqlc.types.list_of("DistributedTracingSpanAnomaly"),
graphql_name="spanAnomalies",
)
subcomponent_entity_guid = sgqlc.types.Field(
EntityGuid, graphql_name="subcomponentEntityGuid"
)
subcomponent_entity_name = sgqlc.types.Field(
String, graphql_name="subcomponentEntityName"
)
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
trace_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="traceId")
transaction_name = sgqlc.types.Field(String, graphql_name="transactionName")377. DistributedTracingSpanAnomaly¶
An anomaly detected with respect to an attribute of a span.
Available fields:
anomalousValue: The value of the span attribute which was detected as being anomalous.anomalyType: The attribute of the span which was detected as being anomalous.averageMeasure: The average value for the attribute on similar spans.
class DistributedTracingSpanAnomaly(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("anomalous_value", "anomaly_type", "average_measure")
anomalous_value = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="anomalousValue"
)
anomaly_type = sgqlc.types.Field(
sgqlc.types.non_null(DistributedTracingSpanAnomalyType),
graphql_name="anomalyType",
)
average_measure = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="averageMeasure"
)378. DistributedTracingSpanConnection¶
A relationship between a parent and child span.
Available fields:
child: The span identifier of the child for this connection.parent: The span identifier of the parent for this connection.
class DistributedTracingSpanConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("child", "parent")
child = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="child")
parent = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="parent")379. DistributedTracingTrace¶
A collection of spans with context describing those spans. The trace represents the complete processing of a request.
Available fields:
backendDurationMs: The duration in milliseconds for the back-end part of this trace (not from a client such as a Browser application)durationMs: The total duration of this trace in milliseconds.entities: All entities that are part of this trace.entityCount: The number of entities that are part of this trace.id: Unique identifier for this trace.sessionId: The client session ID associated with this trace.spanConnections: Parent/child IDs that represent all of the span relationships within this trace.spans: Spans associated with this trace. The maximum number of spans returned is limited to 10_000. This could be less than the actual number of spans sent for the trace.timestamp: Epoch milliseconds timestamp represents this trace’s start time.
class DistributedTracingTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"backend_duration_ms",
"duration_ms",
"entities",
"entity_count",
"id",
"session_id",
"span_connections",
"spans",
"timestamp",
)
backend_duration_ms = sgqlc.types.Field(
Milliseconds, graphql_name="backendDurationMs"
)
duration_ms = sgqlc.types.Field(Milliseconds, graphql_name="durationMs")
entities = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityOutline))),
graphql_name="entities",
)
entity_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="entityCount"
)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
session_id = sgqlc.types.Field(String, graphql_name="sessionId")
span_connections = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(DistributedTracingSpanConnection)),
graphql_name="spanConnections",
)
spans = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(DistributedTracingSpan))
),
graphql_name="spans",
)
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)380. DistributedTracingTraceSummary¶
Represents traceSummary of a trace
Available fields:
durationMs: The total duration of this trace in milliseconds.errorCount: The total number of errors across all spans within the trace.rootEntityGuid: Represents the root entity associated with a trace.timestamp: Epoch milliseconds timestamp represents this trace’s start time.traceId: Unique identifier shared by all spans within a single trace.
class DistributedTracingTraceSummary(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"duration_ms",
"error_count",
"root_entity_guid",
"timestamp",
"trace_id",
)
duration_ms = sgqlc.types.Field(
sgqlc.types.non_null(Milliseconds), graphql_name="durationMs"
)
error_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="errorCount"
)
root_entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="rootEntityGuid"
)
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
trace_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="traceId")381. DocumentationFields¶
Available fields:
agentReleases: View a list of all releases for the provided AgentcurrentAgentRelease: The current release of the provided AgentcurrentAgentReleases: The current releases for multiple agentsdataDictionary: This field provides access to DataDictionary data.knowledge: This field provides access to Knowledge data.timeZones: A list of all the Time Zones from the IANA tz databasewhatsNew: This field provides access to WhatsNew data.
class DocumentationFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"agent_releases",
"current_agent_release",
"current_agent_releases",
"data_dictionary",
"knowledge",
"time_zones",
"whats_new",
)
agent_releases = sgqlc.types.Field(
sgqlc.types.list_of(AgentReleasesAgentRelease),
graphql_name="agentReleases",
args=sgqlc.types.ArgDict(
(
(
"agent_name",
sgqlc.types.Arg(
sgqlc.types.non_null(AgentReleasesFilter),
graphql_name="agentName",
default=None,
),
),
(
"category",
sgqlc.types.Arg(String, graphql_name="category", default=None),
),
)
),
)
current_agent_release = sgqlc.types.Field(
AgentReleasesAgentRelease,
graphql_name="currentAgentRelease",
args=sgqlc.types.ArgDict(
(
(
"agent_name",
sgqlc.types.Arg(
sgqlc.types.non_null(AgentReleasesFilter),
graphql_name="agentName",
default=None,
),
),
(
"category",
sgqlc.types.Arg(String, graphql_name="category", default=None),
),
)
),
)
current_agent_releases = sgqlc.types.Field(
sgqlc.types.list_of(AgentReleasesAgentRelease),
graphql_name="currentAgentReleases",
args=sgqlc.types.ArgDict(
(
(
"agent_names",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(AgentReleasesFilter)
)
),
graphql_name="agentNames",
default=None,
),
),
(
"category",
sgqlc.types.Arg(String, graphql_name="category", default=None),
),
)
),
)
"""Arguments:
* `agent_names` (`[AgentReleasesFilter!]!`): List of agents to
fetch current releases for
* `category` (`String`): Optionally filter releases by category
"""
data_dictionary = sgqlc.types.Field(
DataDictionaryDocsStitchedFields, graphql_name="dataDictionary"
)
knowledge = sgqlc.types.Field(
"KnowledgeDocsStitchedFields", graphql_name="knowledge"
)
time_zones = sgqlc.types.Field(
sgqlc.types.list_of("TimeZoneInfo"), graphql_name="timeZones"
)
whats_new = sgqlc.types.Field("WhatsNewDocsStitchedFields", graphql_name="whatsNew")382. DomainType¶
Details about an entity type
Available fields:
domain: The domain of the entity.
The domain must be a value matching /[A-Z][A-Z0-9_]{2,14}/.
type: The type of the entity.
The type must be a value matching /[A-Z][A-Z0-9_]{2,49}/.
Some examples are APPLICATION, HOST or CONTAINER.
class DomainType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("domain", "type")
domain = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="domain")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")383. EdgeAccountStitchedFields¶
Available fields:
tracing: Provides access to Tracing data.
class EdgeAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("tracing",)
tracing = sgqlc.types.Field("EdgeTracing", graphql_name="tracing")384. EdgeCreateSpanAttributeRuleResponseError¶
Description of errors that may occur while attempting to create a span attribute trace filter rule.
Available fields:
message: Error message, with further detail to help resolve the issue.type: Error that may occur while attempting to create a trace filter rule.
class EdgeCreateSpanAttributeRuleResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeCreateSpanAttributeRuleResponseErrorType),
graphql_name="type",
)385. EdgeCreateSpanAttributeRulesResponse¶
Successfully created span attribute trace filter rule, or one or more error responses if there were issues.
Available fields:
errors: Errors that may occur when creating aSpanAttributeTraceFilter. Defaults tonullin case of success.rules: The trace filter rules that were created. Defaults tonullin case of failure.
class EdgeCreateSpanAttributeRulesResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rules")
errors = sgqlc.types.Field(
sgqlc.types.list_of(EdgeCreateSpanAttributeRuleResponseError),
graphql_name="errors",
)
rules = sgqlc.types.Field(
sgqlc.types.list_of("EdgeSpanAttributeRule"), graphql_name="rules"
)386. EdgeCreateTraceFilterRuleResponses¶
Array of responses, one for each span attribute trace filter rule creation request.
Available fields:
spanAttributeRules: Span attribute trace filter rule creation response
class EdgeCreateTraceFilterRuleResponses(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("span_attribute_rules",)
span_attribute_rules = sgqlc.types.Field(
sgqlc.types.non_null(EdgeCreateSpanAttributeRulesResponse),
graphql_name="spanAttributeRules",
)387. EdgeCreateTraceObserverResponse¶
Successfully created trace observers, or one or more error responses if there were issues.
Available fields:
errors: Errors that may occur when creating aTraceObserver. Defaults tonullin case of success.traceObserver: The trace observer defined inCreateTraceObserverInput. Defaults tonullin case of failure.
class EdgeCreateTraceObserverResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "trace_observer")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EdgeCreateTraceObserverResponseError"),
graphql_name="errors",
)
trace_observer = sgqlc.types.Field(
"EdgeTraceObserver", graphql_name="traceObserver"
)388. EdgeCreateTraceObserverResponseError¶
Description of errors that may occur while attempting to create a trace observer.
Available fields:
message: Error message, with further detail to help resolve the issue.type: Error that may occur while attempting to create a trace observer.
class EdgeCreateTraceObserverResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeCreateTraceObserverResponseErrorType),
graphql_name="type",
)389. EdgeCreateTraceObserverResponses¶
Array of responses, one for each trace observer creation request.
Available fields:
responses: Array of trace observer creation responses, one for eachCreateTraceObserverInput.
class EdgeCreateTraceObserverResponses(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("responses",)
responses = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeCreateTraceObserverResponse))
),
graphql_name="responses",
)390. EdgeDataSource¶
A data source (i.e., New Relic entity) that is associated with this trace observer. Currently, we support adding Browser, Lambda, and Mobile entities as data sources.
Available fields:
entity: The entity representing this data source.status: The status of whether data is being sent to this trace observer for this data source.
class EdgeDataSource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity", "status")
entity = sgqlc.types.Field(EntityOutline, graphql_name="entity")
status = sgqlc.types.Field(
sgqlc.types.non_null(EdgeDataSourceStatusType), graphql_name="status"
)391. EdgeDataSourceGroup¶
A group of data sources that are associated with this trace observer.
Available fields:
dataSources: The list of data sources in this group.
class EdgeDataSourceGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_sources",)
data_sources = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EdgeDataSource))),
graphql_name="dataSources",
)392. EdgeDeleteSpanAttributeRuleResponse¶
Successfully deleted span attribute trace filter rule, or one or more error responses if there were issues.
Available fields:
errors: Errors that may occur when deleting aSpanAttributeRule. Defaults tonullin case of success.rule: The trace filter rule that was deleted. Defaults tonullin case of failure.
class EdgeDeleteSpanAttributeRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EdgeDeleteSpanAttributeRuleResponseError"),
graphql_name="errors",
)
rule = sgqlc.types.Field("EdgeSpanAttributeRule", graphql_name="rule")393. EdgeDeleteSpanAttributeRuleResponseError¶
Description of errors that may occur while attempting to delete a span attribute trace filter.
Available fields:
message: Error message, with further detail to help resolve the issue.type: Error that may occur while attempting to delete a span attribute trace filter.
class EdgeDeleteSpanAttributeRuleResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeDeleteSpanAttributeRuleResponseErrorType),
graphql_name="type",
)394. EdgeDeleteTraceFilterRuleResponses¶
Array of responses, one for each trace filter rule deletion request
Available fields:
spanAttributeRules: Array of span attribute trace filter rule deletion responses, one for each id provided toDeleteTraceFilterRulesInput.
class EdgeDeleteTraceFilterRuleResponses(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("span_attribute_rules",)
span_attribute_rules = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EdgeDeleteSpanAttributeRuleResponse)
)
),
graphql_name="spanAttributeRules",
)395. EdgeDeleteTraceObserverResponse¶
Successfully deleted trace observers, or one or more error responses if there were issues.
Available fields:
errors: Errors that may occur when deleting aTraceObserver. Defaults tonullin case of success.traceObserver: The trace observer that was deleted. Defaults tonullin case of failure.
class EdgeDeleteTraceObserverResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "trace_observer")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EdgeDeleteTraceObserverResponseError"),
graphql_name="errors",
)
trace_observer = sgqlc.types.Field(
"EdgeTraceObserver", graphql_name="traceObserver"
)396. EdgeDeleteTraceObserverResponseError¶
Description of errors that may occur while attempting to delete a trace observer.
Available fields:
message: Error message, with further detail to help resolve the issue.type: Error that may occur while attempting to delete a trace observer.
class EdgeDeleteTraceObserverResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeDeleteTraceObserverResponseErrorType),
graphql_name="type",
)397. EdgeDeleteTraceObserverResponses¶
Array of responses, one for each trace observer deletion request.
Available fields:
responses: Array of trace observer deletion responses, one for eachDeleteTraceObserverInput.
class EdgeDeleteTraceObserverResponses(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("responses",)
responses = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeDeleteTraceObserverResponse))
),
graphql_name="responses",
)398. EdgeEndpoint¶
An Endpoint describes access to an endpoint pointing to a trace observer. Currently, only one endpoint per trace observer is supported.
Available fields:
agent: Connection information related to the agent configuration.endpointType: Type of the endpoint.https: Connection information related to the Infinite Tracing Trace API (HTTP 1.1) configuration.status: Status of the endpoint.
class EdgeEndpoint(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("agent", "endpoint_type", "https", "status")
agent = sgqlc.types.Field(
sgqlc.types.non_null("EdgeAgentEndpointDetail"), graphql_name="agent"
)
endpoint_type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeEndpointType), graphql_name="endpointType"
)
https = sgqlc.types.Field(
sgqlc.types.non_null("EdgeHttpsEndpointDetail"), graphql_name="https"
)
status = sgqlc.types.Field(
sgqlc.types.non_null(EdgeEndpointStatus), graphql_name="status"
)399. EdgeRandomTraceFilter¶
Contains all of the data that is used to sample traces based on random selection.
Available fields:
percentKept: The percent of traces to keep when selected at random.
class EdgeRandomTraceFilter(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("percent_kept",)
percent_kept = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="percentKept"
)400. EdgeSpanAttributeRule¶
A SpanAttributeRule applies a filtering rule (keep or discard) to traces within a particular TraceObserver
Available fields:
action: The action that this filter takes if it matches the provided attribute name and valueid: Globally unique identifier of this trace filter.key: Name of the attribute that this filter matches onkeyOperator: Type of match to apply to the attribute name (EQUALS, LIKE).value: Value of the attribute that this filter matches on.valueOperator: Type of match to apply to the attribute value (EQUALS, LIKE, IS_NOT_NULL).
class EdgeSpanAttributeRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("action", "id", "key", "key_operator", "value", "value_operator")
action = sgqlc.types.Field(
sgqlc.types.non_null(EdgeTraceFilterAction), graphql_name="action"
)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
key_operator = sgqlc.types.Field(
sgqlc.types.non_null(EdgeSpanAttributeKeyOperator), graphql_name="keyOperator"
)
value = sgqlc.types.Field(String, graphql_name="value")
value_operator = sgqlc.types.Field(
sgqlc.types.non_null(EdgeSpanAttributeValueOperator),
graphql_name="valueOperator",
)401. EdgeSpanAttributesTraceFilter¶
Contains all of the data that is used to sample traces based on their attributes.
Available fields:
spanAttributeRules: The list of rules that determine whether to keep or drop a trace based on a span attribute.
class EdgeSpanAttributesTraceFilter(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("span_attribute_rules",)
span_attribute_rules = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeSpanAttributeRule))
),
graphql_name="spanAttributeRules",
)402. EdgeTraceFilters¶
A container for all trace filter rule types
Available fields:
randomTraceFilter: Random trace filter configuration applied to the trace observer.spanAttributesTraceFilter: Span attribute trace filter configuration applied to the trace observer.
class EdgeTraceFilters(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("random_trace_filter", "span_attributes_trace_filter")
random_trace_filter = sgqlc.types.Field(
sgqlc.types.non_null(EdgeRandomTraceFilter), graphql_name="randomTraceFilter"
)
span_attributes_trace_filter = sgqlc.types.Field(
sgqlc.types.non_null(EdgeSpanAttributesTraceFilter),
graphql_name="spanAttributesTraceFilter",
)403. EdgeTraceObserver¶
A TraceObserver handles a group of tracing services for an account family.
Available fields:
complianceTypes: Optional list of compliance types (e.g., FedRAMP) applied to this trace observer.dataSourceGroup: The group of data sources if any have been assigned to this trace observer.endpoints: List of endpoints associated with this trace observer. Currently, only one endpoint per trace observer is supported.id: Globally unique identifier of this trace observer.monitoringAccountId: Which account monitoring metrics are being written to for this trace observer (if specified)name: Human-readable name of this trace observer.providerRegion: Provider-specific region of this endpoint (for example,AWS_US_EAST_1). Currently, only AWS regions are supported.status: Status of the trace observer.traceFilters: Trace filters applied to the trace observer.
class EdgeTraceObserver(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"compliance_types",
"data_source_group",
"endpoints",
"id",
"monitoring_account_id",
"name",
"provider_region",
"status",
"trace_filters",
)
compliance_types = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeComplianceTypeCode)),
graphql_name="complianceTypes",
)
data_source_group = sgqlc.types.Field(
EdgeDataSourceGroup, graphql_name="dataSourceGroup"
)
endpoints = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EdgeEndpoint))),
graphql_name="endpoints",
)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
monitoring_account_id = sgqlc.types.Field(Int, graphql_name="monitoringAccountId")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
provider_region = sgqlc.types.Field(
sgqlc.types.non_null(EdgeProviderRegion), graphql_name="providerRegion"
)
status = sgqlc.types.Field(
sgqlc.types.non_null(EdgeTraceObserverStatus), graphql_name="status"
)
trace_filters = sgqlc.types.Field(
sgqlc.types.non_null(EdgeTraceFilters), graphql_name="traceFilters"
)404. EdgeTracing¶
This field provides access to Tracing data.
Available fields:
traceObservers: Lists the existing trace observers for this account family.
class EdgeTracing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("trace_observers",)
trace_observers = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeTraceObserver)),
graphql_name="traceObservers",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(Int)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[Int!]`): Optional IDs of trace observers to return.
"""405. EdgeUpdateTraceObserverResponse¶
Successfully updated trace observers, or one or more error responses if there were issues.
Available fields:
errors: Errors that may occur when creating aTraceObserver. Defaults tonullin case of success.traceObserver: The trace observer defined inUpdateTraceObserverInput. Defaults tonullin case of failure.
class EdgeUpdateTraceObserverResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "trace_observer")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EdgeUpdateTraceObserverResponseError"),
graphql_name="errors",
)
trace_observer = sgqlc.types.Field(EdgeTraceObserver, graphql_name="traceObserver")406. EdgeUpdateTraceObserverResponseError¶
Description of errors that may occur while attempting to update a trace observer.
Available fields:
message: Error message, with further detail to help resolve the issue.type: Error that may occur while attempting to create a trace observer.
class EdgeUpdateTraceObserverResponseError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EdgeUpdateTraceObserverResponseErrorType),
graphql_name="type",
)407. EdgeUpdateTraceObserverResponses¶
Array of responses, one for each trace observer update request.
Available fields:
responses: Array of trace observer update responses, one for eachUpdateTraceObserverInput.
class EdgeUpdateTraceObserverResponses(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("responses",)
responses = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EdgeUpdateTraceObserverResponse))
),
graphql_name="responses",
)408. EntityAlertViolation¶
The alert violation for an entity
Available fields:
agentUrl: A link to the agent in the time window in which the violation occurred.alertSeverity: The severity of the violation.closedAt: Timestamp of when the violation was closed.label: The description of the violation.level: The priority of the violation.openedAt: Timestamp of when the violation was opened.violationId: The id of the violation.violationUrl: A link to the violation if it is connected to an incident.
class EntityAlertViolation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"agent_url",
"alert_severity",
"closed_at",
"label",
"level",
"opened_at",
"violation_id",
"violation_url",
)
agent_url = sgqlc.types.Field(String, graphql_name="agentUrl")
alert_severity = sgqlc.types.Field(
EntityAlertSeverity, graphql_name="alertSeverity"
)
closed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="closedAt")
label = sgqlc.types.Field(String, graphql_name="label")
level = sgqlc.types.Field(String, graphql_name="level")
opened_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="openedAt")
violation_id = sgqlc.types.Field(
EntityAlertViolationInt, graphql_name="violationId"
)
violation_url = sgqlc.types.Field(String, graphql_name="violationUrl")409. EntityCollection¶
A collection of user defined Entities and Entity Search queries.
Available fields:
account: The account the collection is part ofcreatedBy: The user who created the collectiondefinition: The definition of the collection.guid: The GUID of the Entitymembers: The result of searching for the members of the collection.name: The name of the collection.type: The type of Collection
class EntityCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"created_by",
"definition",
"guid",
"members",
"name",
"type",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
definition = sgqlc.types.Field(
"EntityCollectionDefinition", graphql_name="definition"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
members = sgqlc.types.Field("EntitySearch", graphql_name="members")
name = sgqlc.types.Field(String, graphql_name="name")
type = sgqlc.types.Field(EntityCollectionType, graphql_name="type")410. EntityCollectionDefinition¶
The definition of a collection.
Available fields:
entityGuids: A list of entity GUIDs. These entities will belong to the collection as long as their accounts are included in the scope accounts of the collection.entitySearchQuery: The Entity Search query that returns the full collection of entities.scopeAccounts: The Accounts that will be used to scope the collection.searchQueries: A list of entity search queries. The resulting entities will be limited to the scope accounts of the collection.
class EntityCollectionDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entity_guids",
"entity_search_query",
"scope_accounts",
"search_queries",
)
entity_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="entityGuids"
)
entity_search_query = sgqlc.types.Field(String, graphql_name="entitySearchQuery")
scope_accounts = sgqlc.types.Field(
"EntityCollectionScopeAccounts", graphql_name="scopeAccounts"
)
search_queries = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="searchQueries"
)411. EntityCollectionScopeAccounts¶
The Accounts used to scope a collection.
Available fields:
accountIds: The Account IDs that make up the account scoping.
class EntityCollectionScopeAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids",)
account_ids = sgqlc.types.Field(sgqlc.types.list_of(Int), graphql_name="accountIds")412. EntityDeleteError¶
Type that wraps the errors from a entity delete operation.
Available fields:
guid: Guid related to the error.message: User-friendly message describing the error.type: Describes all potential error types that a delete operation might return.
class EntityDeleteError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid", "message", "type")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityDeleteErrorType), graphql_name="type"
)413. EntityDeleteResult¶
Response type for delete operations over entities.
Available fields:
deletedEntities: List that contains the guids of the deleted entitiesfailures: List of failures for the delete operation.
class EntityDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deleted_entities", "failures")
deleted_entities = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))),
graphql_name="deletedEntities",
)
failures = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityDeleteError))
),
graphql_name="failures",
)414. EntityGoldenContext¶
An object that represent the context.
Available fields:
account: Account context.guid: Collection guid context.
class EntityGoldenContext(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account", "guid")
account = sgqlc.types.Field(Int, graphql_name="account")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")415. EntityGoldenContextScopedGoldenMetrics¶
An object that represents the golden metrics scoped by context
Available fields:
context: Context for the golden metricmetrics: Metrics for the domain and type
class EntityGoldenContextScopedGoldenMetrics(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("context", "metrics")
context = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenContext), graphql_name="context"
)
metrics = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("EntityGoldenMetric"))
),
graphql_name="metrics",
)416. EntityGoldenContextScopedGoldenTags¶
An object that represents the golden tags scoped by context
Available fields:
context: Context for the golden tagstags: Tags for the domain and type
class EntityGoldenContextScopedGoldenTags(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("context", "tags")
context = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenContext), graphql_name="context"
)
tags = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("EntityGoldenTag"))
),
graphql_name="tags",
)417. EntityGoldenGoldenMetricsError¶
The different error types in golden metrics
Available fields:
message: The error descriptiontype: An error type
class EntityGoldenGoldenMetricsError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenGoldenMetricsErrorType), graphql_name="type"
)418. EntityGoldenMetric¶
An object that represents a golden metric.
Available fields:
definition: The definition of the golden metric.metricName: The synthesised metric name. i.e: newrelic.goldenmetrics.apm.application.throughputname: The name of the golden metric.originalDefinitions: The definitions of the golden metric as they are defined in the public repo https://github .com /newrelic /entity -definitions. originalQueries: Original queries as they are defined in the public repo https://github .com /newrelic /entity -definitions. query: The golden metric NRQL query.title: The title of the golden metric.unit: The unit used to represent the golden metric.
class EntityGoldenMetric(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"definition",
"metric_name",
"name",
"original_definitions",
"original_queries",
"query",
"title",
"unit",
)
definition = sgqlc.types.Field(
sgqlc.types.non_null("EntityGoldenMetricDefinition"), graphql_name="definition"
)
metric_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="metricName"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
original_definitions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("EntityGoldenOriginalDefinitionWithSelector")
)
),
graphql_name="originalDefinitions",
)
original_queries = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("EntityGoldenOriginalQueryWithSelector")
)
),
graphql_name="originalQueries",
)
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")
title = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="title")
unit = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenMetricUnit), graphql_name="unit"
)419. EntityGoldenMetricDefinition¶
The definition of the metric.
Available fields:
eventId: The field used to filter the entity in the metric. This will be added to the WHERE by default.eventObjectId: Indicates if the eventId field references a GUID, a domainId or an entity name.facet: The field to FACET by.from: The FROM clause of the query.select: The SELECT clause of the query.where: If a complementary WHERE clause is required to identify the entity type this field will contain it.
class EntityGoldenMetricDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"event_id",
"event_object_id",
"facet",
"from_",
"select",
"where",
)
event_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="eventId")
event_object_id = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenEventObjectId), graphql_name="eventObjectId"
)
facet = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="facet")
from_ = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="from")
select = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="select")
where = sgqlc.types.Field(String, graphql_name="where")420. EntityGoldenMetricsDomainTypeScoped¶
An object that represents the golden metrics scoped by domain and type
Available fields:
context: Context for the golden metricdomainType: Domain type for the golden metricsmetrics: Metrics for the domain and type
class EntityGoldenMetricsDomainTypeScoped(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("context", "domain_type", "metrics")
context = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenContext), graphql_name="context"
)
domain_type = sgqlc.types.Field(
sgqlc.types.non_null(DomainType), graphql_name="domainType"
)
metrics = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGoldenMetric))
),
graphql_name="metrics",
)421. EntityGoldenMetricsDomainTypeScopedResponse¶
An object that represents the golden metrics scoped by domain and type mutation result
Available fields:
errors: The list of the errorsmetrics: The metrics results of the mutations
class EntityGoldenMetricsDomainTypeScopedResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "metrics")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGoldenGoldenMetricsError)),
graphql_name="errors",
)
metrics = sgqlc.types.Field(
EntityGoldenMetricsDomainTypeScoped, graphql_name="metrics"
)422. EntityGoldenOriginalDefinitionWithSelector¶
Represents a metric definition for a give metric selector value.
Available fields:
definition: The definition of the golden metric.selectorValue: The value of the selector. Currently, this is the value of the instrumentation provider.
class EntityGoldenOriginalDefinitionWithSelector(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition", "selector_value")
definition = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenMetricDefinition), graphql_name="definition"
)
selector_value = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="selectorValue"
)423. EntityGoldenOriginalQueryWithSelector¶
Object that represents a nrql metric with its metric selector
Available fields:
query: The golden metric NRQL query.selectorValue: The value of the selector. Currently, this is the value of the instrumentation provider.
class EntityGoldenOriginalQueryWithSelector(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("query", "selector_value")
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")
selector_value = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="selectorValue"
)424. EntityGoldenTag¶
An object that represents a golden tag.
Available fields:
key: The golden tag key.
class EntityGoldenTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key",)
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")425. EntityGoldenTagsDomainTypeScoped¶
An object that represents the golden tags scoped by domain and type
Available fields:
context: Context for the golden tagsdomainType: Domain type for the golden tagstags: Tags for the domain and type
class EntityGoldenTagsDomainTypeScoped(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("context", "domain_type", "tags")
context = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenContext), graphql_name="context"
)
domain_type = sgqlc.types.Field(
sgqlc.types.non_null(DomainType), graphql_name="domainType"
)
tags = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGoldenTag))
),
graphql_name="tags",
)426. EntityGoldenTagsDomainTypeScopedResponse¶
An object that represents the golden tags scoped by domain and type mutation result
Available fields:
errors: The list of the errorstags: The tags results of the mutations
class EntityGoldenTagsDomainTypeScopedResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "tags")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGoldenGoldenMetricsError)),
graphql_name="errors",
)
tags = sgqlc.types.Field(EntityGoldenTagsDomainTypeScoped, graphql_name="tags")427. EntityManagementActorStitchedFields¶
The ActorStitchedFields type.
Available fields:
collectionElements: Retrieves all elements of a Group entity.collectionsContainingEntity: Retrieves the collections containing the given entity.entity: Retrieves an entity.entitySearch: Retrieves a set of entities that match the given query predicate.
class EntityManagementActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"collection_elements",
"collections_containing_entity",
"entity",
"entity_search",
)
collection_elements = sgqlc.types.Field(
"EntityManagementCollectionElementsResult",
graphql_name="collectionElements",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementCollectionElementsFilter),
graphql_name="filter",
default=None,
),
),
("first", sgqlc.types.Arg(Int, graphql_name="first", default=100)),
)
),
)
"""Arguments:
* `cursor` (`String`): Pagination cursor. If not provided, the
first page of results will be returned.
* `filter` (`EntityManagementCollectionElementsFilter!`): The id
of the group entity.
* `first` (`Int`): Request the first n elements. Must be between 1
and 1000. Defaults to 100. (default: `100`)
"""
collections_containing_entity = sgqlc.types.Field(
sgqlc.types.list_of("EntityManagementCollectionsContainingEntityResult"),
graphql_name="collectionsContainingEntity",
args=sgqlc.types.ArgDict(
(
(
"entity_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="entityId", default=None
),
),
)
),
)
"""Arguments:
* `entity_id` (`ID!`): The entity id.
"""
entity = sgqlc.types.Field(
EntityManagementEntity,
graphql_name="entity",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be retrieved.
"""
entity_search = sgqlc.types.Field(
"EntityManagementEntitySearchResult",
graphql_name="entitySearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"query",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="query", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Pagination cursor. If not provided, the
first page of results will be returned.
* `query` (`String!`): The search predicate all entities returned
should match.
"""428. EntityManagementAdditionalParameter¶
Key-value pair for additional configuration
Available fields:
key: Parameter namevalue: Parameter value
class EntityManagementAdditionalParameter(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(String, graphql_name="key")
value = sgqlc.types.Field(String, graphql_name="value")429. EntityManagementAgentDeployment¶
A set of configurations that are currently deployed
Available fields:
completedAt: Deployment finishfleet: Fleet Idid: Deployment IdmanagedEntity: Managed Entity IdstartedAt: Deployment startedstatus: Deployment status
class EntityManagementAgentDeployment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"completed_at",
"fleet",
"id",
"managed_entity",
"started_at",
"status",
)
completed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="completedAt")
fleet = sgqlc.types.Field(ID, graphql_name="fleet")
id = sgqlc.types.Field(String, graphql_name="id")
managed_entity = sgqlc.types.Field(ID, graphql_name="managedEntity")
started_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="startedAt")
status = sgqlc.types.Field(String, graphql_name="status")430. EntityManagementAgentToDeploy¶
Agent to deploy in a fleet deployment
Available fields:
agentType: Agent typeconfigurationVersionList: Configuration version list for this agentversion: Agent version
class EntityManagementAgentToDeploy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("agent_type", "configuration_version_list", "version")
agent_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="agentType"
)
configuration_version_list = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
"EntityManagementDeploymentAgentConfigurationVersion"
)
)
),
graphql_name="configurationVersionList",
)
version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="version")431. EntityManagementAiAgentEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementAiAgentEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementAiAgentEntity"), graphql_name="entity"
)432. EntityManagementAiAgentEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementAiAgentEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementAiAgentEntity"), graphql_name="entity"
)433. EntityManagementAiAgentMcpServerConfig¶
Configuring specific tools from an MCP server for an agent’s use
Available fields:
excludeTools: list of specific tools to exclude from this MCP serverincludeTools: list of specific tools to include from this MCP server (default is empty list, which means all tools from the MCP server will be included)server: reference to the MCP server entity
class EntityManagementAiAgentMcpServerConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("exclude_tools", "include_tools", "server")
exclude_tools = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="excludeTools"
)
include_tools = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="includeTools"
)
server = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementMcpServerEntity"), graphql_name="server"
)434. EntityManagementAiAgentToolConfig¶
Deprecated: Configuration for an agent’s use of a specific MCP server/tool
Available fields:
excludeTools: list of specific tools to exclude from this MCP serverincludeTools: list of specific tools to include from this MCP servertool: reference to the MCP server/tool entity
class EntityManagementAiAgentToolConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("exclude_tools", "include_tools", "tool")
exclude_tools = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="excludeTools"
)
include_tools = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="includeTools"
)
tool = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementAiToolEntity"), graphql_name="tool"
)435. EntityManagementAiToolEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementAiToolEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementAiToolEntity"), graphql_name="entity"
)436. EntityManagementAiToolEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementAiToolEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementAiToolEntity"), graphql_name="entity"
)437. EntityManagementAiToolParameter¶
Tool parameters to be passed to ToolEntity
Available fields:
description: description of the parameter - important for the discovery of parameter by llmname: name of the tool parametertype: type of the parameter indicating its data-type
class EntityManagementAiToolParameter(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "name", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementAiToolParameterType), graphql_name="type"
)438. EntityManagementArrayCondition¶
Array condition type.
Available fields:
operator: Array condition type operator.
class EntityManagementArrayCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("operator",)
operator = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementArrayOperator), graphql_name="operator"
)439. EntityManagementAttribute¶
Attributes to represent thresholds
Available fields:
key: Key for the attribute, e.g., ‘queryCountThreshold’, ‘queryDurationThresholdMs’lastUpdatedAt: It generates the current timestamp in millisecondslastUpdatedBy: It represents the userId of the user who has edited thisvalue: Value for the attribute, e.g., ‘1000’, ‘5000’. The value can be a string representation of a number or any other type as needed.
class EntityManagementAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "last_updated_at", "last_updated_by", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
last_updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastUpdatedAt")
last_updated_by = sgqlc.types.Field(
"EntityManagementPrincipal", graphql_name="lastUpdatedBy"
)
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")440. EntityManagementAwsAssumeRoleConfig¶
Configuration for accessing an Aws account via AssumeRole
Available fields:
externalId: External ID to use when assuming the roleroleArn: The ARN of the role to assume
class EntityManagementAwsAssumeRoleConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("external_id", "role_arn")
external_id = sgqlc.types.Field(
EntityManagementDynamicString, graphql_name="externalId"
)
role_arn = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="roleArn")441. EntityManagementAwsCredentials¶
Base Credential type for Aws
Available fields:
assumeRole: AssumeRole type
class EntityManagementAwsCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("assume_role",)
assume_role = sgqlc.types.Field(
EntityManagementAwsAssumeRoleConfig, graphql_name="assumeRole"
)442. EntityManagementBackgroundProcessingQuery¶
At rest background processing types
Available fields:
joinScopes: The list of scopes to be included in every query in a scheduled batch of cross account queries.nrql: The NRQL string used to specify the action you want to take and data you want to take the specified action on.outputScope: The scope for the output, if applicable. If the value is null, the entity scope is used as output.scopes: The list of scopes to be queried, allowing a scheduled batch of cross account queries. If this value is null, the original entity scope will be used.
class EntityManagementBackgroundProcessingQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("join_scopes", "nrql", "output_scope", "scopes")
join_scopes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementScopedReference")),
graphql_name="joinScopes",
)
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")
output_scope = sgqlc.types.Field(
"EntityManagementScopedReference", graphql_name="outputScope"
)
scopes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementScopedReference")),
graphql_name="scopes",
)443. EntityManagementBackgroundProcessingSqlQuery¶
At rest background processing types
Available fields:
outputScope: The scope for the output, if applicable. If the value is null, the entity scope is used as output.outputTarget: The target of the SQL query results, indicating the destination where the SQL results will be sent.scopes: The list of scopes to be queried, allowing cross account queries. If this value is null, the original entity scope will be used.sql: The SQL string used to specify the action you want to take and data you want to take the specified action on.
class EntityManagementBackgroundProcessingSqlQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("output_scope", "output_target", "scopes", "sql")
output_scope = sgqlc.types.Field(
"EntityManagementScopedReference", graphql_name="outputScope"
)
output_target = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="outputTarget"
)
scopes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementScopedReference")),
graphql_name="scopes",
)
sql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="sql")444. EntityManagementBlob¶
Metadata about a blob stored in the Blob Datastore.
Available fields:
blobSignatures: Object that holds the details of the blob signaturechecksum: The checksum of the blob contentchecksumAlgorithm: The checksum algorithm used to calculate the checksum of the blob contentcontentType: The content type of the blobid: The blob identifier. Can be used to download the blob data from the Blob API
class EntityManagementBlob(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"blob_signatures",
"checksum",
"checksum_algorithm",
"content_type",
"id",
)
blob_signatures = sgqlc.types.Field(
sgqlc.types.list_of("EntityManagementBlobSignature"),
graphql_name="blobSignatures",
)
checksum = sgqlc.types.Field(String, graphql_name="checksum")
checksum_algorithm = sgqlc.types.Field(String, graphql_name="checksumAlgorithm")
content_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="contentType"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")445. EntityManagementBlobSignature¶
A set of configurations for blob signature
Available fields:
signature: Signature detailssignatureErrors: Errors encountered during signature creation
class EntityManagementBlobSignature(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("signature", "signature_errors")
signature = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSignatureDetails"),
graphql_name="signature",
)
signature_errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="signatureErrors",
)446. EntityManagementBudgetAccount¶
Represents an account.
Available fields:
id: The unique identifier of the account.
class EntityManagementBudgetAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")447. EntityManagementBudgetAlertPolicy¶
Represents an alert policy for the budget
Available fields:
id: The unique identifier of the alert policy.
class EntityManagementBudgetAlertPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")448. EntityManagementBudgetCustomer¶
Represents a customer.
Available fields:
id: The unique identifier of the customer.
class EntityManagementBudgetCustomer(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")449. EntityManagementBudgetLimit¶
Represents a budget limit.
Available fields:
consumptionMetric: The consumption metric associated with the budget limit.reference: Reference to where the complete budget limit definition is stored. The Budget Entity acts as an index/tracking system while the actual limit configuration data lives in the Limits Platform.value: The value of the limit for the specified consumption metric.
class EntityManagementBudgetLimit(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("consumption_metric", "reference", "value")
consumption_metric = sgqlc.types.Field(
EntityManagementConsumptionMetric, graphql_name="consumptionMetric"
)
reference = sgqlc.types.Field("EntityManagementReference", graphql_name="reference")
value = sgqlc.types.Field(Int, graphql_name="value")450. EntityManagementBudgetOrganization¶
Represents an organization.
Available fields:
id: The unique identifier of the organization.
class EntityManagementBudgetOrganization(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")451. EntityManagementBudgetSegment¶
The segment being tracked by the budget.
Available fields:
accounts: Array of account IDs associated with the budget segment.customer: Customer Contract ID.organizations: Array of organization IDs in a multi-tenant structure.users: Object containing user limit configuration.
class EntityManagementBudgetSegment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("accounts", "customer", "organizations", "users")
accounts = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementBudgetAccount), graphql_name="accounts"
)
customer = sgqlc.types.Field(
EntityManagementBudgetCustomer, graphql_name="customer"
)
organizations = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementBudgetOrganization),
graphql_name="organizations",
)
users = sgqlc.types.Field("EntityManagementUsers", graphql_name="users")452. EntityManagementBudgetUser¶
Represents a user whose resource consumption limits are managed by the budget.
Available fields:
id: The unique identifier of the user (userID).
class EntityManagementBudgetUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")453. EntityManagementCategoryScope¶
Scope for category subtype
Available fields:
id: id based on scopetype: type of scope
class EntityManagementCategoryScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCategoryScopeType), graphql_name="type"
)454. EntityManagementCharacterTextSplitterOptions¶
The CharacterTextSplitter options
Available fields:
isSeparatorRegex: Is the separator a regexseparator: Character to split text on
class EntityManagementCharacterTextSplitterOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("is_separator_regex", "separator")
is_separator_regex = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isSeparatorRegex"
)
separator = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="separator"
)455. EntityManagementCiscoMerakiBasicAuthCredential¶
Basic auth credential type for Cisco Meraki
Available fields:
apiKey: The API key to authorize API access
class EntityManagementCiscoMerakiBasicAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key",)
api_key = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="apiKey"
)456. EntityManagementCiscoMerakiCredential¶
Credential type for Cisco Meraki
Available fields:
basicAuth: A simple API key-based authentication
class EntityManagementCiscoMerakiCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("basic_auth",)
basic_auth = sgqlc.types.Field(
EntityManagementCiscoMerakiBasicAuthCredential, graphql_name="basicAuth"
)457. EntityManagementCollectionElementsResult¶
The result of a collection elements query.
Available fields:
items: The current page of results.nextCursor: Cursor pointing to the next page of results.
class EntityManagementCollectionElementsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementEntity))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")458. EntityManagementCollectionEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementCollectionEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementCollectionEntity"), graphql_name="entity"
)459. EntityManagementCollectionEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementCollectionEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementCollectionEntity"), graphql_name="entity"
)460. EntityManagementCollectionsContainingEntityResult¶
The result of a collectionsContainingEntity query.
Available fields:
collection: The collection entity.parentInfo: The location of the collection in its parent entity, if any.
class EntityManagementCollectionsContainingEntityResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("collection", "parent_info")
collection = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementCollectionEntity"),
graphql_name="collection",
)
parent_info = sgqlc.types.Field(
"EntityManagementParentInfo", graphql_name="parentInfo"
)461. EntityManagementCommunicationLog¶
CommunicationLog represents the communication information for an incident. This includes communication details as well as the impact information for that incident.
Available fields:
communicatedBy: The message communicated by.communicationMode: Mode of the communication happened.communicationStatus: The communication status.impact: Represents the customer impact of the incident.message: The content of the communication log.timestamp: The timestamp of the communication log.
class EntityManagementCommunicationLog(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"communicated_by",
"communication_mode",
"communication_status",
"impact",
"message",
"timestamp",
)
communicated_by = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="communicatedBy"
)
communication_mode = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementCommunicationMode)),
graphql_name="communicationMode",
)
communication_status = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCommunicationStatus),
graphql_name="communicationStatus",
)
impact = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("EntityManagementCustomerImpactEntity")
),
graphql_name="impact",
)
message = sgqlc.types.Field(String, graphql_name="message")
timestamp = sgqlc.types.Field(EpochMilliseconds, graphql_name="timestamp")462. EntityManagementConfig¶
Collection of attributes to represent thresholds of a type
Available fields:
attributes: The list of attributes that define the thresholds for this config.name: The name of the analyzer for which this config is applicable.
class EntityManagementConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "name")
attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementAttribute)),
graphql_name="attributes",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")463. EntityManagementConfiguration¶
Metadata about the configuration and the configuration blob itself
Available fields:
blob: The raw configuration blob supplied by the systemsource: The ID of the source system entity for the configurationupdatedAt: The last time the configuration was updatedupdatedBy: Who or what last updated the configuration
class EntityManagementConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("blob", "source", "updated_at", "updated_by")
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
source = sgqlc.types.Field(ID, graphql_name="source")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field(String, graphql_name="updatedBy")464. EntityManagementConfluenceBasicAuthCredential¶
Basic auth credential type for Confluence
Available fields:
domain: The confluence domain (e.g., your-domain .atlassian .net) token: The Confluence API token to authorize the API operationstokenExpirationTime: API token expiration timeuserId: The Confluence user ID (the Atlassian account email) associated with the API token.
class EntityManagementConfluenceBasicAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("domain", "token", "token_expiration_time", "user_id")
domain = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="domain")
token = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="token"
)
token_expiration_time = sgqlc.types.Field(
EpochMilliseconds, graphql_name="tokenExpirationTime"
)
user_id = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="userId"
)465. EntityManagementConfluenceCredentials¶
Base credentials type for Confluence
Available fields:
basicAuth: A simple basic auth credential
class EntityManagementConfluenceCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("basic_auth",)
basic_auth = sgqlc.types.Field(
EntityManagementConfluenceBasicAuthCredential, graphql_name="basicAuth"
)466. EntityManagementConfluenceIntegrationCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementConfluenceIntegrationCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementConfluenceIntegration"),
graphql_name="entity",
)467. EntityManagementConfluenceIntegrationUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementConfluenceIntegrationUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementConfluenceIntegration"),
graphql_name="entity",
)468. EntityManagementConfluenceRagSettingsEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementConfluenceRagSettingsEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementConfluenceRagSettingsEntity"),
graphql_name="entity",
)469. EntityManagementConfluenceRagSettingsEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementConfluenceRagSettingsEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementConfluenceRagSettingsEntity"),
graphql_name="entity",
)470. EntityManagementConnectionSettings¶
Connection settings type for all connections
Available fields:
key: The key or name of the settingvalue: The value of the setting.
class EntityManagementConnectionSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")471. EntityManagementCorrelationAttribute¶
A configuration attribute for probabilistic matching.
Available fields:
name: Attribute name.value: Attribute value.
class EntityManagementCorrelationAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")472. EntityManagementCorrelationAttributeCondition¶
Defines an attribute matching condition between subjects.
Available fields:
attribute: The attribute path to match (e.g., ‘tags.hostname’).operator: The matching operator.value: The value to match against.
class EntityManagementCorrelationAttributeCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute", "operator", "value")
attribute = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attribute"
)
operator = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationAttributeConditionOperator),
graphql_name="operator",
)
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")473. EntityManagementCorrelationContext¶
Context metadata about a correlation link.
Available fields:
confidence: Confidence score (0.0 to 1.0) if probabilistic matching was used.messages: Additional informational messages about the correlation.ruleId: The GUID of the CorrelationLinkingRule that created this link.
class EntityManagementCorrelationContext(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("confidence", "messages", "rule_id")
confidence = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="confidence"
)
messages = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="messages"
)
rule_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="ruleId")474. EntityManagementCorrelationLinkingConfig¶
Defines the output configuration for correlation results.
Available fields:
directional: Whether the link is directional (default: false).linkType: The type of link/relationship to create (e.g., ‘RELATED_TO’, ‘CAUSED_BY’).sourceAlias: Alias of the source subject (for directional links).targetAlias: Alias of the target subject (for directional links).
class EntityManagementCorrelationLinkingConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("directional", "link_type", "source_alias", "target_alias")
directional = sgqlc.types.Field(Boolean, graphql_name="directional")
link_type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="linkType")
source_alias = sgqlc.types.Field(String, graphql_name="sourceAlias")
target_alias = sgqlc.types.Field(String, graphql_name="targetAlias")475. EntityManagementCorrelationLinkingCriteria¶
Defines the matching criteria for correlation.
Available fields:
attributeConditions: Deterministic attribute matching rules.probabilistic: Probabilistic/ML-based matching configuration.temporalWindow: Temporal window configuration for correlation.topologyProximity: Topology proximity threshold for correlation.
class EntityManagementCorrelationLinkingCriteria(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"attribute_conditions",
"probabilistic",
"temporal_window",
"topology_proximity",
)
attribute_conditions = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementCorrelationAttributeCondition)
),
graphql_name="attributeConditions",
)
probabilistic = sgqlc.types.Field(
"EntityManagementCorrelationProbabilisticMatchingConfig",
graphql_name="probabilistic",
)
temporal_window = sgqlc.types.Field(
"EntityManagementCorrelationWindowConfig", graphql_name="temporalWindow"
)
topology_proximity = sgqlc.types.Field(Int, graphql_name="topologyProximity")476. EntityManagementCorrelationOverrideInfo¶
User override information for a correlation link.
Available fields:
action: The action taken by the user.timestamp: Timestamp when the override was performed.userId: ID of the user who performed the override.
class EntityManagementCorrelationOverrideInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("action", "timestamp", "user_id")
action = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationOverrideAction),
graphql_name="action",
)
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="timestamp"
)
user_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="userId")477. EntityManagementCorrelationProbabilisticMatchingConfig¶
Configuration for probabilistic/ML-based matching.
Available fields:
algorithm: The ML algorithm to use.confidenceThreshold: Confidence threshold (0.0 to 1.0) for accepting correlations.configs: Additional configuration attributes for the algorithm.
class EntityManagementCorrelationProbabilisticMatchingConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("algorithm", "confidence_threshold", "configs")
algorithm = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationMatchingAlgorithm),
graphql_name="algorithm",
)
confidence_threshold = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="confidenceThreshold"
)
configs = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementCorrelationAttribute)),
graphql_name="configs",
)478. EntityManagementCorrelationSubject¶
Defines a subject (event or entity) that participates in correlation.
Available fields:
accountIds: List of account IDs to query for this subject. Account access is validated by the correlation service at runtime.alias: Alias for this subject used in criteria and linking configuration.lifecycle: Lifecycle configuration for stateful subjects (optional).nrql: The NRQL query to select this subject.type: The type of the subject (EVENT or ENTITY).
class EntityManagementCorrelationSubject(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids", "alias", "lifecycle", "nrql", "type")
account_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="accountIds"
)
alias = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="alias")
lifecycle = sgqlc.types.Field(
"EntityManagementCorrelationSubjectLifecycleConfig", graphql_name="lifecycle"
)
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationSubjectType),
graphql_name="type",
)479. EntityManagementCorrelationSubjectLifecycleConfig¶
Defines the lifecycle management for stateful correlation subjects.
Available fields:
closedValues: Values indicating the subject is in a closed state.identityKey: Field name representing the unique identifier for the subject.openValues: Values indicating the subject is in an open state.stateKey: Field name representing the state of the subject.
class EntityManagementCorrelationSubjectLifecycleConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("closed_values", "identity_key", "open_values", "state_key")
closed_values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="closedValues",
)
identity_key = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="identityKey"
)
open_values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="openValues",
)
state_key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="stateKey")480. EntityManagementCorrelationSubjectReference¶
Reference to a correlation subject (event or entity).
Available fields:
accountId: The account where the event resides.eventId: The unique identifier of the event.eventType: The event’s type (e.g., NR_ISSUE).
class EntityManagementCorrelationSubjectReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "event_id", "event_type")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
event_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="eventId")
event_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="eventType"
)481. EntityManagementCorrelationWindowConfig¶
Defines the temporal window for candidate discovery.
Available fields:
driverEndTimestampAttribute: Attribute name for driver end timestamp (optional).driverStartTimestampAttribute: Attribute name for driver start timestamp (optional).lookbackSeconds: Lookback duration in seconds from the driver event.lookforwardSeconds: Lookforward duration in seconds from the driver event.
class EntityManagementCorrelationWindowConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"driver_end_timestamp_attribute",
"driver_start_timestamp_attribute",
"lookback_seconds",
"lookforward_seconds",
)
driver_end_timestamp_attribute = sgqlc.types.Field(
String, graphql_name="driverEndTimestampAttribute"
)
driver_start_timestamp_attribute = sgqlc.types.Field(
String, graphql_name="driverStartTimestampAttribute"
)
lookback_seconds = sgqlc.types.Field(
sgqlc.types.non_null(Seconds), graphql_name="lookbackSeconds"
)
lookforward_seconds = sgqlc.types.Field(
sgqlc.types.non_null(Seconds), graphql_name="lookforwardSeconds"
)482. EntityManagementCount¶
Represents the count.
Available fields:
repoCount: Number of repositories associated with the integration.teamCount: Number of teams associated with the integration.
class EntityManagementCount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("repo_count", "team_count")
repo_count = sgqlc.types.Field(Int, graphql_name="repoCount")
team_count = sgqlc.types.Field(Int, graphql_name="teamCount")483. EntityManagementDateCondition¶
Date condition type.
Available fields:
endValue: End values for the IN_RANGE operator.operator: Date condition type operator.startValue: Start values for the IN_RANGE operator.value: Value for BEFORE and AFTER operators.
class EntityManagementDateCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("end_value", "operator", "start_value", "value")
end_value = sgqlc.types.Field(String, graphql_name="endValue")
operator = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementDateOperator), graphql_name="operator"
)
start_value = sgqlc.types.Field(String, graphql_name="startValue")
value = sgqlc.types.Field(String, graphql_name="value")484. EntityManagementDeploymentAgentConfigurationVersion¶
Properties of a deployed configuration version
Available fields:
id: Configuration version ID
class EntityManagementDeploymentAgentConfigurationVersion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")485. EntityManagementDiscoverySettings¶
Discovery related settings.
Available fields:
enabled: If discovery is enabled for that organization or not.tagKeys: Tag keys used for discovery for the organization.
class EntityManagementDiscoverySettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "tag_keys")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
tag_keys = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="tagKeys",
)486. EntityManagementEntityDeleteResult¶
The result of deleting an entity.
Available fields:
id: The id of the entity effectively deleted.
class EntityManagementEntityDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")487. EntityManagementEntityReference¶
An entity reference.
Available fields:
id: The id of the entityscope: The scope of the entitytype: The type of the entity
class EntityManagementEntityReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "scope", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
scope = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScopedReference"), graphql_name="scope"
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")488. EntityManagementEntitySearchResult¶
The result of an entities query.
Available fields:
entities: The current page of results.nextCursor: Cursor pointing to the next page of results.
class EntityManagementEntitySearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "next_cursor")
entities = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementEntity)),
graphql_name="entities",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")489. EntityManagementEventBridgeCondition¶
Represents a single base condition comparing a field to a value.
Available fields:
field: The JSON path to the field within the event payload to evaluate.value: The matching logic for the field.
class EntityManagementEventBridgeCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("field", "value")
field = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="field")
value = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementEventBridgeConditionValue"),
graphql_name="value",
)490. EntityManagementEventBridgeConditionValue¶
A wrapper object that will contain exactly one of the possible condition types.
Available fields:
array: Array condition type.date: Date condition type.exists: A simple check for the existence of a field.numeric: Numeric condition type.string: String condition type.
class EntityManagementEventBridgeConditionValue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("array", "date", "exists", "numeric", "string")
array = sgqlc.types.Field(EntityManagementArrayCondition, graphql_name="array")
date = sgqlc.types.Field(EntityManagementDateCondition, graphql_name="date")
exists = sgqlc.types.Field(Boolean, graphql_name="exists")
numeric = sgqlc.types.Field(
"EntityManagementNumericCondition", graphql_name="numeric"
)
string = sgqlc.types.Field("EntityManagementStringCondition", graphql_name="string")491. EntityManagementEventBridgeSourceType¶
Defines the origin of an event.
Available fields:
event: The system from which the event originates.name: The specific name of the entity within the source system (e.g., ‘WorkItem’).
class EntityManagementEventBridgeSourceType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("event", "name")
event = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEventBridgeEventSourceType),
graphql_name="event",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")492. EntityManagementEventBridgeTarget¶
A target action to be executed when an event matches the rule.
Available fields:
name: A user-defined name for this target action within the rule.parameters: The specific parameters for this target.type: The type of action this target performs. For V1, only WORKFLOW is supported.when: An optional condition evaluated before executing this target.
class EntityManagementEventBridgeTarget(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "parameters", "type", "when")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
parameters = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementEventBridgeTargetParameters"),
graphql_name="parameters",
)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEventBridgeTargetType), graphql_name="type"
)
when = sgqlc.types.Field(String, graphql_name="when")493. EntityManagementEventBridgeTargetParameters¶
A wrapper object containing parameters for one specific target type.
Available fields:
workflow: Parameters for a WORKFLOW target. Populated only if type is WORKFLOW.
class EntityManagementEventBridgeTargetParameters(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("workflow",)
workflow = sgqlc.types.Field(
"EntityManagementEventBridgeWorkflowTargetParameters", graphql_name="workflow"
)494. EntityManagementEventBridgeWorkflowDefinitionType¶
Defines the workflow to execute.
Available fields:
name: Specifies the workflow to execute.scopeType: Specifies the scope at which the workflow is defined.version: Specifies the version of the workflow to execute.
class EntityManagementEventBridgeWorkflowDefinitionType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "scope_type", "version")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope_type = sgqlc.types.Field(
EntityManagementEventBridgeWorkflowDefinitionScopeType, graphql_name="scopeType"
)
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")495. EntityManagementEventBridgeWorkflowInput¶
A simple key-value pair for workflow parameters (output).
Available fields:
name: The name of the input parameter.value: The value of the input parameter.
class EntityManagementEventBridgeWorkflowInput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")496. EntityManagementEventBridgeWorkflowTargetParameters¶
Parameters specific to a WORKFLOW target.
Available fields:
definition: Defines the workflow to execute.inputs: A list of key-value pairs to pass as input parameters to the workflow.scope: The scope in which the target workflow will be executed.
class EntityManagementEventBridgeWorkflowTargetParameters(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition", "inputs", "scope")
definition = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEventBridgeWorkflowDefinitionType),
graphql_name="definition",
)
inputs = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementEventBridgeWorkflowInput)
),
graphql_name="inputs",
)
scope = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScopedReference"), graphql_name="scope"
)497. EntityManagementExecutionIssue¶
Rule execution issues
Available fields:
statusCode: Machine-readable code specifying the type of error or status.statusMessage: Human-readable message providing details about the error or status.
class EntityManagementExecutionIssue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("status_code", "status_message")
status_code = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementStatusCode), graphql_name="statusCode"
)
status_message = sgqlc.types.Field(String, graphql_name="statusMessage")498. EntityManagementExternalOwner¶
Owner of the repository
Available fields:
id: External Owner ID of the repository.type: Type of owner of the repository eg:- user,organisation etc.
class EntityManagementExternalOwner(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementExternalOwnerType), graphql_name="type"
)499. EntityManagementFleetControlProperties¶
Properties specific to fleet control
Available fields:
appliedDeployment: Agent deployment propertiesdisconnectedReceived: True is the Agent sent a disconnect messageenvironment: Environment the agent is running inhealthy: True if the Agent is up and healthylastError: Error message returned by the agent when it is unhealthylastRemoteConfigError: Error message returned when the last remote configuration deploy is not successfullastRemoteConfigStatus: Status of the last remote configuration deploystartTime: Timestamp indicating when the agent was starteduid: The UID of this agent
class EntityManagementFleetControlProperties(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"applied_deployment",
"disconnected_received",
"environment",
"healthy",
"last_error",
"last_remote_config_error",
"last_remote_config_status",
"start_time",
"uid",
)
applied_deployment = sgqlc.types.Field(
EntityManagementAgentDeployment, graphql_name="appliedDeployment"
)
disconnected_received = sgqlc.types.Field(
Boolean, graphql_name="disconnectedReceived"
)
environment = sgqlc.types.Field(String, graphql_name="environment")
healthy = sgqlc.types.Field(Boolean, graphql_name="healthy")
last_error = sgqlc.types.Field(String, graphql_name="lastError")
last_remote_config_error = sgqlc.types.Field(
String, graphql_name="lastRemoteConfigError"
)
last_remote_config_status = sgqlc.types.Field(
String, graphql_name="lastRemoteConfigStatus"
)
start_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="startTime")
uid = sgqlc.types.Field(String, graphql_name="uid")500. EntityManagementFleetDeployment¶
Deprecated: A set of configurations that are currently deployed
Available fields:
canaryManagedEntities: A list of EntityGuid of Managed Entities selected for Canary deployconfigsChanged: The number of configurations changed during this deploymentconfigurationVersions: A list of configurations included in this deploymentdeployedAt: Deployment starteddescription: Deployment descriptionentitiesChanged: The number of entities changed during this deploymentmanagedEntitiesChanged: The number of managed entities changed during this deploymentmanagedEntitiesRequiredToChange: The number of managed entities required to change during this deploymentmetadata: Metadata containing identification of the user who created this deploymentname: Deployment namestatus: Deployment statussupervisedAgentEntitiesChanged: The number of supervised agent entities changed during this deploymentsupervisedAgentEntitiesRequiredToChange: The number of supervised agent entities required to change during this deployment
class EntityManagementFleetDeployment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"canary_managed_entities",
"configs_changed",
"configuration_versions",
"deployed_at",
"description",
"entities_changed",
"managed_entities_changed",
"managed_entities_required_to_change",
"metadata",
"name",
"status",
"supervised_agent_entities_changed",
"supervised_agent_entities_required_to_change",
)
canary_managed_entities = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="canaryManagedEntities",
)
configs_changed = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="configsChanged"
)
configuration_versions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="configurationVersions",
)
deployed_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="deployedAt"
)
description = sgqlc.types.Field(String, graphql_name="description")
entities_changed = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="entitiesChanged"
)
managed_entities_changed = sgqlc.types.Field(
Int, graphql_name="managedEntitiesChanged"
)
managed_entities_required_to_change = sgqlc.types.Field(
Int, graphql_name="managedEntitiesRequiredToChange"
)
metadata = sgqlc.types.Field(
"EntityManagementUserMetadata", graphql_name="metadata"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
status = sgqlc.types.Field(String, graphql_name="status")
supervised_agent_entities_changed = sgqlc.types.Field(
Int, graphql_name="supervisedAgentEntitiesChanged"
)
supervised_agent_entities_required_to_change = sgqlc.types.Field(
Int, graphql_name="supervisedAgentEntitiesRequiredToChange"
)501. EntityManagementGenericEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementGenericEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntity), graphql_name="entity"
)502. EntityManagementGitHubRetentionOptions¶
Options for retaining entities with GitHub integration.
Available fields:
retainRepositories: Whether to retain associated repositoriesretainTeams: Whether to retain associated teams
class EntityManagementGitHubRetentionOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("retain_repositories", "retain_teams")
retain_repositories = sgqlc.types.Field(Boolean, graphql_name="retainRepositories")
retain_teams = sgqlc.types.Field(Boolean, graphql_name="retainTeams")503. EntityManagementGitHubSyncOptions¶
List of possible github sync options.
Available fields:
syncRepositories: Sync github repositoriessyncTeams: Sync github teams
class EntityManagementGitHubSyncOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("sync_repositories", "sync_teams")
sync_repositories = sgqlc.types.Field(Boolean, graphql_name="syncRepositories")
sync_teams = sgqlc.types.Field(Boolean, graphql_name="syncTeams")504. EntityManagementGitHubTeam¶
Type for GitHubTeam
Available fields:
id: The unique identifier of the GitHub team.
class EntityManagementGitHubTeam(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")505. EntityManagementGitRepositoryEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementGitRepositoryEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementGitRepositoryEntity"),
graphql_name="entity",
)506. EntityManagementGitRepositoryEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementGitRepositoryEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementGitRepositoryEntity"),
graphql_name="entity",
)507. EntityManagementGithubAppTokenCredential¶
App token credential type for Github
Available fields:
appId: The registered Github application ID, default to NewRelic Integration applicationinstallationId: The Github app installation ID.privateKeyReference: Default to NewRelic Integration privateKey, currently stored in Vault.tokenFieldName: The field name for the access token from the JSON response, default to tokentokenRelativeUrl: path to get an access token, default to app/installations/{installation-id}/access_tokens
class EntityManagementGithubAppTokenCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"app_id",
"installation_id",
"private_key_reference",
"token_field_name",
"token_relative_url",
)
app_id = sgqlc.types.Field(String, graphql_name="appId")
installation_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="installationId"
)
private_key_reference = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"),
graphql_name="privateKeyReference",
)
token_field_name = sgqlc.types.Field(String, graphql_name="tokenFieldName")
token_relative_url = sgqlc.types.Field(String, graphql_name="tokenRelativeUrl")508. EntityManagementGithubCredentials¶
Base credentials type for Github
Available fields:
appToken: Github App token support with JWTpersonalAccessToken: A Github personal access token.
class EntityManagementGithubCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("app_token", "personal_access_token")
app_token = sgqlc.types.Field(
EntityManagementGithubAppTokenCredential, graphql_name="appToken"
)
personal_access_token = sgqlc.types.Field(
"EntityManagementSecretReference", graphql_name="personalAccessToken"
)509. EntityManagementImpactProfileEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementImpactProfileEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementImpactProfileEntity"),
graphql_name="entity",
)510. EntityManagementImpactProfileEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementImpactProfileEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementImpactProfileEntity"),
graphql_name="entity",
)511. EntityManagementImpactQuery¶
Impact query containing NRQL query and account IDs for status page announcements.
Available fields:
nrqlQuery: NRQL query stringqueryAccountIds: List of account IDs to query against
class EntityManagementImpactQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql_query", "query_account_ids")
nrql_query = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="nrqlQuery"
)
query_account_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="queryAccountIds"
)512. EntityManagementInboxIssueCategoryEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementInboxIssueCategoryEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementInboxIssueCategoryEntity"),
graphql_name="entity",
)513. EntityManagementInboxIssueCategoryEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementInboxIssueCategoryEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementInboxIssueCategoryEntity"),
graphql_name="entity",
)514. EntityManagementIncidentLinkEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementIncidentLinkEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementIncidentLinkEntity"),
graphql_name="entity",
)515. EntityManagementIncidentLinkEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementIncidentLinkEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementIncidentLinkEntity"),
graphql_name="entity",
)516. EntityManagementIncidentTimelineEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementIncidentTimelineEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementIncidentTimelineEntity"),
graphql_name="entity",
)517. EntityManagementIncidentTimelineEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementIncidentTimelineEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementIncidentTimelineEntity"),
graphql_name="entity",
)518. EntityManagementInfrastructureManager¶
Details related to an infrastructure manager
Available fields:
type: The type of the managerversion: The version of the manager
class EntityManagementInfrastructureManager(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type", "version")
type = sgqlc.types.Field(String, graphql_name="type")
version = sgqlc.types.Field(String, graphql_name="version")519. EntityManagementJiraBasicAuthCredential¶
Basic auth credential type for Jira
Available fields:
apiKey: The Jira api token to authorize the API usage for read/create/update operationsusername: username to create the api token
class EntityManagementJiraBasicAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key", "username")
api_key = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="apiKey"
)
username = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="username"
)520. EntityManagementJiraCredentials¶
Base credentials type for Jira
Available fields:
basicAuth: A simple api key credentialoauth: OAuth supportpersonalAccessToken: A personal access token credential
class EntityManagementJiraCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("basic_auth", "oauth", "personal_access_token")
basic_auth = sgqlc.types.Field(
EntityManagementJiraBasicAuthCredential, graphql_name="basicAuth"
)
oauth = sgqlc.types.Field(
"EntityManagementJiraOAuthCredential", graphql_name="oauth"
)
personal_access_token = sgqlc.types.Field(
"EntityManagementSecretReference", graphql_name="personalAccessToken"
)521. EntityManagementJiraOAuthCredential¶
OAuth credential type for Jira
Available fields:
clientId: The client ID for the OAuth requestclientSecret: The client secret for the OAuth requesttokenFieldName: The field name for the oauth token from the JSON response, default to access_tokentokenUrl: The Jira Atlassian URL to get an oauth token, default to https://auth .atlassian .com /oauth /token
class EntityManagementJiraOAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("client_id", "client_secret", "token_field_name", "token_url")
client_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="clientId")
client_secret = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"),
graphql_name="clientSecret",
)
token_field_name = sgqlc.types.Field(String, graphql_name="tokenFieldName")
token_url = sgqlc.types.Field(String, graphql_name="tokenUrl")522. EntityManagementJuniperMistBasicAuthCredential¶
Basic auth credential type for Juniper Mist
Available fields:
token: The API token to authorize API access
class EntityManagementJuniperMistBasicAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("token",)
token = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="token"
)523. EntityManagementJuniperMistCredential¶
Credential type for Juniper Mist
Available fields:
basicAuth: A simple token-based authentication
class EntityManagementJuniperMistCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("basic_auth",)
basic_auth = sgqlc.types.Field(
EntityManagementJuniperMistBasicAuthCredential, graphql_name="basicAuth"
)524. EntityManagementLlmConfig¶
configurable details for the LLM
Available fields:
cacheSeed: Seed for reproducible output from LLMmodel: LLM model name, for ex: gpt-4otemperature: LLM parameter for creative control, 0 for consistent output, 1 for more creative output
class EntityManagementLlmConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("cache_seed", "model", "temperature")
cache_seed = sgqlc.types.Field(String, graphql_name="cacheSeed")
model = sgqlc.types.Field(String, graphql_name="model")
temperature = sgqlc.types.Field(Float, graphql_name="temperature")525. EntityManagementManagedEvaluationConfig¶
Configuration for a managed evaluation
Available fields:
additionalParameters: Additional configuration parametersenabled: Whether the evaluation is enabled or disabledevaluationType: The type of evaluation to performthreshold: Threshold value for the evaluation (0.0 to 1.0)
class EntityManagementManagedEvaluationConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"additional_parameters",
"enabled",
"evaluation_type",
"threshold",
)
additional_parameters = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementAdditionalParameter)),
graphql_name="additionalParameters",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
evaluation_type = sgqlc.types.Field(
EntityManagementManagedEvaluationType, graphql_name="evaluationType"
)
threshold = sgqlc.types.Field(Float, graphql_name="threshold")526. EntityManagementMarkdownTextSplitterOptions¶
The MarkdownTextSplitter options
Available fields:
headersToSplitOn: Headers to split text onreturnEachLine: Wether splitter should return each line
class EntityManagementMarkdownTextSplitterOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("headers_to_split_on", "return_each_line")
headers_to_split_on = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(String)),
graphql_name="headersToSplitOn",
)
return_each_line = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="returnEachLine"
)527. EntityManagementMcpServerAuth¶
Authentication configuration for an MCP server
Available fields:
bearerToken: Bearer token value (required when type=BEARER_TOKEN)headerKey: Arbitrary header key (required when type=GENERIC_HEADER)headerValue: Arbitrary header value (required when type=GENERIC_HEADER)type: Type of authentication to apply
class EntityManagementMcpServerAuth(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("bearer_token", "header_key", "header_value", "type")
bearer_token = sgqlc.types.Field(
"EntityManagementSecretReference", graphql_name="bearerToken"
)
header_key = sgqlc.types.Field(String, graphql_name="headerKey")
header_value = sgqlc.types.Field(
"EntityManagementSecretReference", graphql_name="headerValue"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementMcpAuthType), graphql_name="type"
)528. EntityManagementMcpServerEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementMcpServerEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementMcpServerEntity"), graphql_name="entity"
)529. EntityManagementMcpServerEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementMcpServerEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementMcpServerEntity"), graphql_name="entity"
)530. EntityManagementMetadata¶
Metadata about an entity.
Available fields:
createdAt: The entity’s creation time.createdBy: Actor that created this entity.updatedAt: The entity’s last update time.updatedBy: Actor that updated this entity.version: The entity current version. Use this value for concurrency control.
class EntityManagementMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"updated_at",
"updated_by",
"version",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field(EntityManagementActor, graphql_name="createdBy")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field(EntityManagementActor, graphql_name="updatedBy")
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")531. EntityManagementMeterAttribute¶
Meter attribute type
Available fields:
name: The name of the attributevalues: The value of the attribute
class EntityManagementMeterAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "values")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)532. EntityManagementNewRelicBasicAuthCredential¶
Base credentials type for New Relic
Available fields:
apiKey: The New Relic api key to authorize the API usage for read/create/update operationstype: Type of basic auth credential: Ingest or User
class EntityManagementNewRelicBasicAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key", "type")
api_key = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementSecretReference"), graphql_name="apiKey"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementKeyType), graphql_name="type"
)533. EntityManagementNrqlRuleEngine¶
NRQL engine configuration.
Available fields:
accounts: The accounts to be queried.joinAccounts: An optional list of accounts that are joined with ‘accounts’ when running the query.query: The query to be executed.
class EntityManagementNrqlRuleEngine(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("accounts", "join_accounts", "query")
accounts = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(Int))),
graphql_name="accounts",
)
join_accounts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="joinAccounts"
)
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")534. EntityManagementNumericCondition¶
Numeric condition type.
Available fields:
operator: Numeric condition type operator.value: Value to compare against.
class EntityManagementNumericCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("operator", "value")
operator = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementNumericOperator), graphql_name="operator"
)
value = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="value")535. EntityManagementOperatingSystem¶
Operating System string enum for the host operating systems in a fleet
Available fields:
type: The operating system type enum
class EntityManagementOperatingSystem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementOperatingSystemType), graphql_name="type"
)536. EntityManagementParentInfo¶
The location of a collection within a parent entity.
Available fields:
parentEntity: The collection’s parent entity.parentField: The field containing the collection in the parent entity.
class EntityManagementParentInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("parent_entity", "parent_field")
parent_entity = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntity), graphql_name="parentEntity"
)
parent_field = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="parentField"
)537. EntityManagementPipelineCloudRuleEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementPipelineCloudRuleEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementPipelineCloudRuleEntity"),
graphql_name="entity",
)538. EntityManagementPipelineCloudRuleEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementPipelineCloudRuleEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementPipelineCloudRuleEntity"),
graphql_name="entity",
)539. EntityManagementPrincipal¶
A wrapper object that will contain exactly one of the possible identity types.
Available fields:
id: The principal identifier, typically userIdtype: Enum represents type of identity.
class EntityManagementPrincipal(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementPrincipalType), graphql_name="type"
)540. EntityManagementProcessState¶
At rest background processing types
Available fields:
message: Message that indicates the process statusstatus: Indicate the status of a process
class EntityManagementProcessState(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "status")
message = sgqlc.types.Field(String, graphql_name="message")
status = sgqlc.types.Field(EntityManagementProcessStatus, graphql_name="status")541. EntityManagementProgressLevelDefinition¶
Defines a progress level within a scorecard.
Available fields:
description: The level description.hexColorCode: The hex code value for the color representing this level.id: The id of the progress level this entity refers to.name: The name of this level.
class EntityManagementProgressLevelDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "hex_color_code", "id", "name")
description = sgqlc.types.Field(String, graphql_name="description")
hex_color_code = sgqlc.types.Field(String, graphql_name="hexColorCode")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")542. EntityManagementRagToolEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementRagToolEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementRagToolEntity"), graphql_name="entity"
)543. EntityManagementRagToolEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementRagToolEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementRagToolEntity"), graphql_name="entity"
)544. EntityManagementReference¶
Points to where the complete budget limit definition is stored in an external system.
Available fields:
id: The unique identifier of the budget limit within the specified location (e.g., ‘coreCCU’).location: The system or platform where the complete budget limit is stored (e.g., ‘Limits Platform’).
class EntityManagementReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "location")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
location = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="location")545. EntityManagementRelationship¶
A relationship between two entities.
Available fields:
metadata: Metadata about the relationship.source: The id of the source entitytags: The tags of the relationshiptarget: The id of the target entitytype: The type of the relationship
class EntityManagementRelationship(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("metadata", "source", "tags", "target", "type")
metadata = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementMetadata), graphql_name="metadata"
)
source = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntityReference), graphql_name="source"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementTag")),
graphql_name="tags",
)
target = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntityReference), graphql_name="target"
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")546. EntityManagementRelationshipCreateResult¶
The result of creating an entity relationship.
Available fields:
relationship: The created relationship.
class EntityManagementRelationshipCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("relationship",)
relationship = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementRelationship), graphql_name="relationship"
)547. EntityManagementRelationshipDeleteResult¶
The result of deleting an entity relationship.
Available fields:
sourceId: The source id of the relationship effectively deleted.targetId: The target id of the relationship effectively deleted.type: The relationship type effectively deleted.
class EntityManagementRelationshipDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("source_id", "target_id", "type")
source_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="sourceId")
target_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="targetId")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")548. EntityManagementRelationshipUpdateResult¶
The result of updating a relationship.
Available fields:
relationship: The updated relationship.
class EntityManagementRelationshipUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("relationship",)
relationship = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementRelationship), graphql_name="relationship"
)549. EntityManagementRepositoryLicense¶
License associated with the repository
Available fields:
name: License Name associated with the repository e.g:- MIT, GPL, apache2.0..url: License Url associated with the repository
class EntityManagementRepositoryLicense(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "url")
name = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementLicenseName), graphql_name="name"
)
url = sgqlc.types.Field(String, graphql_name="url")550. EntityManagementRetentionPolicy¶
Retention policy for log data.
Available fields:
duration: The duration value for retention.unit: The time unit for the retention duration.
class EntityManagementRetentionPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("duration", "unit")
duration = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="duration")
unit = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementRetentionUnit), graphql_name="unit"
)551. EntityManagementRingDeploymentTracker¶
A type for holding deployment status for a Ring
Available fields:
completedAt: Rollout end timename: Ring namestartedAt: Rollout start timestatus: Ring deployment status
class EntityManagementRingDeploymentTracker(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("completed_at", "name", "started_at", "status")
completed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="completedAt")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
started_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="startedAt")
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")552. EntityManagementRuleExecutionStatus¶
Rule execution status
Available fields:
checkedEntities: Checked entities countexecutedAt: The timestamp of rule executionexecutionIssues: List detailing issues encountered during the rule executionexecutionStatus: The status of the execution of the rule
class EntityManagementRuleExecutionStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"checked_entities",
"executed_at",
"execution_issues",
"execution_status",
)
checked_entities = sgqlc.types.Field(Int, graphql_name="checkedEntities")
executed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="executedAt")
execution_issues = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementExecutionIssue),
graphql_name="executionIssues",
)
execution_status = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementExecutionStatus),
graphql_name="executionStatus",
)553. EntityManagementSchedule¶
An attribute, that contains information about scheduler configuration
Available fields:
enabled: An optional field stating the status of the schedulefirstRunAt: An optional ISO 8601 timestamp serving as the anchor for RRULE recurrence calculation. Defaults to current time if not providedperiod: An optional attribute unit is in minutes, with a minimum of 1 minute and a maximum of 1 year expressed in minutesrrule: An optional RFC 5545 RRULE string for complex, timezone-aware schedules (e.g., FREQ=MONTHLY;BYDAY=FR;BYSETPOS=-1). Mutually exclusive with periodscheduleAt: An optional attribute executes at once, with the date-time value in ISO 8601 formattimezone: An optional IANA timezone identifier (e.g., America/New_York) for DST-aware schedule calculations. Defaults to Etc/UTC
class EntityManagementSchedule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"enabled",
"first_run_at",
"period",
"rrule",
"schedule_at",
"timezone",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
first_run_at = sgqlc.types.Field(DateTime, graphql_name="firstRunAt")
period = sgqlc.types.Field(Int, graphql_name="period")
rrule = sgqlc.types.Field(String, graphql_name="rrule")
schedule_at = sgqlc.types.Field(DateTime, graphql_name="scheduleAt")
timezone = sgqlc.types.Field(String, graphql_name="timezone")554. EntityManagementScopedReference¶
An entity with scope.
Available fields:
id: The unique reference identifier of the an object within the given scopetype: The scope of the entity
class EntityManagementScopedReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntityScope), graphql_name="type"
)555. EntityManagementScorecardEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementScorecardEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScorecardEntity"), graphql_name="entity"
)556. EntityManagementScorecardEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementScorecardEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScorecardEntity"), graphql_name="entity"
)557. EntityManagementScorecardRuleEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementScorecardRuleEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScorecardRuleEntity"),
graphql_name="entity",
)558. EntityManagementScorecardRuleEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementScorecardRuleEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementScorecardRuleEntity"),
graphql_name="entity",
)559. EntityManagementSecretReference¶
Secret reference type
Available fields:
keyName: secret key namenamespace: namespace to store a secret
class EntityManagementSecretReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key_name", "namespace")
key_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="keyName")
namespace = sgqlc.types.Field(String, graphql_name="namespace")560. EntityManagementServiceNowApiKeyCredential¶
Basic auth credential type for ServiceNow
Available fields:
apiKey: The ServiceNow apiKey to authorize the API operations
class EntityManagementServiceNowApiKeyCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key",)
api_key = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference), graphql_name="apiKey"
)561. EntityManagementServiceNowCredentials¶
Base credentials type for ServiceNow
Available fields:
basicAuth: A simple basic auth credentialoauth: OAuth support
class EntityManagementServiceNowCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("basic_auth", "oauth")
basic_auth = sgqlc.types.Field(
EntityManagementServiceNowApiKeyCredential, graphql_name="basicAuth"
)
oauth = sgqlc.types.Field(
"EntityManagementServiceNowOAuthCredential", graphql_name="oauth"
)562. EntityManagementServiceNowOAuthCredential¶
OAuth credential type for ServiceNow
Available fields:
clientId: The client ID for the OAuth requestclientSecret: The client secret for the OAuth requesttokenFieldName: The field name for the oauth token from the JSON response, default to access_tokentokenRelativeUrl: The ServiceNow relative URL to get an oauth token, default to oauth_token.do
class EntityManagementServiceNowOAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"client_id",
"client_secret",
"token_field_name",
"token_relative_url",
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="clientId")
client_secret = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="clientSecret",
)
token_field_name = sgqlc.types.Field(String, graphql_name="tokenFieldName")
token_relative_url = sgqlc.types.Field(String, graphql_name="tokenRelativeUrl")563. EntityManagementSignatureDetails¶
A set of signature details for a blob signature
Available fields:
keyId: Id for the key used for signingsignature: Signature of the blobsigningAlgorithm: Algorithm used for signing
class EntityManagementSignatureDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key_id", "signature", "signing_algorithm")
key_id = sgqlc.types.Field(String, graphql_name="keyId")
signature = sgqlc.types.Field(String, graphql_name="signature")
signing_algorithm = sgqlc.types.Field(String, graphql_name="signingAlgorithm")564. EntityManagementSigningCredential¶
SigningCredential to verify incoming webhook request
Available fields:
signingAlgorithm: Signing algorithm for verifying signaturesigningKeyReference: The signing key to use for verifying signature
class EntityManagementSigningCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("signing_algorithm", "signing_key_reference")
signing_algorithm = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSigningAlgorithm),
graphql_name="signingAlgorithm",
)
signing_key_reference = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="signingKeyReference",
)565. EntityManagementStringCondition¶
String condition type.
Available fields:
operator: String condition type operator.value: Value to compare against.
class EntityManagementStringCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("operator", "value")
operator = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementStringOperator), graphql_name="operator"
)
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")566. EntityManagementSyncGroupRule¶
Rule to create teams from groups.
Available fields:
conditions: The conditions of the rule.
class EntityManagementSyncGroupRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("conditions",)
conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("EntityManagementSyncGroupRuleCondition")
)
),
graphql_name="conditions",
)567. EntityManagementSyncGroupRuleCondition¶
Sync group rule condition.
Available fields:
type: The condition type.value: The value to match.
class EntityManagementSyncGroupRuleCondition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type", "value")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSyncGroupRuleConditionType),
graphql_name="type",
)
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")568. EntityManagementSyncGroupsSettings¶
Groups sync related settings.
Available fields:
enabled: If sync groups is enabled for that organization or not.rules: The rules to create teams from groups.
class EntityManagementSyncGroupsSettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "rules")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSyncGroupRule)),
graphql_name="rules",
)569. EntityManagementSynchronizedGitHubTeams¶
Type for SynchronizedGitHubTeams
Available fields:
teams: A list of GitHub teams selected by the customer
class EntityManagementSynchronizedGitHubTeams(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("teams",)
teams = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementGitHubTeam))
),
graphql_name="teams",
)570. EntityManagementTag¶
An entity tag.
Available fields:
key: The key or name of the tag.values: The list of values of the tag.
class EntityManagementTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)571. EntityManagementTeamEntityCreateResult¶
The result of creating an entity.
Available fields:
entity: The created entity.
class EntityManagementTeamEntityCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamEntity"), graphql_name="entity"
)572. EntityManagementTeamEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementTeamEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamEntity"), graphql_name="entity"
)573. EntityManagementTeamExternalIntegration¶
Integration with an external system.
Available fields:
externalId: The id in the external system.type: The type of the Integration.
class EntityManagementTeamExternalIntegration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("external_id", "type")
external_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="externalId")
type = sgqlc.types.Field(
EntityManagementTeamExternalIntegrationType, graphql_name="type"
)574. EntityManagementTeamResource¶
Any extra information attached to a Team.
Available fields:
content: Holds the content of the resource.title: Main text for the resource, use the content if null.type: Type of resource, the UI might be enriched based on the value.
class EntityManagementTeamResource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("content", "title", "type")
content = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="content")
title = sgqlc.types.Field(String, graphql_name="title")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")575. EntityManagementTeamsHierarchyLevelEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementTeamsHierarchyLevelEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamsHierarchyLevelEntity"),
graphql_name="entity",
)576. EntityManagementTeamsOrganizationSettingsEntityUpdateResult¶
The result of updating an entity.
Available fields:
entity: The updated entity.
class EntityManagementTeamsOrganizationSettingsEntityUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamsOrganizationSettingsEntity"),
graphql_name="entity",
)577. EntityManagementTemplateFieldType¶
Mapping from the Work Item entity to the third party app fields
Available fields:
direction: Sync direction of the field: OUTBOUND, INBOUNDname: The name of the external system fieldrequired: Indicate if the field is requiredtemplate: Specify how to map from a Work Item using handlebar
class EntityManagementTemplateFieldType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("direction", "name", "required", "template")
direction = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSyncDirection), graphql_name="direction"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
required = sgqlc.types.Field(Boolean, graphql_name="required")
template = sgqlc.types.Field(String, graphql_name="template")578. EntityManagementTokenTextSplitterOptions¶
The TokenTextSplitter options
Available fields:
encodingName: Encoding to token splitter
class EntityManagementTokenTextSplitterOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("encoding_name",)
encoding_name = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEncodingName), graphql_name="encodingName"
)579. EntityManagementUserMetadata¶
Deprecated: User Metadata
Available fields:
createdAt: The object creation time.updatedAt: The object last update time.userId: User ID that created this object.
class EntityManagementUserMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "updated_at", "user_id")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
user_id = sgqlc.types.Field(ID, graphql_name="userId")580. EntityManagementUsers¶
Object containing user limit configuration.
Available fields:
appliesToAll: True if this is a global/default user budget, false otherwise.items: Array of all users whose resource consumption limits are managed by this specific Budget Entity instance.
class EntityManagementUsers(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("applies_to_all", "items")
applies_to_all = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="appliesToAll"
)
items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementBudgetUser)),
graphql_name="items",
)581. EntityManagementWorkItemAssignment¶
Represents the assigned entity of a work item, typically a user
Available fields:
identifier: Depends on the type, for New Relic user this is a userIDtype: Work item assignment type: NEW_RELIC_USER_ID, NEW_RELIC_TEAM_ID
class EntityManagementWorkItemAssignment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("identifier", "type")
identifier = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="identifier"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementAssignmentType), graphql_name="type"
)582. EntityManagementWorkItemAttribute¶
Work Item attribute type
Available fields:
name: The name of the attributevalue: The value of the attribute
class EntityManagementWorkItemAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")583. EntityManagementWorkflowDefinitionVersion¶
Represents a Workflow Definition version, uniquely identified by a combination of Workflow Definition ID and version number
Available fields:
id: The Workflow Definition IDversion: The Workflow Definition Version Number
class EntityManagementWorkflowDefinitionVersion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "version")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")584. EntityManagementZoomAccountOAuthCredential¶
Account OAuth credential type for Zoom
Available fields:
accessToken: The access token for the OAuth requestaccountId: Zoom account ID associated with this credentialclientId: The client ID for the OAuth requestclientSecret: The client secret for the OAuth requesttokenExpirationTime: Expiration time for the access token
class EntityManagementZoomAccountOAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"access_token",
"account_id",
"client_id",
"client_secret",
"token_expiration_time",
)
access_token = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="accessToken",
)
account_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="accountId"
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="clientId")
client_secret = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="clientSecret",
)
token_expiration_time = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="tokenExpirationTime"
)585. EntityManagementZoomCredentials¶
Base credentials type for Zoom
Available fields:
accountOAuth: Account OAuth supportuserOAuth: User OAuth support
class EntityManagementZoomCredentials(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_oauth", "user_oauth")
account_oauth = sgqlc.types.Field(
EntityManagementZoomAccountOAuthCredential, graphql_name="accountOAuth"
)
user_oauth = sgqlc.types.Field(
"EntityManagementZoomUserOAuthCredential", graphql_name="userOAuth"
)586. EntityManagementZoomUserOAuthCredential¶
User OAuth credential type for Zoom
Available fields:
accessToken: The access token for the OAuth requestaccessTokenExpirationTime: Expiration time for the access tokenclientId: The client ID for the OAuth requestclientSecret: The client secret for the OAuth requestrefreshToken: The refresh token for the OAuth requestuserId: Zoom user ID associated with this credential
class EntityManagementZoomUserOAuthCredential(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"access_token",
"access_token_expiration_time",
"client_id",
"client_secret",
"refresh_token",
"user_id",
)
access_token = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="accessToken",
)
access_token_expiration_time = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="accessTokenExpirationTime",
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="clientId")
client_secret = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="clientSecret",
)
refresh_token = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference),
graphql_name="refreshToken",
)
user_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="userId")587. EntityRelationship¶
An entity relationship
Available fields:
type: The type of the relationship. For details, visit our docs.
class EntityRelationship(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(EntityRelationshipType, graphql_name="type")588. EntityRelationshipNode¶
A node in an Entity relationship.
Available fields:
entity
class EntityRelationshipNode(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(EntityOutline, graphql_name="entity")589. EntityRelationshipRelatedEntitiesResult¶
Response containing entity relationships.
Available fields:
nextCursor: The next cursor for fetching additional paginated results.results: The list of entity relationships.
class EntityRelationshipRelatedEntitiesResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityRelationshipEdge))
),
graphql_name="results",
)590. EntityRelationshipUserDefinedCreateOrReplaceResult¶
The result of the entityRelationshipUserDefinedCreateOrReplace mutation.
Available fields:
errors: The list of errors that occurred when executing the mutation.
class EntityRelationshipUserDefinedCreateOrReplaceResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(
"EntityRelationshipUserDefinedCreateOrReplaceResultError"
)
),
graphql_name="errors",
)591. EntityRelationshipUserDefinedCreateOrReplaceResultError¶
The entityRelationshipUserDefinedCreateOrReplace result error.
Available fields:
message: A message explaining what the error is about.type: The mutation error type.
class EntityRelationshipUserDefinedCreateOrReplaceResultError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityRelationshipUserDefinedCreateOrReplaceErrorType),
graphql_name="type",
)592. EntityRelationshipUserDefinedDeleteResult¶
The result of the entityRelationshipUserDefinedDelete mutation.
Available fields:
errors: The list of errors that occurred when executing the mutation.
class EntityRelationshipUserDefinedDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("EntityRelationshipUserDefinedDeleteResultError")
),
graphql_name="errors",
)593. EntityRelationshipUserDefinedDeleteResultError¶
The entityRelationshipUserDefinedDelete result error.
Available fields:
message: A message explaining what the error is about.type: The mutation error type.
class EntityRelationshipUserDefinedDeleteResultError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(EntityRelationshipUserDefinedDeleteErrorType),
graphql_name="type",
)594. EntityRelationshipVertex¶
A vertex in an entity relationship edge.
Available fields:
accountId: The account ID of the relationship node.entity: The entity of the relationship node.guid: The entity guid of the relationship node.
class EntityRelationshipVertex(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "entity", "guid")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
entity = sgqlc.types.Field(EntityOutline, graphql_name="entity")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")595. EntitySearch¶
A data structure that contains the detailed response of an entity search.
The direct search result is available through results. Information about the
query itself is available through query, types, and count.
Available fields:
count: The number of entities returned by the entity search.counts: A count of the Entity Search results faceted by a chosen set of criteria.
Note: Unlike a NRQL facet, the facet results do not include entities where the facet value does not exist. Additionally, entities can be tagged with multiple tag values for one tag key. For these reasons, depending on the facet values chosen, the counts field will not always equal the entitySearch.count field.
query: The entity search query string that was generated by thequeryargument or thequeryBuilderargument.results: The paginated results of the entity search.types: The entity types returned by the entity search.
class EntitySearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "counts", "query", "results", "types")
count = sgqlc.types.Field(Int, graphql_name="count")
counts = sgqlc.types.Field(
sgqlc.types.list_of("EntitySearchCounts"),
graphql_name="counts",
args=sgqlc.types.ArgDict(
(
(
"facet",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(EntitySearchCountsFacet)
),
graphql_name="facet",
default=None,
),
),
(
"facet_tags",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="facetTags",
default=None,
),
),
)
),
)
"""Arguments:
* `facet` (`[EntitySearchCountsFacet!]`): A list of criteria to
facet entities by. This can be combined with the `facetTags`
argument to facet by a combination of criteria and tags.
* `facet_tags` (`[String!]`): A list of tags to facet entities by.
For example: `"environment"`, `"region"`. This can be combined
with the `facet` argument to facet by a combination of criteria
and tags. Note: If a tag does not exist on an entity, the
entity will not be counted in the facet results. If an entity
tag has multiple values, it will be counted in all facets that
apply.
"""
query = sgqlc.types.Field(String, graphql_name="query")
results = sgqlc.types.Field(
"EntitySearchResult",
graphql_name="results",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
"""Arguments:
* `cursor` (`String`): The cursor to fetch paginated entity search
results.
"""
types = sgqlc.types.Field(
sgqlc.types.list_of("EntitySearchTypes"), graphql_name="types"
)596. EntitySearchCounts¶
The groupings and counts of entities returned for the specified criteria.
Available fields:
count: The number of entities that match the specified criteria.facet: The group of entities returned for the specified criteria.
class EntitySearchCounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "facet")
count = sgqlc.types.Field(Int, graphql_name="count")
facet = sgqlc.types.Field(AttributeMap, graphql_name="facet")597. EntitySearchResult¶
A section of the entity search results. If there is a nextCursor present, there are more results available.
Available fields:
entities: The entities contained in this section of the entity search results.
For information on New Relic entities, visit our docs.
To see some query examples of entity information, visit our entity GraphQL API docs.
nextCursor: The next cursor for fetching additional paginated entity search results.
class EntitySearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "next_cursor")
entities = sgqlc.types.Field(
sgqlc.types.list_of(EntityOutline), graphql_name="entities"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")598. EntitySearchTypes¶
A detailed entity search response object type.
Available fields:
count: The number of results with this type.domain: The domain of the search result group.entityType: The combined domain & type of the search result group.type: The type of the search result group.
class EntitySearchTypes(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "domain", "entity_type", "type")
count = sgqlc.types.Field(Int, graphql_name="count")
domain = sgqlc.types.Field(String, graphql_name="domain")
entity_type = sgqlc.types.Field(EntityType, graphql_name="entityType")
type = sgqlc.types.Field(String, graphql_name="type")599. EntityTag¶
A tag that has been applied to an entity.
Available fields:
key: The tag’s keyvalues: A list of the tag values
class EntityTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(String, graphql_name="key")
values = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="values")600. EntityTagValueWithMetadata¶
The value and metadata of a single entity tag.
Available fields:
mutable: Whether or not the tag can be mutated by the user.value: The tag value.
class EntityTagValueWithMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("mutable", "value")
mutable = sgqlc.types.Field(Boolean, graphql_name="mutable")
value = sgqlc.types.Field(String, graphql_name="value")601. EntityTagWithMetadata¶
The tags with metadata of the entity.
Available fields:
key: The tag’s key.values: A list of tag values with metadata information.
class EntityTagWithMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(String, graphql_name="key")
values = sgqlc.types.Field(
sgqlc.types.list_of(EntityTagValueWithMetadata), graphql_name="values"
)602. ErrorsInboxActorStitchedFields¶
Available fields:
errorGroup: Retrieve metadata on a specific error group.errorGroupStateTypes: List of error group state valueserrorGroups: Search error groups.
class ErrorsInboxActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_group", "error_group_state_types", "error_groups")
error_group = sgqlc.types.Field(
"ErrorsInboxErrorGroup",
graphql_name="errorGroup",
args=sgqlc.types.ArgDict(
(
(
"error_event",
sgqlc.types.Arg(
ErrorsInboxErrorEventInput,
graphql_name="errorEvent",
default=None,
),
),
("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),
)
),
)
"""Arguments:
* `error_event` (`ErrorsInboxErrorEventInput`): Error event that
will be encoded to a unique error group id.
* `id` (`ID`): The unique identifier of the group being fetched.
"""
error_group_state_types = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("ErrorsInboxErrorGroupStateTypeResult")
),
graphql_name="errorGroupStateTypes",
)
error_groups = sgqlc.types.Field(
"ErrorsInboxErrorGroupsResponse",
graphql_name="errorGroups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"entity_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid)),
graphql_name="entityGuids",
default=None,
),
),
(
"filter",
sgqlc.types.Arg(
ErrorsInboxErrorGroupSearchFilterInput,
graphql_name="filter",
default=None,
),
),
("query", sgqlc.types.Arg(String, graphql_name="query", default=None)),
(
"sort_by",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(ErrorsInboxErrorGroupSortOrderInput)
),
graphql_name="sortBy",
default=None,
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Current query cursor
* `entity_guids` (`[EntityGuid!]`): Filter to specified entities.
* `filter` (`ErrorsInboxErrorGroupSearchFilterInput`): Set of
filters to be applied to the search.
* `query` (`String`): Query string to filter the error groups by
* `sort_by` (`[ErrorsInboxErrorGroupSortOrderInput!]`): Sort order
for results. (limit: 1)
* `time_window` (`TimeWindowInput`): Time Window for search
"""603. ErrorsInboxAssignErrorGroupResponse¶
Response for error group assignment mutation.
Available fields:
assignment: User that was assigned to the error group.errors: List of errors encountered.
class ErrorsInboxAssignErrorGroupResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("assignment", "errors")
assignment = sgqlc.types.Field("ErrorsInboxAssignment", graphql_name="assignment")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("ErrorsInboxAssignErrorGroupError")),
graphql_name="errors",
)604. ErrorsInboxAssignment¶
User assigned to an error group.
Available fields:
email: Email address of the user.userInfo: Additional user data for New Relic users.
class ErrorsInboxAssignment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "user_info")
email = sgqlc.types.Field(String, graphql_name="email")
user_info = sgqlc.types.Field("UserReference", graphql_name="userInfo")605. ErrorsInboxDeleteErrorGroupResourceResponse¶
Response for delete resource mutation.
Available fields:
resourceId: Id of the deleted resource
class ErrorsInboxDeleteErrorGroupResourceResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("resource_id",)
resource_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="resourceId")606. ErrorsInboxErrorGroupStateTypeResult¶
Information about the error group state type
Available fields:
type: Type of the error group state
class ErrorsInboxErrorGroupStateTypeResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(ErrorsInboxErrorGroupState, graphql_name="type")607. ErrorsInboxErrorGroupsResponse¶
Response for error groups.
Available fields:
nextCursor: Cursor to get the next page of results.results: List of error groups.totalCount: Total error groups matching query
class ErrorsInboxErrorGroupsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("ErrorsInboxErrorGroupOutline")),
graphql_name="results",
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")608. ErrorsInboxOccurrences¶
The occurrences of an error group
Available fields:
expectedCount: Total number of expected occurrences in the given time window.firstSeenAt: Time of first occurrence in the given time window.lastSeenAt: Time of last occurrence in the given time window.totalCount: Total number of occurrences in the given time window.
class ErrorsInboxOccurrences(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("expected_count", "first_seen_at", "last_seen_at", "total_count")
expected_count = sgqlc.types.Field(Int, graphql_name="expectedCount")
first_seen_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="firstSeenAt")
last_seen_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastSeenAt")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")609. ErrorsInboxResourcesResponse¶
Response for error group resources.
Available fields:
nextCursor: Cursor used to fetch the next set of resultsresults: The list of search resultstotalCount: The total number of results that match the search
class ErrorsInboxResourcesResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ErrorsInboxResource))
),
graphql_name="results",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)610. ErrorsInboxUpdateErrorGroupStateResponse¶
Response for error group state mutation.
Available fields:
resolveInNextVersion: Configures errors inbox to use change tracking to resolve an error group in the next tracked version.state: Updated state value.versions: Versions of the entity for which an error group’s state applies.
class ErrorsInboxUpdateErrorGroupStateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("resolve_in_next_version", "state", "versions")
resolve_in_next_version = sgqlc.types.Field(
Boolean, graphql_name="resolveInNextVersion"
)
state = sgqlc.types.Field(ErrorsInboxErrorGroupState, graphql_name="state")
versions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("ErrorsInboxVersion")),
graphql_name="versions",
)611. ErrorsInboxVersion¶
Version details (ex: for first and last seen versions or an error group state)
Available fields:
name: Version name
class ErrorsInboxVersion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name",)
name = sgqlc.types.Field(String, graphql_name="name")612. EventAttributeDefinition¶
A human-readable definition of an NRDB Event Type Attribute
Available fields:
definition: A short description of this attributedocumentationUrl: The New Relic docs page for this attributelabel: The human-friendly formatted name of the attributename: The name of the attribute
class EventAttributeDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition", "documentation_url", "label", "name")
definition = sgqlc.types.Field(String, graphql_name="definition")
documentation_url = sgqlc.types.Field(String, graphql_name="documentationUrl")
label = sgqlc.types.Field(String, graphql_name="label")
name = sgqlc.types.Field(String, graphql_name="name")613. EventDefinition¶
A human-readable definition of an NRDB Event Type
Available fields:
attributes: A list of attribute definitions for this event typedefinition: A short description of this eventlabel: The human-friendly formatted name of the eventname: The name of the event
class EventDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "definition", "label", "name")
attributes = sgqlc.types.Field(
sgqlc.types.list_of(EventAttributeDefinition), graphql_name="attributes"
)
definition = sgqlc.types.Field(String, graphql_name="definition")
label = sgqlc.types.Field(String, graphql_name="label")
name = sgqlc.types.Field(String, graphql_name="name")614. EventsToMetricsAccountStitchedFields¶
Account stitched fields to enable autostitching in NerdGraph
Available fields:
allRules: List all rules for your account.rulesById: List rules for your account by id.
class EventsToMetricsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("all_rules", "rules_by_id")
all_rules = sgqlc.types.Field(
"EventsToMetricsListRuleResult", graphql_name="allRules"
)
rules_by_id = sgqlc.types.Field(
"EventsToMetricsListRuleResult",
graphql_name="rulesById",
args=sgqlc.types.ArgDict(
(
(
"rule_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ruleIds",
default=None,
),
),
)
),
)
"""Arguments:
* `rule_ids` (`[ID]!`): Rule ids you want to list (as strings).
"""615. EventsToMetricsCreateRuleFailure¶
Error details about the events to metrics rule that failed to be created and why.
Available fields:
errors: Information about why the create failed.submitted: Input information about a submitted rule that was unable to be created.
class EventsToMetricsCreateRuleFailure(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "submitted")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EventsToMetricsError"), graphql_name="errors"
)
submitted = sgqlc.types.Field(
"EventsToMetricsCreateRuleSubmission", graphql_name="submitted"
)616. EventsToMetricsCreateRuleResult¶
The result of which submitted events to metrics rules were successfully and unsuccessfully created
Available fields:
failures: Rules that were not created and why.successes: Rules that were successfully created.
class EventsToMetricsCreateRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failures", "successes")
failures = sgqlc.types.Field(
sgqlc.types.list_of(EventsToMetricsCreateRuleFailure), graphql_name="failures"
)
successes = sgqlc.types.Field(
sgqlc.types.list_of("EventsToMetricsRule"), graphql_name="successes"
)617. EventsToMetricsCreateRuleSubmission¶
The details that were submitted when creating an events to metrics conversion rule.
Available fields:
accountId: The account where the events exist and the metrics will be put.description: Provides additional information about the rule.name: The name of the rule. This must be unique within a given account.nrql: Explains how to create one or more metrics from events.
class EventsToMetricsCreateRuleSubmission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "description", "name", "nrql")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
description = sgqlc.types.Field(String, graphql_name="description")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nrql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="nrql")618. EventsToMetricsDeleteRuleFailure¶
Error details about the events to metrics rule that failed to be deleted and why.
Available fields:
errors: Information about why the delete failed.submitted: Input information about a submitted rule that was unable to be deleted.
class EventsToMetricsDeleteRuleFailure(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "submitted")
errors = sgqlc.types.Field(
sgqlc.types.list_of("EventsToMetricsError"), graphql_name="errors"
)
submitted = sgqlc.types.Field(
"EventsToMetricsDeleteRuleSubmission", graphql_name="submitted"
)619. EventsToMetricsDeleteRuleResult¶
The result of which submitted events to metrics rules were successfully and unsuccessfully deleted.
Available fields:
failures: Information about the rules that could not be deleted.successes: Rules that were successfully deleted.
class EventsToMetricsDeleteRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failures", "successes")
failures = sgqlc.types.Field(
sgqlc.types.list_of(EventsToMetricsDeleteRuleFailure), graphql_name="failures"
)
successes = sgqlc.types.Field(
sgqlc.types.list_of("EventsToMetricsRule"), graphql_name="successes"
)620. EventsToMetricsDeleteRuleSubmission¶
The details that were submitted when deleteing an events to metrics conversion rule.
Available fields:
accountId: A submitted account id.ruleId: A submitted rule id.
class EventsToMetricsDeleteRuleSubmission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "rule_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
rule_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="ruleId")621. EventsToMetricsError¶
Error details when processing events to metrics rule requests.
Available fields:
description: A detailed error message.reason: The category of error that occurred.
class EventsToMetricsError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "reason")
description = sgqlc.types.Field(String, graphql_name="description")
reason = sgqlc.types.Field(EventsToMetricsErrorReason, graphql_name="reason")622. EventsToMetricsListRuleResult¶
A list of rule details to be returned.
Available fields:
rules: Event-to-metric rules to be returned.
class EventsToMetricsListRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("rules",)
rules = sgqlc.types.Field(
sgqlc.types.list_of("EventsToMetricsRule"), graphql_name="rules"
)623. EventsToMetricsRule¶
Information about an event-to-metric rule which creates metrics from events.
Available fields:
accountId: Account with the event and where the metrics will be placed.createdAt: The time at which the rule was createddescription: Additional information about the rule.enabled: True means this rule is enabled. False means the rule is currently not creating metrics.id: The id, uniquely identifying the rule.name: The name of the rule. This must be unique within an account.nrql: Explains how to create metrics from events.updatedAt: The time at which the rule was updated
class EventsToMetricsRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"description",
"enabled",
"id",
"name",
"nrql",
"updated_at",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nrql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="nrql")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)624. EventsToMetricsUpdateRuleFailure¶
Error details about the events to metrics rule that failed to be updated and why.
Available fields:
errors: Information about why the update failed.submitted: Input information about a failed update.
class EventsToMetricsUpdateRuleFailure(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "submitted")
errors = sgqlc.types.Field(
sgqlc.types.list_of(EventsToMetricsError), graphql_name="errors"
)
submitted = sgqlc.types.Field(
"EventsToMetricsUpdateRuleSubmission", graphql_name="submitted"
)625. EventsToMetricsUpdateRuleResult¶
The result of which submitted events to metrics rules were successfully and unsuccessfully update.
Available fields:
failures: Rules that failed to get updated.successes: Rules that were successfully enabled or disabled.
class EventsToMetricsUpdateRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failures", "successes")
failures = sgqlc.types.Field(
sgqlc.types.list_of(EventsToMetricsUpdateRuleFailure), graphql_name="failures"
)
successes = sgqlc.types.Field(
sgqlc.types.list_of(EventsToMetricsRule), graphql_name="successes"
)626. EventsToMetricsUpdateRuleSubmission¶
The details that were submitted when updating an events to metrics conversion rule.
Available fields:
accountId: A submitted account id.enabled: Changes the state of the rule as being enabled or disabled.ruleId: A submitted rule id.
class EventsToMetricsUpdateRuleSubmission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "enabled", "rule_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
rule_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="ruleId")627. FleetControlActor¶
Represents an actor
Available fields:
id: Id of the actor
class FleetControlActor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")628. FleetControlActorStitchedFields¶
Available fields:
fleetMembers: List managed entities for a fleethealthCheck: Service Healthcheck
class FleetControlActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("fleet_members", "health_check")
fleet_members = sgqlc.types.Field(
"FleetControlFleetMembersItemsResult",
graphql_name="fleetMembers",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlFleetMembersFilterInput),
graphql_name="filter",
default=None,
),
),
)
),
)
health_check = sgqlc.types.Field(String, graphql_name="healthCheck")629. FleetControlCollectionEntity¶
Entity type to represent collections of entities
Available fields:
id: The collection entity idmetadata: Metadata about the entityname: The name of this entityscope: The entity’s scopetags: Collection of tagstype: The entity type
class FleetControlCollectionEntity(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "name", "scope", "tags", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlMetadata"), graphql_name="metadata"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlScopedReference"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("FleetControlTag")),
graphql_name="tags",
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")630. FleetControlConfigurationVersionList¶
Properties of a configuration version
Available fields:
id: Configuration version id
class FleetControlConfigurationVersionList(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")631. FleetControlCreateFleetResult¶
The result of creating a fleet
Available fields:
entity: The created fleet entity
class FleetControlCreateFleetResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlFleetEntityResult"), graphql_name="entity"
)632. FleetControlDeleteFleetResult¶
The result returned when deleting a fleet
Available fields:
id: Fleet entity id
class FleetControlDeleteFleetResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")633. FleetControlDeployFleetResult¶
The result returned when deploying a configuration to a fleet - DEPRECATED
Available fields:
fleetGuid: The fleet entity id - DEPRECATEDfleetId: The fleet entity id
class FleetControlDeployFleetResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("fleet_guid", "fleet_id")
fleet_guid = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetGuid")
fleet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetId")634. FleetControlDeployResult¶
The result returned when deploying a configuration to a fleet
Available fields:
id: The deployment entity id
class FleetControlDeployResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")635. FleetControlFleetDeploymentCreateResult¶
The result of creating a fleet deployment
Available fields:
entity: The created entity
class FleetControlFleetDeploymentCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlFleetDeploymentResult"), graphql_name="entity"
)636. FleetControlFleetDeploymentDeleteResult¶
The result of deleting a fleet deployment
Available fields:
id: Fleet deployment entity id
class FleetControlFleetDeploymentDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")637. FleetControlFleetDeploymentResult¶
The result returned for a fleet deployment
Available fields:
configurationVersionList: Fleet deployment configuration version listdescription: Fleet deployment descriptionfleetId: Fleet entity idid: Fleet deployment entity idmetadata: Metadata about the entityname: Fleet deployment namephase: Fleet deployment phaseringsDeploymentTracker: Fleet deployment ring trackerscope: The entity’s scopetags: The fleet deployment tagstype: The entity type
class FleetControlFleetDeploymentResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"configuration_version_list",
"description",
"fleet_id",
"id",
"metadata",
"name",
"phase",
"rings_deployment_tracker",
"scope",
"tags",
"type",
)
configuration_version_list = sgqlc.types.Field(
sgqlc.types.list_of(FleetControlConfigurationVersionList),
graphql_name="configurationVersionList",
)
description = sgqlc.types.Field(String, graphql_name="description")
fleet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlMetadata"), graphql_name="metadata"
)
name = sgqlc.types.Field(String, graphql_name="name")
phase = sgqlc.types.Field(FleetControlFleetDeploymentPhase, graphql_name="phase")
rings_deployment_tracker = sgqlc.types.Field(
sgqlc.types.list_of("FleetControlRingsDeploymentTracker"),
graphql_name="ringsDeploymentTracker",
)
scope = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlScopedReference"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("FleetControlTag")),
graphql_name="tags",
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")638. FleetControlFleetDeploymentUpdateResult¶
The result of updating a fleet deployment
Available fields:
entity: The updated entity
class FleetControlFleetDeploymentUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null(FleetControlFleetDeploymentResult), graphql_name="entity"
)639. FleetControlFleetEntityResult¶
The result returned for an updated fleet entity
Available fields:
description: Fleet entity descriptionid: Fleet entity idmanagedEntityRings: Associates rings of managed entities for the fleetmanagedEntityType: Type of entity the fleet will managemetadata: Metadata about the entityname: Fleet entity nameoperatingSystem: Operating system information for HOST fleetsproduct: Fleet specific product type. The only supported value is ‘PCG’ for PipelineControlGateway fleets.scope: Fleet entity scopetags: Fleet entity tagstype: Fleet entity type
class FleetControlFleetEntityResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"id",
"managed_entity_rings",
"managed_entity_type",
"metadata",
"name",
"operating_system",
"product",
"scope",
"tags",
"type",
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
managed_entity_rings = sgqlc.types.Field(
FleetControlCollectionEntity, graphql_name="managedEntityRings"
)
managed_entity_type = sgqlc.types.Field(
sgqlc.types.non_null(FleetControlManagedEntityType),
graphql_name="managedEntityType",
)
metadata = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlMetadata"), graphql_name="metadata"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
operating_system = sgqlc.types.Field(
"FleetControlOperatingSystem", graphql_name="operatingSystem"
)
product = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="product"
)
scope = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlScopedReference"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("FleetControlTag")),
graphql_name="tags",
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")640. FleetControlFleetMemberEntityResult¶
Result representing a managed entity in a fleet
Available fields:
id: The entity idmetadata: Metadata about the entityname: The entity namescope: The entity’s scopetags: Collection of tagstype: The entity type
class FleetControlFleetMemberEntityResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "name", "scope", "tags", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlMetadata"), graphql_name="metadata"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(
sgqlc.types.non_null("FleetControlScopedReference"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("FleetControlTag")),
graphql_name="tags",
)
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")641. FleetControlFleetMemberRing¶
The ring to modify entities
Available fields:
entityIds: The list of entityIds modified on the fleetring: The ring name to modify entities
class FleetControlFleetMemberRing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity_ids", "ring")
entity_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)), graphql_name="entityIds"
)
ring = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="ring")642. FleetControlFleetMembersItemsResult¶
Result of listing managed entities in a fleet
Available fields:
items: The entities returned when querying the fleet membersnextCursor: Index to retrieve the next set of paginated results
class FleetControlFleetMembersItemsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(FleetControlFleetMemberEntityResult)
)
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")643. FleetControlFleetMembersResult¶
The result returned when modifying managed entities on a fleet
Available fields:
fleetId: The fleet entity idmembers: The list of modified managed entities on a fleet ring
class FleetControlFleetMembersResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("fleet_id", "members")
fleet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetId")
members = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(FleetControlFleetMemberRing)),
graphql_name="members",
)644. FleetControlMetadata¶
Metadata of an entity
Available fields:
createdAt: The entity’s creation timecreatedBy: Actor that created this entityupdatedAt: The entity’s last update timeupdatedBy: Actor that updated this entity
class FleetControlMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "created_by", "updated_at", "updated_by")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field(FleetControlActor, graphql_name="createdBy")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field(FleetControlActor, graphql_name="updatedBy")645. FleetControlOperatingSystem¶
Operating System string enum for the host operating systems in a fleet
Available fields:
type: The operating system type enum
class FleetControlOperatingSystem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(FleetControlOperatingSystemType), graphql_name="type"
)646. FleetControlRingsDeploymentTracker¶
The deployment status for a ring
Available fields:
completedAt: Rollout end timename: Ring namestartedAt: Rollout start timestatus: Ring deployment status
class FleetControlRingsDeploymentTracker(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("completed_at", "name", "started_at", "status")
completed_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="completedAt")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
started_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="startedAt")
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")647. FleetControlScopedReference¶
Scoped properties of an entity
Available fields:
id: Scope id of the entitytype: Scope type of the entity
class FleetControlScopedReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(FleetControlEntityScope), graphql_name="type"
)648. FleetControlTag¶
Collection of tags
Available fields:
key: The tag keyvalues: List of tag values
class FleetControlTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)649. FleetControlUpdateFleetResult¶
The result of updating a fleet
Available fields:
entity: The updated fleet entity
class FleetControlUpdateFleetResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity",)
entity = sgqlc.types.Field(
sgqlc.types.non_null(FleetControlFleetEntityResult), graphql_name="entity"
)650. HistoricalDataExportAccountStitchedFields¶
Available fields:
export: Retrieve a single export by export idexports: Retrieve all exports for an account
class HistoricalDataExportAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("export", "exports")
export = sgqlc.types.Field(
"HistoricalDataExportCustomerExportResponse",
graphql_name="export",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
exports = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("HistoricalDataExportCustomerExportResponse")
),
graphql_name="exports",
)651. HistoricalDataExportCustomerExportResponse¶
A Historic Export. Contains information about the request and the current status of that request.
Available fields:
account: The id of the account whose data the Export will run againstavailableUntil: The time at which the results of this Export expire and are no longer available. Null values indicate that the export is not ready and does not have an expiration time yetbeginTime: The beginning of the time range of this Export. Determined from the Query StringcreatedAt: The time at which the Export Request was createdendTime: The end of the time range of this Export. Determined from the Query StringeventCount: The number of events returned by this ExporteventTypes: The event types that the Export will run against. Determined from the Query Stringid: Unique Identifier for the Exportmessage: If relevant, an error message about the status of the current exportnrql: The NRQL query for which this Export will runpercentComplete: The current completion percentage of this Exportresults: A list of urls to download the resulting files. Null values indicate that result files are not yet ready for downloadstatus: The current status of this Exportuser: The ID of the user who submitted this Export Request
class HistoricalDataExportCustomerExportResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"available_until",
"begin_time",
"created_at",
"end_time",
"event_count",
"event_types",
"id",
"message",
"nrql",
"percent_complete",
"results",
"status",
"user",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
available_until = sgqlc.types.Field(
EpochMilliseconds, graphql_name="availableUntil"
)
begin_time = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="beginTime"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
end_time = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="endTime"
)
event_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="eventCount"
)
event_types = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="eventTypes",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
message = sgqlc.types.Field(String, graphql_name="message")
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")
percent_complete = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="percentComplete"
)
results = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="results")
status = sgqlc.types.Field(
sgqlc.types.non_null(HistoricalDataExportStatus), graphql_name="status"
)
user = sgqlc.types.Field("UserReference", graphql_name="user")652. IncidentIntelligenceEnvironmentAccountStitchedFields¶
Available fields:
currentEnvironment: Retrieves the incident intelligence environment based on the user’s authentication and product entitlement
class IncidentIntelligenceEnvironmentAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("current_environment",)
current_environment = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentCurrentEnvironmentResult",
graphql_name="currentEnvironment",
args=sgqlc.types.ArgDict(
(
(
"kind",
sgqlc.types.Arg(
IncidentIntelligenceEnvironmentSupportedEnvironmentKind,
graphql_name="kind",
default=None,
),
),
)
),
)
"""Arguments:
* `kind`
(`IncidentIntelligenceEnvironmentSupportedEnvironmentKind`):
Which environment kind to support when evaluating the query
"""653. IncidentIntelligenceEnvironmentActorStitchedFields¶
Available fields:
authorizedEnvironments: A list of potential environments is returned based on the authorized accounts listconsentedAccounts: Retrieves a list of authorized accounts the user is authorized for that have been marked with consent by an admin of that account.currentEnvironment: Retrieves the incident intelligence environment based on the user’s authentication and product entitlement, if an account id is not provided, the environment is detected based on the authorized accounts.In cases where a user have more then one potential environment, the account must be provided.
class IncidentIntelligenceEnvironmentActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authorized_environments",
"consented_accounts",
"current_environment",
)
authorized_environments = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(
"IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment"
)
),
graphql_name="authorizedEnvironments",
args=sgqlc.types.ArgDict(
(
(
"kind",
sgqlc.types.Arg(
IncidentIntelligenceEnvironmentSupportedEnvironmentKind,
graphql_name="kind",
default=None,
),
),
)
),
)
consented_accounts = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("IncidentIntelligenceEnvironmentConsentedAccount")
),
graphql_name="consentedAccounts",
)
current_environment = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentCurrentEnvironmentResult",
graphql_name="currentEnvironment",
args=sgqlc.types.ArgDict(
(
(
"kind",
sgqlc.types.Arg(
IncidentIntelligenceEnvironmentSupportedEnvironmentKind,
graphql_name="kind",
default=None,
),
),
)
),
)
"""Arguments:
* `kind`
(`IncidentIntelligenceEnvironmentSupportedEnvironmentKind`):
Which environment kind to support when evaluating the query
"""654. IncidentIntelligenceEnvironmentConsentAccounts¶
Consent accounts to usage of the Incident Intelligence product for EU or FedRAMP
Available fields:
consentedAccounts: The list of accounts marked with consentresult: The outcome of the consent marking
class IncidentIntelligenceEnvironmentConsentAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("consented_accounts", "result")
consented_accounts = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("IncidentIntelligenceEnvironmentConsentedAccount")
),
graphql_name="consentedAccounts",
)
result = sgqlc.types.Field(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentConsentAccountsResult),
graphql_name="result",
)655. IncidentIntelligenceEnvironmentConsentAuthorizedAccounts¶
Consent all the user’s authorized accounts for the Incident Intelligence product for EU or FedRAMP
Available fields:
consentedAccounts: The list of accounts marked with consentresult: The outcome of the consent marking
class IncidentIntelligenceEnvironmentConsentAuthorizedAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("consented_accounts", "result")
consented_accounts = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("IncidentIntelligenceEnvironmentConsentedAccount")
),
graphql_name="consentedAccounts",
)
result = sgqlc.types.Field(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentConsentAccountsResult),
graphql_name="result",
)656. IncidentIntelligenceEnvironmentConsentedAccount¶
Represent an account that is mark with consent for Incident Intelligence usage
Available fields:
account: The account marked with consent
class IncidentIntelligenceEnvironmentConsentedAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account",)
account = sgqlc.types.Field(AccountReference, graphql_name="account")657. IncidentIntelligenceEnvironmentCreateEnvironment¶
Creates a new Incident Intelligence Environment, will fail if an environment is already attached to the same parent account
Available fields:
result: The outcome of the creationresultDetails: Additional result details
class IncidentIntelligenceEnvironmentCreateEnvironment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("result", "result_details")
result = sgqlc.types.Field(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentCreateEnvironmentResult),
graphql_name="result",
)
result_details = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentCreateEnvironmentResultDetails",
graphql_name="resultDetails",
)658. IncidentIntelligenceEnvironmentCurrentEnvironmentResult¶
An environment will be populated only if the user is attached to a single environment.
Available fields:
environment: The current environment attached to the userreason: The explanation for the environment field resultreasonDetails: The current environment result details
class IncidentIntelligenceEnvironmentCurrentEnvironmentResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("environment", "reason", "reason_details")
environment = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment",
graphql_name="environment",
)
reason = sgqlc.types.Field(
IncidentIntelligenceEnvironmentCurrentEnvironmentResultReason,
graphql_name="reason",
)
reason_details = sgqlc.types.Field(
"IncidentIntelligenceEnvironmentCurrentEnvironmentResultReasonDetails",
graphql_name="reasonDetails",
)659. IncidentIntelligenceEnvironmentDeleteEnvironment¶
Deletes an existing environment
Available fields:
result: The deletion outcome
class IncidentIntelligenceEnvironmentDeleteEnvironment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("result",)
result = sgqlc.types.Field(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentDeleteEnvironmentResult),
graphql_name="result",
)660. IncidentIntelligenceEnvironmentDissentAccounts¶
Dissent accounts to usage of the Incident Intelligence product in the EU/FedRAMP (removes the consent marking).
Available fields:
dissentedAccounts: The list of previously consented accounts, now dissentedresult: The outcome of the dissent marking
class IncidentIntelligenceEnvironmentDissentAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("dissented_accounts", "result")
dissented_accounts = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentConsentedAccount)
),
graphql_name="dissentedAccounts",
)
result = sgqlc.types.Field(
sgqlc.types.non_null(IncidentIntelligenceEnvironmentDissentAccountsResult),
graphql_name="result",
)661. IncidentIntelligenceEnvironmentEnvironmentAlreadyExists¶
Environment already exists detailed result
Available fields:
accountId: The account id of the already exists environmentenvironment: The already exists environmentmasterAccountId: The parent account id of the already exists environment
class IncidentIntelligenceEnvironmentEnvironmentAlreadyExists(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "environment", "master_account_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
environment = sgqlc.types.Field(
sgqlc.types.non_null(
"IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment"
),
graphql_name="environment",
)
master_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="masterAccountId"
)662. IncidentIntelligenceEnvironmentEnvironmentCreated¶
Environment created detailed result
Available fields:
environment: The created environment
class IncidentIntelligenceEnvironmentEnvironmentCreated(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("environment",)
environment = sgqlc.types.Field(
sgqlc.types.non_null(
"IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment"
),
graphql_name="environment",
)663. IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment¶
Represents an AI Incident Intelligence environment. An environment crosses the account boundary and allows correlating data as long as the data’s accounts are attached to the same environment.
Available fields:
associatedAuthorizedAccounts: Authorized accounts associated with the environment. Events from these accounts can be correlated with one another (across the account boundary). The resulting correlated issue will be stored in the Incident Intelligence accountbillingCycleQuota: The assigned quota on the current billing cyclecreatedAt: When the environment was createdcreatedBy: The user that created the environmentincidentIntelligenceAccount: The account attached to the environmentisConsentRequired: True indicates that a consent has to be asked when an environment is created. The consent is to acknowledge that if the account is overaging an additional usage charge may be charged based on extra usageisEntitledForAi: Whether the environment is entitled for AIisFreeTier: True if the environment is part of the free-tier packagekind: The environment kindmasterAccount: The parent account related to the environmentname: The environment namewasConsented: True if the environment was consented, false otherwise
class IncidentIntelligenceEnvironmentIncidentIntelligenceEnvironment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"associated_authorized_accounts",
"billing_cycle_quota",
"created_at",
"created_by",
"incident_intelligence_account",
"is_consent_required",
"is_entitled_for_ai",
"is_free_tier",
"kind",
"master_account",
"name",
"was_consented",
)
associated_authorized_accounts = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(AccountReference)),
graphql_name="associatedAuthorizedAccounts",
)
billing_cycle_quota = sgqlc.types.Field(Int, graphql_name="billingCycleQuota")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
incident_intelligence_account = sgqlc.types.Field(
AccountReference, graphql_name="incidentIntelligenceAccount"
)
is_consent_required = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isConsentRequired"
)
is_entitled_for_ai = sgqlc.types.Field(Boolean, graphql_name="isEntitledForAi")
is_free_tier = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isFreeTier"
)
kind = sgqlc.types.Field(
IncidentIntelligenceEnvironmentEnvironmentKind, graphql_name="kind"
)
master_account = sgqlc.types.Field(AccountReference, graphql_name="masterAccount")
name = sgqlc.types.Field(String, graphql_name="name")
was_consented = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="wasConsented"
)664. IncidentIntelligenceEnvironmentMultipleEnvironmentsAvailable¶
The user has access to more than one environment from the context of this account (only one is allowed)
Available fields:
accountIds: The multiple accounts the user has access to in this context
class IncidentIntelligenceEnvironmentMultipleEnvironmentsAvailable(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids",)
account_ids = sgqlc.types.Field(sgqlc.types.list_of(Int), graphql_name="accountIds")665. IncidentIntelligenceEnvironmentUserNotAuthorizedForAccount¶
The user is not authorized for this account
Available fields:
accountId: The account id the user is not authorized to receive an environment for
class IncidentIntelligenceEnvironmentUserNotAuthorizedForAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id",)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")666. IncidentIntelligenceEnvironmentUserNotCapableToOperateOnAccount¶
The user is not capable to perform an operation on this account
Available fields:
accountId: The account id the user is not capable to perform the operation oncapability: The capability the user is missing
class IncidentIntelligenceEnvironmentUserNotCapableToOperateOnAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "capability")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
capability = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="capability"
)667. InfrastructureHostSummaryData¶
Summary statistics about the Infra Host.
Available fields:
cpuUtilizationPercent: Total CPU utilization as a percentage.diskUsedPercent: The cumulative disk fullness percentage.memoryUsedPercent: Total memory utilization as a percentage.networkReceiveRate: The number of bytes per second received during the sampling period.networkTransmitRate: The number of bytes sent per second during the sampling period.servicesCount: Number of services running on the host.
class InfrastructureHostSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"cpu_utilization_percent",
"disk_used_percent",
"memory_used_percent",
"network_receive_rate",
"network_transmit_rate",
"services_count",
)
cpu_utilization_percent = sgqlc.types.Field(
Float, graphql_name="cpuUtilizationPercent"
)
disk_used_percent = sgqlc.types.Field(Float, graphql_name="diskUsedPercent")
memory_used_percent = sgqlc.types.Field(Float, graphql_name="memoryUsedPercent")
network_receive_rate = sgqlc.types.Field(Float, graphql_name="networkReceiveRate")
network_transmit_rate = sgqlc.types.Field(Float, graphql_name="networkTransmitRate")
services_count = sgqlc.types.Field(Int, graphql_name="servicesCount")668. InstallationAccountStitchedFields¶
Available fields:
installStatus: Look up the install event for a given account.
An install event is a representation for when the newrelic-cli has attempted an installation."
recipeEvents: Look up all recipe events for a given account.
Recipe events are stored in our cache for any given account.
Recipe events are used in the nr1-install-newrelic nerdlet to provide an overview of all the attempted installation statuses.
recipes: Look up recipe events for a given account by installId.statuses: Look up install statuses for a given account by installId.
class InstallationAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("install_status", "recipe_events", "recipes", "statuses")
install_status = sgqlc.types.Field(
"InstallationInstallStatus", graphql_name="installStatus"
)
recipe_events = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("InstallationRecipeEvent")),
graphql_name="recipeEvents",
)
recipes = sgqlc.types.Field(
"InstallationRecipeEventResult",
graphql_name="recipes",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"install_id",
sgqlc.types.Arg(String, graphql_name="installId", default=None),
),
)
),
)
"""Arguments:
* `cursor` (`String`): used to fetch next page of results. If not
present, most recent events (first page) will be returned
* `install_id` (`String`): installId associated to recipe events.
If not present, all recipe events will be returned for the email
provided from the service gateway email header
"""
statuses = sgqlc.types.Field(
"InstallationInstallStatusResult",
graphql_name="statuses",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"install_id",
sgqlc.types.Arg(String, graphql_name="installId", default=None),
),
)
),
)
"""Arguments:
* `cursor` (`String`): used to fetch next page of results. If not
present, most recent install statuses (first page) will be
returned
* `install_id` (`String`): installId associated to recipe events.
If not present, all install statuses will be returned for the
email provided from the service gateway email header
"""669. InstallationInstallStatus¶
An object that contains the overall installation status that is created from within the newrelic-cli.
Available fields:
cliVersion: The version of the newrelic-cli that was used for a given installation attempt.deployedBy: Refers to the source of the installation.enabledProxy: Whether or not the installation is using a proxy.error: The error returned for a given installation attempt.hostName: The host name of the customer’s machine.installId: The unique ID that corresponds to an install status.installLibraryVersion: The version of the open-install-library that is being used.isUnsupported: Whether or not the installation is supported on the host machine.kernelArch: The kernel architecture of the customer’s machine.kernelVersion: The kernel version of the customer’s machine.logFilePath: The path to the log file on the customer’s host.os: The OS of the customer’s machine.platform: The platform name provided by the open-install-library.platformFamily: The platform family name provided by the open-install-library.platformVersion: The platform version provided by the open-install-library.redirectUrl: A URL generated by the newrelic-cli that redirects to the appropriate entity once an installation is complete.state: The state of the installation.targetedInstall: Whether or not the installation is a targeted install.timestamp: The timestamp for when the install event occurred.
class InstallationInstallStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"cli_version",
"deployed_by",
"enabled_proxy",
"error",
"host_name",
"install_id",
"install_library_version",
"is_unsupported",
"kernel_arch",
"kernel_version",
"log_file_path",
"os",
"platform",
"platform_family",
"platform_version",
"redirect_url",
"state",
"targeted_install",
"timestamp",
)
cli_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="cliVersion"
)
deployed_by = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="deployedBy"
)
enabled_proxy = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="enabledProxy"
)
error = sgqlc.types.Field(
sgqlc.types.non_null("InstallationStatusError"), graphql_name="error"
)
host_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="hostName")
install_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="installId")
install_library_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="installLibraryVersion"
)
is_unsupported = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isUnsupported"
)
kernel_arch = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="kernelArch"
)
kernel_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="kernelVersion"
)
log_file_path = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="logFilePath"
)
os = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="os")
platform = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="platform")
platform_family = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="platformFamily"
)
platform_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="platformVersion"
)
redirect_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="redirectUrl"
)
state = sgqlc.types.Field(
sgqlc.types.non_null(InstallationInstallStateType), graphql_name="state"
)
targeted_install = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="targetedInstall"
)
timestamp = sgqlc.types.Field(EpochSeconds, graphql_name="timestamp")670. InstallationInstallStatusResult¶
A wrapper object that contains paginated install statuses along with counts and a pagination cursor
Available fields:
cursor: Cursor for fetching next page of results. Results are ordered by descending timestamp (most recent first)installStatuses: List of InstallStatus objectstotalCount: Total number of InstallStatus results across all pages for a given query
class InstallationInstallStatusResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("cursor", "install_statuses", "total_count")
cursor = sgqlc.types.Field(String, graphql_name="cursor")
install_statuses = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(InstallationInstallStatus)),
graphql_name="installStatuses",
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")671. InstallationRecipeEvent¶
An object that contains an installation event created from within the newrelic-cli.
Available fields:
cliVersion: The version of the newrelic-cli that was used for a given recipe.complete: Whether or not the recipe has been installed and all steps have been completed.displayName: The display name for a given recipe.entityGuid: The entity Guid for a given recipe.error: The error returned for a given recipe.hostName: The host name of the customer’s machine.installId: The unique ID that corresponds to an install event.installLibraryVersion: The version of the open-install-library that is being used.kernelArch: The kernel architecture of the customer’s machine.kernelVersion: The kernel version of the customer’s machine.logFilePath: The path to the log file on the customer’s host.metadata: Additional key:value data related to the environment where the installation occurred.name: The unique name for a given recipe.os: The OS of the customer’s machine.platform: The platform name provided by the open-install-library.platformFamily: The platform family name provided by the open-install-library.platformVersion: The platform version provided by the open-install-library.redirectUrl: The redirect URL created by the CLI used for redirecting to a particular entity.status: The status for a given recipe.targetedInstall: Whether or not the recipe being installed is a targeted install.taskPath: The path to the installation task as defined in the open-install-library.timestamp: The timestamp for when the recipe event occurred.validationDurationMilliseconds: The number of milliseconds it took to validate the recipe.
class InstallationRecipeEvent(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"cli_version",
"complete",
"display_name",
"entity_guid",
"error",
"host_name",
"install_id",
"install_library_version",
"kernel_arch",
"kernel_version",
"log_file_path",
"metadata",
"name",
"os",
"platform",
"platform_family",
"platform_version",
"redirect_url",
"status",
"targeted_install",
"task_path",
"timestamp",
"validation_duration_milliseconds",
)
cli_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="cliVersion"
)
complete = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="complete")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
error = sgqlc.types.Field(
sgqlc.types.non_null("InstallationStatusError"), graphql_name="error"
)
host_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="hostName")
install_id = sgqlc.types.Field(ID, graphql_name="installId")
install_library_version = sgqlc.types.Field(
SemVer, graphql_name="installLibraryVersion"
)
kernel_arch = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="kernelArch"
)
kernel_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="kernelVersion"
)
log_file_path = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="logFilePath"
)
metadata = sgqlc.types.Field(InstallationRawMetadata, graphql_name="metadata")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
os = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="os")
platform = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="platform")
platform_family = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="platformFamily"
)
platform_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="platformVersion"
)
redirect_url = sgqlc.types.Field(String, graphql_name="redirectUrl")
status = sgqlc.types.Field(
sgqlc.types.non_null(InstallationRecipeStatusType), graphql_name="status"
)
targeted_install = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="targetedInstall"
)
task_path = sgqlc.types.Field(String, graphql_name="taskPath")
timestamp = sgqlc.types.Field(
sgqlc.types.non_null(EpochSeconds), graphql_name="timestamp"
)
validation_duration_milliseconds = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="validationDurationMilliseconds",
)672. InstallationRecipeEventResult¶
A wrapper object that contains paginated recipe events along with counts and a pagination cursor
Available fields:
cursor: Cursor for fetching next page of results. Results are ordered by descending timestamp (most recent first)recipeEvents: List of RecipeEvent objectstotalCount: Total number of RecipeEvent results across all pages for a given query
class InstallationRecipeEventResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("cursor", "recipe_events", "total_count")
cursor = sgqlc.types.Field(String, graphql_name="cursor")
recipe_events = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(InstallationRecipeEvent)),
graphql_name="recipeEvents",
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")673. InstallationStatusError¶
An object that represents a status error whenever an recipe has failed to install.
Available fields:
details: Error details, if any.message: The actual error message.optimizedMessage: An optimised message for the error.
class InstallationStatusError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("details", "message", "optimized_message")
details = sgqlc.types.Field(String, graphql_name="details")
message = sgqlc.types.Field(String, graphql_name="message")
optimized_message = sgqlc.types.Field(String, graphql_name="optimizedMessage")674. IntegrationServicesCapabilitySettings¶
Defines the input for updating a capability setting of a ServiceNow entity.
Available fields:
capability: Name of the capability to update.
class IntegrationServicesCapabilitySettings(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("capability",)
capability = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="capability"
)675. IntegrationServicesInstallationResponse¶
Defines the response type for ServiceNow installation mutation.
Available fields:
capabilitySettings: List of Capability Settings for the updated ServiceNow entity.clientId: Client ID associated with the created ServiceNow entity.guid: GUID of the created ServiceNow entity.instanceName: Instance name of the created ServiceNow entity.type: Type of the created ServiceNow entity.
class IntegrationServicesInstallationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"capability_settings",
"client_id",
"guid",
"instance_name",
"type",
)
capability_settings = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(IntegrationServicesCapabilitySettings)
),
graphql_name="capabilitySettings",
)
client_id = sgqlc.types.Field(String, graphql_name="clientId")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
instance_name = sgqlc.types.Field(String, graphql_name="instanceName")
type = sgqlc.types.Field(String, graphql_name="type")676. IntegrationServicesTag¶
An entity tag.
Available fields:
key: The key or name of the tag.values: The list of values of the tag.
class IntegrationServicesTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)677. IntegrationServicesUpdateResponse¶
Defines the response returned after updating a ServiceNow entity.
Available fields:
capabilitySettings: List of Capability Settings for the updated ServiceNow entity.enabled: Flag indicating if the ServiceNow entity is enabled.guid: GUID of the updated ServiceNow entity.instanceName: Instance name of the updated ServiceNow entity.lastSyncAt: Last sync time of the updated ServiceNow entity in epoch milliseconds.serviceNowConnectionId: Connection ID of the updated ServiceNow entity.tags: List of tags to associate with the ServiceNow entity.
class IntegrationServicesUpdateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"capability_settings",
"enabled",
"guid",
"instance_name",
"last_sync_at",
"service_now_connection_id",
"tags",
)
capability_settings = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(IntegrationServicesCapabilitySettings)
),
graphql_name="capabilitySettings",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
instance_name = sgqlc.types.Field(String, graphql_name="instanceName")
last_sync_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastSyncAt")
service_now_connection_id = sgqlc.types.Field(
String, graphql_name="serviceNowConnectionId"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(IntegrationServicesTag)),
graphql_name="tags",
)678. JavaFlightRecorderFlamegraph¶
The flamegraph built from the strack trace samples
Available fields:
allFrames: List of stack frames for the flamegraph
class JavaFlightRecorderFlamegraph(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("all_frames",)
all_frames = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("JavaFlightRecorderStackFrame")),
graphql_name="allFrames",
)679. JavaFlightRecorderStackFrame¶
A method within the flamegraph
Available fields:
count: The number of stack traces that this frame is inid: This stackframe’s idname: The stackframe’s class and method nameparentId: This stackframe’s parent id
class JavaFlightRecorderStackFrame(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "id", "name", "parent_id")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
parent_id = sgqlc.types.Field(ID, graphql_name="parentId")680. KeyTransactionApplication¶
The application wrapper.
Available fields:
entity: The application outline.guid: The guid of the application.
class KeyTransactionApplication(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entity", "guid")
entity = sgqlc.types.Field(EntityOutline, graphql_name="entity")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")681. KeyTransactionCreateResult¶
The result of creating a key transaction.
Available fields:
apdexTarget: The acceptable amount of time spent in the backend before customers get frustrated (Apdex target).application: The application associated with this key transactionbrowserApdexTarget: The acceptable amount of time for rendering a page in a browser before customers get frustrated (browser Apdex target).guid: The GUID for the new key transaction.metricName: The name of the metric underlying this key transaction.name: The name of the key transaction.
class KeyTransactionCreateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"apdex_target",
"application",
"browser_apdex_target",
"guid",
"metric_name",
"name",
)
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")
application = sgqlc.types.Field(
sgqlc.types.non_null(KeyTransactionApplication), graphql_name="application"
)
browser_apdex_target = sgqlc.types.Field(Float, graphql_name="browserApdexTarget")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
metric_name = sgqlc.types.Field(String, graphql_name="metricName")
name = sgqlc.types.Field(String, graphql_name="name")682. KeyTransactionDeleteResult¶
The result of deleting a key transaction.
Available fields:
success: If the delete request succeeded.
class KeyTransactionDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("success",)
success = sgqlc.types.Field(Boolean, graphql_name="success")683. KeyTransactionUpdateResult¶
The result of updating a key transaction.
Available fields:
apdexTarget: The acceptable amount of time spent in the backend before customers get frustrated (Apdex target).application: The application associated with this key transactionbrowserApdexTarget: The acceptable amount of time for rendering a page in a browser before customers get frustrated (browser Apdex target).name: The name of the key transaction.
class KeyTransactionUpdateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("apdex_target", "application", "browser_apdex_target", "name")
apdex_target = sgqlc.types.Field(Float, graphql_name="apdexTarget")
application = sgqlc.types.Field(
sgqlc.types.non_null(KeyTransactionApplication), graphql_name="application"
)
browser_apdex_target = sgqlc.types.Field(Float, graphql_name="browserApdexTarget")
name = sgqlc.types.Field(String, graphql_name="name")684. KnowledgeDocsStitchedFields¶
Available fields:
search: Search for documentstags: Retrieve available tag data
class KnowledgeDocsStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("search", "tags")
search = sgqlc.types.Field(
"KnowledgeSearchResponse",
graphql_name="search",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"search_string",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="searchString",
default=None,
),
),
(
"since",
sgqlc.types.Arg(DateTime, graphql_name="since", default=None),
),
(
"sort",
sgqlc.types.Arg(
KnowledgeSearchSortOption, graphql_name="sort", default=None
),
),
(
"source",
sgqlc.types.Arg(
sgqlc.types.non_null(KnowledgeSearchSources),
graphql_name="source",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="tags",
default=None,
),
),
(
"until",
sgqlc.types.Arg(DateTime, graphql_name="until", default=None),
),
)
),
)
"""Arguments:
* `cursor` (`String`): The value to access the next page of search
results
* `search_string` (`String!`): The search string
* `since` (`DateTime`): Defines the beginning of a time range to
use for the results
* `sort` (`KnowledgeSearchSortOption`): The sorting option to use
on the results
* `source` (`KnowledgeSearchSources!`): The source of the
knowledge
* `tags` (`[String!]`): The tags to use to filter the results
* `until` (`DateTime`): Defines the end of a time range to use for
the results
"""
tags = sgqlc.types.Field(
"KnowledgeTagsResponse",
graphql_name="tags",
args=sgqlc.types.ArgDict(
(
(
"source",
sgqlc.types.Arg(
sgqlc.types.non_null(KnowledgeSearchSources),
graphql_name="source",
default=None,
),
),
)
),
)
"""Arguments:
* `source` (`KnowledgeSearchSources!`): The source of the
knowledge
"""685. KnowledgeSearchResponse¶
A paginated list of search results
Available fields:
id: The ID of the searchnextCursor: The value to use to get the next page of search resultsoverviewId: The ID of the overviewprevCursor: The value to use to get the previous page of search resultsresults: List of search resultstotalCount: The total count of search results
class KnowledgeSearchResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"id",
"next_cursor",
"overview_id",
"prev_cursor",
"results",
"total_count",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
overview_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="overviewId")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("KnowledgeSearchResult"))
),
graphql_name="results",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)686. KnowledgeSearchResult¶
Search Result
Available fields:
bodyText: Search Result bodycreatedDate: The date the content was createdid: Search Result IDlastModifiedDate: The date the content was last modifiedpublishStatus: The publication status of the resultresultsTotal: Search Result result countscore: Search Result scoresourceLabel: Search Result source labelsummary: Search Result summarytags: Search Result tagstitle: Search result titleurl: Search result url
class KnowledgeSearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"body_text",
"created_date",
"id",
"last_modified_date",
"publish_status",
"results_total",
"score",
"source_label",
"summary",
"tags",
"title",
"url",
)
body_text = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="bodyText")
created_date = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdDate"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
last_modified_date = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="lastModifiedDate"
)
publish_status = sgqlc.types.Field(
sgqlc.types.non_null(KnowledgePublishStatus), graphql_name="publishStatus"
)
results_total = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="resultsTotal"
)
score = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="score")
source_label = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="sourceLabel"
)
summary = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="summary")
tags = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="tags",
)
title = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="title")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")687. KnowledgeTag¶
Search Tag
Available fields:
count: Count of content using the tagid: Tag IDlabel: Tag label
class KnowledgeTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "id", "label")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
label = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="label")688. KnowledgeTagsResponse¶
A list of available tags to use for filtering search results
Available fields:
id: The ID of the requesttags: List of tags
class KnowledgeTagsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "tags")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
tags = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(KnowledgeTag))),
graphql_name="tags",
)689. LogConfigurationsAccountStitchedFields¶
Available fields:
dataPartitionRules: Look up for all data partition rules for a given account.liveArchiveConfigurations: Look up for all Live Archive configurations for a given account.obfuscationExpressions: Look up for all obfuscation expressions for a given accountobfuscationRules: Look up for all obfuscation rules for a given account.parsingRules: Look up for all parsing rules for a given account.pipelineConfiguration: Look up pipeline configuration for a given account.testGrok: Test a Grok pattern against a list of log lines.
class LogConfigurationsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"data_partition_rules",
"live_archive_configurations",
"obfuscation_expressions",
"obfuscation_rules",
"parsing_rules",
"pipeline_configuration",
"test_grok",
)
data_partition_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("LogConfigurationsDataPartitionRule")),
graphql_name="dataPartitionRules",
)
live_archive_configurations = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("LogConfigurationsLiveArchiveConfiguration")
),
graphql_name="liveArchiveConfigurations",
)
obfuscation_expressions = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null("LogConfigurationsObfuscationExpression")
),
graphql_name="obfuscationExpressions",
)
obfuscation_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("LogConfigurationsObfuscationRule")),
graphql_name="obfuscationRules",
)
parsing_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("LogConfigurationsParsingRule")),
graphql_name="parsingRules",
)
pipeline_configuration = sgqlc.types.Field(
"LogConfigurationsPipelineConfiguration", graphql_name="pipelineConfiguration"
)
test_grok = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("LogConfigurationsGrokTestResult")),
graphql_name="testGrok",
args=sgqlc.types.ArgDict(
(
(
"grok",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="grok", default=None
),
),
(
"log_lines",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(String))
),
graphql_name="logLines",
default=None,
),
),
)
),
)
"""Arguments:
* `grok` (`String!`): The Grok pattern to test.
* `log_lines` (`[String!]!`): The log lines to test the Grok
pattern against.
"""690. LogConfigurationsCreateDataPartitionRuleError¶
Expected errors as a result of creating a new data partition rule.
Available fields:
message: The message with the error cause.type: Type of error.
class LogConfigurationsCreateDataPartitionRuleError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
LogConfigurationsCreateDataPartitionRuleErrorType, graphql_name="type"
)691. LogConfigurationsCreateDataPartitionRuleResponse¶
The result after creating a new data partition rule.
Available fields:
errors: List of errors, if any.rule: The created data partition rule.
class LogConfigurationsCreateDataPartitionRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of(LogConfigurationsCreateDataPartitionRuleError),
graphql_name="errors",
)
rule = sgqlc.types.Field("LogConfigurationsDataPartitionRule", graphql_name="rule")692. LogConfigurationsCreateParsingRuleResponse¶
The result after creating a new parsing rule.
Available fields:
errors: List of errors, if any.rule: The created parsing rule.
class LogConfigurationsCreateParsingRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of("LogConfigurationsParsingRuleMutationError"),
graphql_name="errors",
)
rule = sgqlc.types.Field("LogConfigurationsParsingRule", graphql_name="rule")693. LogConfigurationsDataPartitionRule¶
The data partition rule for an account.
Available fields:
createdAt: Identifies the date and time when the rule was created.createdBy: Identifies the user who has created the rule.deleted: Whether or not this data partition rule is deleted. Deleting a data partition rule does not delete the already persisted data. This data will be retained for a given period of time specified in the retention policy field.description: A description of what this data partition rule represents.enabled: Whether or not this data partition rule is enabled.id: Unique data partition rule identifier.nrql: The NRQL to match events for this data partition rule. Logs matching this criteria will be routed to the specified data partition once the rule is enabled.retentionPolicy: The retention policy of the data partition data.targetDataPartition: The name of the data partition.updatedAt: Identifies the date and time when the rule was last updated.updatedBy: Identifies the user who has last updated the rule.
class LogConfigurationsDataPartitionRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"deleted",
"description",
"enabled",
"id",
"nrql",
"retention_policy",
"target_data_partition",
"updated_at",
"updated_by",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
deleted = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="deleted")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
retention_policy = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsDataPartitionRuleRetentionPolicyType),
graphql_name="retentionPolicy",
)
target_data_partition = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsLogDataPartitionName),
graphql_name="targetDataPartition",
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")694. LogConfigurationsDataPartitionRuleMatchingCriteria¶
The data partition rule matching criteria.
Available fields:
attributeName: The attribute name against which this matching condition will be evaluated.matchingExpression: The matching expression of the data partition rule definition.matchingOperator: The matching method of the data partition rule definition.
class LogConfigurationsDataPartitionRuleMatchingCriteria(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute_name", "matching_expression", "matching_operator")
attribute_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attributeName"
)
matching_expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="matchingExpression"
)
matching_operator = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsDataPartitionRuleMatchingOperator),
graphql_name="matchingOperator",
)695. LogConfigurationsDataPartitionRuleMutationError¶
An object that contains expected errors as a result of mutating an existing data partition rule.
Available fields:
message: The message with the error cause.type: Type of error.
class LogConfigurationsDataPartitionRuleMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
LogConfigurationsDataPartitionRuleMutationErrorType, graphql_name="type"
)696. LogConfigurationsDeleteDataPartitionRuleResponse¶
The result after deleting a data partition rule.
Available fields:
errors: List of errors, if any.
class LogConfigurationsDeleteDataPartitionRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(LogConfigurationsDataPartitionRuleMutationError),
graphql_name="errors",
)697. LogConfigurationsDeleteParsingRuleResponse¶
The result after deleting a parsing rule.
Available fields:
errors: List of errors, if any.
class LogConfigurationsDeleteParsingRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of("LogConfigurationsParsingRuleMutationError"),
graphql_name="errors",
)698. LogConfigurationsGrokTestExtractedAttribute¶
An attribute that was extracted from a Grok test.
Available fields:
name: The attribute name.value: A string representation of the extracted value (which might not be a String).
class LogConfigurationsGrokTestExtractedAttribute(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")699. LogConfigurationsGrokTestResult¶
The result of testing Grok on a log line.
Available fields:
attributes: Any attributes that were extracted.logLine: The log line that was tested against.matched: Whether the Grok pattern matched.
class LogConfigurationsGrokTestResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "log_line", "matched")
attributes = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(LogConfigurationsGrokTestExtractedAttribute)
),
graphql_name="attributes",
)
log_line = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="logLine")
matched = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="matched")700. LogConfigurationsLiveArchiveConfiguration¶
Live Archive configuration for an event type.
Available fields:
accountId: Account IdcreatedAt: Identifies the date and time when the configuration was created.createdBy: Identifies the user who has created the configuration.enabled: Indicates if the Live Archive configuration is enabledeventType: EventType name that will be configured.id: Configuration IdretentionPolicy: Retention policy for the EventType.updatedAt: Identifies the date and time when the configuration was last updated.updatedBy: Identifies the user who has last updated the configuration.
class LogConfigurationsLiveArchiveConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"created_by",
"enabled",
"event_type",
"id",
"retention_policy",
"updated_at",
"updated_by",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
event_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="eventType"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
retention_policy = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsLiveArchiveRetentionPolicyType),
graphql_name="retentionPolicy",
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")701. LogConfigurationsObfuscationAction¶
Application of an obfuscation expression with specific a replacement method.
Available fields:
attributes: Log record attributes to apply this expression to. An empty list applies the action to all the attributes.expression: Obfuscation expression applied by this action.id: The id of the obfuscation action.method: How to obfuscate matches for the applied expression.
class LogConfigurationsObfuscationAction(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "expression", "id", "method")
attributes = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="attributes",
)
expression = sgqlc.types.Field(
sgqlc.types.non_null("LogConfigurationsObfuscationExpression"),
graphql_name="expression",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
method = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsObfuscationMethod), graphql_name="method"
)702. LogConfigurationsObfuscationExpression¶
Reusable obfuscation expression.
Available fields:
createdAt: Identifies the date and time when the expression was created.createdBy: Identifies the user who has created the expression.description: Description of the expression.id: The id of the obfuscation expression.name: Name of the expression.regex: Regular expression for this obfuscation expression. Capture groups will be obscured on matching.updatedAt: Identifies the date and time when the expression was last updated.updatedBy: Identifies the user who has last updated the expression.
class LogConfigurationsObfuscationExpression(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"description",
"id",
"name",
"regex",
"updated_at",
"updated_by",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
regex = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="regex")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")703. LogConfigurationsObfuscationRule¶
Rule for identifying a set of log data to apply specific obfuscation actions to.
Available fields:
actions: Obfuscation actions to take if a record passes the matching criteria.createdAt: Identifies the date and time when the rule was created.createdBy: Identifies the user who has created the rule.description: Description of the obfuscation rule.enabled: Whether the rule should be applied to incoming logsfilter: NRQL filter to determine if a log record should have obfuscation actions applied.id: The id of the obfuscation rule.name: Name of the obfuscation rule.updatedAt: Identifies the date and time when the rule was last updated.updatedBy: Identifies the user who has last updated the rule.
class LogConfigurationsObfuscationRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"actions",
"created_at",
"created_by",
"description",
"enabled",
"filter",
"id",
"name",
"updated_at",
"updated_by",
)
actions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(LogConfigurationsObfuscationAction)),
graphql_name="actions",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
filter = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="filter")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")704. LogConfigurationsParsingRule¶
A parsing rule for an account.
Available fields:
accountId: The account id associated with the rule.attribute: The parsing rule will apply to value of this attribute.createdBy: Identifies the user who has created the rule.deleted: Whether or not this rule is deleted.description: A description of what this parsing rule represents.enabled: Whether or not this rule is enabled.grok: The Grok of what to parse.id: Unique parsing rule identifier.lucene: The Lucene to match events to the parsing rule.nrql: The NRQL to match events to the parsing rule.source: Source of the parsing rule.updatedAt: Identifies the date and time when the rule was last updated.updatedBy: Identifies the user who has last updated the rule.
class LogConfigurationsParsingRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"attribute",
"created_by",
"deleted",
"description",
"enabled",
"grok",
"id",
"lucene",
"nrql",
"source",
"updated_at",
"updated_by",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
attribute = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="attribute"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
deleted = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="deleted")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
grok = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="grok")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
lucene = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="lucene")
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")
source = sgqlc.types.Field(
sgqlc.types.non_null(LogConfigurationsParsingRuleSource), graphql_name="source"
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")705. LogConfigurationsParsingRuleMutationError¶
Expected errors as a result of mutating a parsing rule.
Available fields:
message: The message with the error cause.type: Type of error.
class LogConfigurationsParsingRuleMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
LogConfigurationsParsingRuleMutationErrorType, graphql_name="type"
)706. LogConfigurationsPipelineConfiguration¶
The pipeline configuration for an account, with metadata.
Available fields:
accountId: The account id.accountLevelNativeJsonEnabled: Whether or not account-level native JSON is enabled."enrichmentDisabled: Whether or not enrichment is disabled.jsonParsingDisabled: Whether or not JSON parsing is disabled.obfuscationDisabled: Whether or not obfuscation is disabled.parsingDisabled: Whether or not parsing is disabled.patternsEnabled: Whether or not patterns are enabled.pluginAttributesCleanupEnabled: Whether or not plugin.* attributes should be dropped.recursiveJsonParsingDisabled: Whether or not recursive JSON parsing is disabled.transformationDisabled: Whether or not transformation is disabled.updatedAt: Identifies the date and time when the configuration was last updated, or null if this has never been changed from the defaults.updatedBy: Identifies the user who has updated the configuration, or null if this has never been changed from the defaults.
class LogConfigurationsPipelineConfiguration(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"account_level_native_json_enabled",
"enrichment_disabled",
"json_parsing_disabled",
"obfuscation_disabled",
"parsing_disabled",
"patterns_enabled",
"plugin_attributes_cleanup_enabled",
"recursive_json_parsing_disabled",
"transformation_disabled",
"updated_at",
"updated_by",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
account_level_native_json_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="accountLevelNativeJsonEnabled"
)
enrichment_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="enrichmentDisabled"
)
json_parsing_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="jsonParsingDisabled"
)
obfuscation_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="obfuscationDisabled"
)
parsing_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="parsingDisabled"
)
patterns_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="patternsEnabled"
)
plugin_attributes_cleanup_enabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="pluginAttributesCleanupEnabled"
)
recursive_json_parsing_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="recursiveJsonParsingDisabled"
)
transformation_disabled = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="transformationDisabled"
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")707. LogConfigurationsUpdateDataPartitionRuleResponse¶
An object that represents the result after updating a data partition rule.
Available fields:
errors: List of errors, if any.rule: The updated data partition rule.
class LogConfigurationsUpdateDataPartitionRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of(LogConfigurationsDataPartitionRuleMutationError),
graphql_name="errors",
)
rule = sgqlc.types.Field(LogConfigurationsDataPartitionRule, graphql_name="rule")708. LogConfigurationsUpdateParsingRuleResponse¶
The result after updating a parsing rule.
Available fields:
errors: List of errors, if any.rule: The updated parsing rule.
class LogConfigurationsUpdateParsingRuleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of(LogConfigurationsParsingRuleMutationError),
graphql_name="errors",
)
rule = sgqlc.types.Field(LogConfigurationsParsingRule, graphql_name="rule")709. LogConfigurationsUpsertPipelineConfigurationResponse¶
The result after upserting pipeline configuration for an account.
Available fields:
pipelineConfiguration: The updated pipeline configuration.
class LogConfigurationsUpsertPipelineConfigurationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("pipeline_configuration",)
pipeline_configuration = sgqlc.types.Field(
LogConfigurationsPipelineConfiguration, graphql_name="pipelineConfiguration"
)710. MachineLearningAccountStitchedFields¶
Available fields:
fileDataSourcesByIds: Get File Data Source By IDsfileDataSourcesByProjectId: Get File Data Source By Project IDprojects: Get all projectsprojectsByIds: Get projects by project idsstreamDataSourcesByIds: Get Stream Data Source By IDsstreamDataSourcesByProjectId: Get Stream Data Source By Project ID
class MachineLearningAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"file_data_sources_by_ids",
"file_data_sources_by_project_id",
"projects",
"projects_by_ids",
"stream_data_sources_by_ids",
"stream_data_sources_by_project_id",
)
file_data_sources_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("MachineLearningFileDataSource"),
graphql_name="fileDataSourcesByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of File Data Source IDs
"""
file_data_sources_by_project_id = sgqlc.types.Field(
"MachineLearningFileDataSourceConnection",
graphql_name="fileDataSourcesByProjectId",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"project_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="projectId", default=None
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination Cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `project_id` (`ID!`): Project ID
"""
projects = sgqlc.types.Field(
"MachineLearningProjectConnection",
graphql_name="projects",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
projects_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("MachineLearningProject"),
graphql_name="projectsByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of project IDs
"""
stream_data_sources_by_ids = sgqlc.types.Field(
sgqlc.types.list_of("MachineLearningStreamDataSource"),
graphql_name="streamDataSourcesByIds",
args=sgqlc.types.ArgDict(
(
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `ids` (`[ID]!`): Array of Stream Data Source IDs
"""
stream_data_sources_by_project_id = sgqlc.types.Field(
"MachineLearningStreamDataSourceConnection",
graphql_name="streamDataSourcesByProjectId",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
(
"project_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="projectId", default=None
),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page 'desc' - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
* `project_id` (`ID!`): Project ID
"""711. MachineLearningActorStitchedFields¶
Available fields:
ragQueryData: Get RAG data by given prompt query and tool id
class MachineLearningActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("rag_query_data",)
rag_query_data = sgqlc.types.Field(
sgqlc.types.list_of("MachineLearningRagQueryDataResponse"),
graphql_name="ragQueryData",
args=sgqlc.types.ArgDict(
(
(
"filter_by",
sgqlc.types.Arg(
sgqlc.types.list_of(MachineLearningFilterBy),
graphql_name="filterBy",
default=None,
),
),
(
"prompt",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="prompt",
default=None,
),
),
("tool_id", sgqlc.types.Arg(ID, graphql_name="toolId", default=None)),
("top_k", sgqlc.types.Arg(Int, graphql_name="topK", default=5)),
)
),
)
"""Arguments:
* `filter_by` (`[MachineLearningFilterBy]`): Filter object
* `prompt` (`String!`): Prompt to query data
* `tool_id` (`ID`): Associated tool ID
* `top_k` (`Int`): Number of results to return. Defaults to 5
(default: `5`)
"""712. MachineLearningExperiment¶
Experiment
Available fields:
id: Id of Experiment
class MachineLearningExperiment(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")713. MachineLearningExperimentConnection¶
Cursor pagination for experiments
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningExperimentConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningExperiment), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")714. MachineLearningFileDataSource¶
Metadata about a file data source
Available fields:
accountId: Account that owns thisblobId: ID of the Blob that containing the datacreatedAt: Time createdcreatorId: Creator of thisdeactivated: Active statusdescription: Description of the File Data Sourceexperiments: Experiments associated with this DatafileName: Name of the data fileid: ID of the File Data Sourcemodels: Models associated with this DatamodifiedAt: Time last modifiedname: Name of the File DataorganizationId: Organization that owns thisproject: Project associated with data sourceprojectId: ID of project associated with the filesourceUrl: Secure/signed source url for the raw File Data Sourcetags: Tags associated with this Dataversion: Version of the File Data Source
class MachineLearningFileDataSource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"blob_id",
"created_at",
"creator_id",
"deactivated",
"description",
"experiments",
"file_name",
"id",
"models",
"modified_at",
"name",
"organization_id",
"project",
"project_id",
"source_url",
"tags",
"version",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
blob_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="blobId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
deactivated = sgqlc.types.Field(Boolean, graphql_name="deactivated")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
experiments = sgqlc.types.Field(
MachineLearningExperimentConnection,
graphql_name="experiments",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page - desc - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
file_name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="fileName")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
models = sgqlc.types.Field(
"MachineLearningModelConnection",
graphql_name="models",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page - desc - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
project = sgqlc.types.Field(
"MachineLearningProject",
graphql_name="project",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
project_id = sgqlc.types.Field(ID, graphql_name="projectId")
source_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="sourceUrl"
)
tags = sgqlc.types.Field(
"MachineLearningTagConnection",
graphql_name="tags",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page - desc - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
version = sgqlc.types.Field(sgqlc.types.non_null(SemVer), graphql_name="version")715. MachineLearningFileDataSourceConnection¶
Cursor pagination for File Data Sources
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningFileDataSourceConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningFileDataSource), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")716. MachineLearningModel¶
Machine Learning Model
Available fields:
id: Id of Model
class MachineLearningModel(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")717. MachineLearningModelConnection¶
Cursor pagination for Models
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningModelConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningModel), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")718. MachineLearningProject¶
Machine Learning Project
Available fields:
accountId: Account that owns thiscreatedAt: Time createdcreatorId: Creator of thisdescription: Description of the Projectid: Id of projectmodifiedAt: Time last modifiedname: Name of the ProjectorganizationId: Organization that owns thisstatus: Status of the project
class MachineLearningProject(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"creator_id",
"description",
"id",
"modified_at",
"name",
"organization_id",
"status",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")719. MachineLearningProjectConnection¶
Cursor pagination for Project
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningProjectConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningProject), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")720. MachineLearningRagQueryDataResponse¶
Object for RAG query data results
Available fields:
blobId: Identifier for the data blobchunk: Result text matching query promptscore: Relevance score of the resulttoolId: Associated tool ID
class MachineLearningRagQueryDataResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("blob_id", "chunk", "score", "tool_id")
blob_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="blobId")
chunk = sgqlc.types.Field(String, graphql_name="chunk")
score = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="score")
tool_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="toolId")721. MachineLearningStreamDataSource¶
Metadata about a stream data source
Available fields:
accountId: Account that owns thiscreatedAt: Time createdcreatorId: Creator of thisdescription: Description of the Stream Data Sourcefilter: NRQL used to filter data to the topicid: ID of the Stream Data SourcelastWorkflowId: Last workflow ID associated with this Stream Data SourcemodifiedAt: Time last modifiedname: Name of the Stream Data SourceorganizationId: Organization that owns thisproject: Project associated with data sourcesamplingRate: Sampling rate - between 0 and 1status: The readiness status of the realtime topictags: Tags associated with this Datatopic: Topic of the real-time live data streamversion: Version of the Stream Data Source
class MachineLearningStreamDataSource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"created_at",
"creator_id",
"description",
"filter",
"id",
"last_workflow_id",
"modified_at",
"name",
"organization_id",
"project",
"sampling_rate",
"status",
"tags",
"topic",
"version",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
creator_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="creatorId")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
filter = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="filter")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
last_workflow_id = sgqlc.types.Field(ID, graphql_name="lastWorkflowId")
modified_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="modifiedAt"
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
project = sgqlc.types.Field(
MachineLearningProject,
graphql_name="project",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
sampling_rate = sgqlc.types.Field(Float, graphql_name="samplingRate")
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")
tags = sgqlc.types.Field(
"MachineLearningTagConnection",
graphql_name="tags",
args=sgqlc.types.ArgDict(
(
("first", sgqlc.types.Arg(Int, graphql_name="first", default=10)),
("last", sgqlc.types.Arg(Int, graphql_name="last", default=None)),
(
"next_cursor",
sgqlc.types.Arg(String, graphql_name="nextCursor", default=None),
),
(
"prev_cursor",
sgqlc.types.Arg(String, graphql_name="prevCursor", default=None),
),
)
),
)
"""Arguments:
* `first` (`Int`): How many per page - asc - max 50 (default:
`10`)
* `last` (`Int`): How many per page - desc - max 50
* `next_cursor` (`String`): Forward pagination cursor
* `prev_cursor` (`String`): Backwards pagination cursor
"""
topic = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="topic")
version = sgqlc.types.Field(sgqlc.types.non_null(SemVer), graphql_name="version")722. MachineLearningStreamDataSourceConnection¶
Cursor pagination for Stream Data Sources
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningStreamDataSourceConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningStreamDataSource), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")723. MachineLearningTag¶
The Tag
Available fields:
id: Id of tag
class MachineLearningTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")724. MachineLearningTagConnection¶
Cursor pagination for Tags
Available fields:
entities: Array of resultshasNextPage: Indicates whether or not there is a next pagehasPreviousPage: Indicates whether or not there is a previous pagenextCursor: Next cursor to paginate byprevCursor: Previous cursor to paginate bytotalCount: Total Count of results
class MachineLearningTagConnection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entities",
"has_next_page",
"has_previous_page",
"next_cursor",
"prev_cursor",
"total_count",
)
entities = sgqlc.types.Field(
sgqlc.types.list_of(MachineLearningTag), graphql_name="entities"
)
has_next_page = sgqlc.types.Field(Boolean, graphql_name="hasNextPage")
has_previous_page = sgqlc.types.Field(Boolean, graphql_name="hasPreviousPage")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
prev_cursor = sgqlc.types.Field(String, graphql_name="prevCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")725. MachineLearningTransactionResponse¶
Response structure for a transaction mutation.
Available fields:
transactionId: Unique identifier for the transaction.
class MachineLearningTransactionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("transaction_id",)
transaction_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="transactionId"
)726. MetricNormalizationAccountStitchedFields¶
Return type for queries given an account ID.
Available fields:
metricNormalizationRule: Retrieves a rule.metricNormalizationRules: Retrieves the rules for the account.
class MetricNormalizationAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("metric_normalization_rule", "metric_normalization_rules")
metric_normalization_rule = sgqlc.types.Field(
"MetricNormalizationRule",
graphql_name="metricNormalizationRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
metric_normalization_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("MetricNormalizationRule")),
graphql_name="metricNormalizationRules",
args=sgqlc.types.ArgDict(
(
(
"enabled",
sgqlc.types.Arg(Boolean, graphql_name="enabled", default=None),
),
)
),
)
"""Arguments:
* `enabled` (`Boolean`): Rule enabled
"""727. MetricNormalizationRule¶
An object that represents a metric rename rule.
Available fields:
action: Rule action.applicationGuid: Application GUIDapplicationName: Application NamecreatedAt: Date of rule creation.enabled: Is rule enabled?evalOrder: Rule evaluation orderid: Rule IdmatchExpression: Metric Match Expression.notes: Notes.replacement: Metric Replacement Expression.terminateChain: Whether it terminates the evaluation chain or not
class MetricNormalizationRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"action",
"application_guid",
"application_name",
"created_at",
"enabled",
"eval_order",
"id",
"match_expression",
"notes",
"replacement",
"terminate_chain",
)
action = sgqlc.types.Field(MetricNormalizationRuleAction, graphql_name="action")
application_guid = sgqlc.types.Field(EntityGuid, graphql_name="applicationGuid")
application_name = sgqlc.types.Field(String, graphql_name="applicationName")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
eval_order = sgqlc.types.Field(Int, graphql_name="evalOrder")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
match_expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="matchExpression"
)
notes = sgqlc.types.Field(String, graphql_name="notes")
replacement = sgqlc.types.Field(String, graphql_name="replacement")
terminate_chain = sgqlc.types.Field(Boolean, graphql_name="terminateChain")728. MetricNormalizationRuleMetricGroupingIssue¶
An object that represents a metric grouping issue.
Available fields:
deniedMetricsCount: Total number of received and denied new metrics.deniedMetricsRatePerMinute: Rate of received and denied new metrics per minute.metricNormalizationRuleId: Metric normalization rule idmitigated: Whether the issue is mitigated or still activemitigationRateThreshold: The new metrics rate threshold to consider the issue mitigated.mitigationRateWindowSize: The minute time window to calculate if the issue was mitigated.
class MetricNormalizationRuleMetricGroupingIssue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"denied_metrics_count",
"denied_metrics_rate_per_minute",
"metric_normalization_rule_id",
"mitigated",
"mitigation_rate_threshold",
"mitigation_rate_window_size",
)
denied_metrics_count = sgqlc.types.Field(Int, graphql_name="deniedMetricsCount")
denied_metrics_rate_per_minute = sgqlc.types.Field(
Float, graphql_name="deniedMetricsRatePerMinute"
)
metric_normalization_rule_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="metricNormalizationRuleId"
)
mitigated = sgqlc.types.Field(Boolean, graphql_name="mitigated")
mitigation_rate_threshold = sgqlc.types.Field(
Float, graphql_name="mitigationRateThreshold"
)
mitigation_rate_window_size = sgqlc.types.Field(
Int, graphql_name="mitigationRateWindowSize"
)729. MetricNormalizationRuleMutationError¶
Error for mutation results
Available fields:
message: Details of errortype: Type of error
class MetricNormalizationRuleMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(MetricNormalizationRuleErrorType, graphql_name="type")730. MetricNormalizationRuleMutationResponse¶
The result of a metric rename rule mutation
Available fields:
errors: An array containing errors, if any.rule: The created rule
class MetricNormalizationRuleMutationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "rule")
errors = sgqlc.types.Field(
sgqlc.types.list_of(MetricNormalizationRuleMutationError), graphql_name="errors"
)
rule = sgqlc.types.Field(MetricNormalizationRule, graphql_name="rule")731. MobileAppSummaryData¶
Mobile application summary data
Available fields:
appLaunchCount: The number of times the app has been launched.crashCount: The number of crashes.crashRate: Crash rate is percentage of crashes per sessions.httpErrorRate: Error rate is the percentage of http errors per successful requests.httpRequestCount: The number of http requests.httpRequestRate: The rate of http requests per minute.httpResponseTimeAverage: The average response time for all http calls.mobileSessionCount: The number of mobile sessions.networkFailureRate: Network failure rate is the percentage of network failures per successful requests.usersAffectedCount: The number of users affected by crashes.
class MobileAppSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"app_launch_count",
"crash_count",
"crash_rate",
"http_error_rate",
"http_request_count",
"http_request_rate",
"http_response_time_average",
"mobile_session_count",
"network_failure_rate",
"users_affected_count",
)
app_launch_count = sgqlc.types.Field(Int, graphql_name="appLaunchCount")
crash_count = sgqlc.types.Field(Int, graphql_name="crashCount")
crash_rate = sgqlc.types.Field(Float, graphql_name="crashRate")
http_error_rate = sgqlc.types.Field(Float, graphql_name="httpErrorRate")
http_request_count = sgqlc.types.Field(Int, graphql_name="httpRequestCount")
http_request_rate = sgqlc.types.Field(Float, graphql_name="httpRequestRate")
http_response_time_average = sgqlc.types.Field(
Seconds, graphql_name="httpResponseTimeAverage"
)
mobile_session_count = sgqlc.types.Field(Int, graphql_name="mobileSessionCount")
network_failure_rate = sgqlc.types.Field(Float, graphql_name="networkFailureRate")
users_affected_count = sgqlc.types.Field(Int, graphql_name="usersAffectedCount")732. MobilePushNotificationActorStitchedFields¶
Available fields:
devices: A list of mobile devices the user has registered for push notifications.
class MobilePushNotificationActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("devices",)
devices = sgqlc.types.Field(
sgqlc.types.list_of("MobilePushNotificationDevice"), graphql_name="devices"
)733. MobilePushNotificationDevice¶
Device info used for push notifications.
Available fields:
appVersion: The version of the app.deviceId: The uuid of the device.deviceName: The name of the device.operatingSystem: The OS this device is running (android/ios).userId: The id of the user this device belongs to.
class MobilePushNotificationDevice(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"app_version",
"device_id",
"device_name",
"operating_system",
"user_id",
)
app_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="appVersion"
)
device_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="deviceId")
device_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="deviceName"
)
operating_system = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="operatingSystem"
)
user_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="userId")734. MobilePushNotificationRemoveDeviceResult¶
Result from removing a device.
Available fields:
deviceId: The uuid of the device that was removed.message: The success or failure message from the attempted remove.
class MobilePushNotificationRemoveDeviceResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("device_id", "message")
device_id = sgqlc.types.Field(String, graphql_name="deviceId")
message = sgqlc.types.Field(String, graphql_name="message")735. MobilePushNotificationSendPushResult¶
Result from sending a test push notification.
Available fields:
message: The success or failure message from the attempted test push.
class MobilePushNotificationSendPushResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message",)
message = sgqlc.types.Field(String, graphql_name="message")736. MultiTenantAuthorizationGrant¶
A grant within the system
Available fields:
dataAccessPolicy: The data access policy associated to the grantgrantee: The grantee associated to the grantid: The id of the grantrole: The role associated to the grantscope: The scope associated to the grant
class MultiTenantAuthorizationGrant(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("data_access_policy", "grantee", "id", "role", "scope")
data_access_policy = sgqlc.types.Field(
"MultiTenantAuthorizationGrantDataAccessPolicy", graphql_name="dataAccessPolicy"
)
grantee = sgqlc.types.Field(
sgqlc.types.non_null("MultiTenantAuthorizationGrantee"), graphql_name="grantee"
)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
role = sgqlc.types.Field(
sgqlc.types.non_null("MultiTenantAuthorizationGrantRole"), graphql_name="role"
)
scope = sgqlc.types.Field(
sgqlc.types.non_null("MultiTenantAuthorizationGrantScope"), graphql_name="scope"
)737. MultiTenantAuthorizationGrantCollection¶
A list of grants
Available fields:
items: List of grantsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class MultiTenantAuthorizationGrantCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantAuthorizationGrant))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)738. MultiTenantAuthorizationGrantDataAccessPolicy¶
The data access policy associated to the grant
Available fields:
id: The id of the data access policyname: The name of the data access policy
class MultiTenantAuthorizationGrantDataAccessPolicy(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(ID, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")739. MultiTenantAuthorizationGrantGroup¶
The group associated to the grant
Available fields:
id: The id of the group. If the grant is not to a group, this will be an empty string.
class MultiTenantAuthorizationGrantGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")740. MultiTenantAuthorizationGrantRole¶
The role associated to the grant
Available fields:
id: The id of the rolename: The name of the role
class MultiTenantAuthorizationGrantRole(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")741. MultiTenantAuthorizationGrantScope¶
The scope associated to the grant
Available fields:
id: The id of the resource in scopetype: The type of the resource in scopetypev2: The type of the resource in scope
class MultiTenantAuthorizationGrantScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type", "typev2")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(MultiTenantAuthorizationGrantScopeEnum),
graphql_name="type",
)
typev2 = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="typev2")742. MultiTenantAuthorizationGrantee¶
The Grantee of the grant
Available fields:
id: The id of the granteetype: the type of the grantee
class MultiTenantAuthorizationGrantee(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(MultiTenantAuthorizationGranteeTypeEnum),
graphql_name="type",
)743. MultiTenantAuthorizationPermission¶
An allowed action
Available fields:
category: The kind of accessfeature: The feature the permission controls access tofeatureDescription: The description of the feature the permission controls has access tofeatureDocumentationPath: The documentation path of the feature the permission controls access toid: a value that uniquely identifies this objectname: Name of the permission if category is OTHERproduct: The product the permission controls access to
class MultiTenantAuthorizationPermission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"category",
"feature",
"feature_description",
"feature_documentation_path",
"id",
"name",
"product",
)
category = sgqlc.types.Field(
MultiTenantAuthorizationPermissionCategoryEnum, graphql_name="category"
)
feature = sgqlc.types.Field(String, graphql_name="feature")
feature_description = sgqlc.types.Field(String, graphql_name="featureDescription")
feature_documentation_path = sgqlc.types.Field(
String, graphql_name="featureDocumentationPath"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
product = sgqlc.types.Field(String, graphql_name="product")744. MultiTenantAuthorizationPermissionCollection¶
A collection of permissions
Available fields:
items: collection of permissionsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class MultiTenantAuthorizationPermissionCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(MultiTenantAuthorizationPermission)
)
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")745. MultiTenantAuthorizationRole¶
Describes a role within the system
Available fields:
id: a value that uniquely identifies this objectname: the name of the objectscope: The scope the role applies totype: The type of role
class MultiTenantAuthorizationRole(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name", "scope", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="scope")
type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="type")746. MultiTenantAuthorizationRoleCollection¶
An iterable collection of roles
Available fields:
items: collection of rolesnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class MultiTenantAuthorizationRoleCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantAuthorizationRole))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)747. MultiTenantIdentityGroup¶
For users on our New Relic One user model, a “group” represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.
Available fields:
authenticationDomainId: The authentication domain the group belongs toid: a value that uniquely identifies this objectname: the name of the objectusers: Active users belonging to a group
class MultiTenantIdentityGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domain_id", "id", "name", "users")
authentication_domain_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="authenticationDomainId"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
users = sgqlc.types.Field(
"MultiTenantIdentityGroupUsers",
graphql_name="users",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
MultiTenantIdentityGroupUserFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`MultiTenantIdentityGroupUserFilterInput`): Filter
group users
"""748. MultiTenantIdentityGroupCollection¶
List of groups representing named sets of New Relic users within an authentication domain
Available fields:
items: groupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class MultiTenantIdentityGroupCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantIdentityGroup))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)749. MultiTenantIdentityGroupUser¶
Active user within group
Available fields:
email: The email of the user.id: a value that uniquely identifies this objectname: The full name of the user.timeZone: The configured time zone of the user.
class MultiTenantIdentityGroupUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "id", "name", "time_zone")
email = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="email")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
time_zone = sgqlc.types.Field(String, graphql_name="timeZone")750. MultiTenantIdentityGroupUsers¶
List of active users belonging to a group
Available fields:
items: Active users within groupnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class MultiTenantIdentityGroupUsers(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantIdentityGroupUser))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)751. MultiTenantIdentityPendingUpgradeRequest¶
Exists only if a user has a pending upgrade request.
Available fields:
id: a value that uniquely identifies this objectmessage: Requester message, why the user believes they require the upgrade.requestedUserType: Requested user type for the user.
class MultiTenantIdentityPendingUpgradeRequest(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "message", "requested_user_type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
message = sgqlc.types.Field(String, graphql_name="message")
requested_user_type = sgqlc.types.Field(
"MultiTenantIdentityUserType", graphql_name="requestedUserType"
)752. MultiTenantIdentityUser¶
A New Relic user
Available fields:
authenticationDomainId: The authentication domain the user belongs to.email: Email address of the user.emailVerificationState: One of: “Not Verifiable”, “Verified”, and “Pending”.
Not Verifiable: the user’s email does not require verification.
Verified: the user’s email requires verification and has been.
Pending: the user’s email requires verification and has not been.
groups: container for groups enabling cursor based paginationid: The user id.lastActive: The last active date of the user.name: The full name of the user.pendingUpgradeRequest: The pending upgrade request for the user (if any).timeZone: Time zone of the user in IANA Time Zone database format, also known as the “Olson” time zone database format (for exmaple, “America/Los_Angeles”).type: A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
class MultiTenantIdentityUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authentication_domain_id",
"email",
"email_verification_state",
"groups",
"id",
"last_active",
"name",
"pending_upgrade_request",
"time_zone",
"type",
)
authentication_domain_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="authenticationDomainId"
)
email = sgqlc.types.Field(String, graphql_name="email")
email_verification_state = sgqlc.types.Field(
sgqlc.types.non_null(MultiTenantIdentityEmailVerificationState),
graphql_name="emailVerificationState",
)
groups = sgqlc.types.Field(
"MultiTenantIdentityUserGroups",
graphql_name="groups",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
"""
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
last_active = sgqlc.types.Field(DateTime, graphql_name="lastActive")
name = sgqlc.types.Field(String, graphql_name="name")
pending_upgrade_request = sgqlc.types.Field(
MultiTenantIdentityPendingUpgradeRequest, graphql_name="pendingUpgradeRequest"
)
time_zone = sgqlc.types.Field(String, graphql_name="timeZone")
type = sgqlc.types.Field(
sgqlc.types.non_null("MultiTenantIdentityUserType"), graphql_name="type"
)753. MultiTenantIdentityUserCollection¶
A collection of New Relic users
Available fields:
items: UsersnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of users found. Note: Not necessarily the same as number of users returned, due to pagination.
class MultiTenantIdentityUserCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantIdentityUser))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)754. MultiTenantIdentityUserGroup¶
A group of users.
Available fields:
id: a value that uniquely identifies this objectname: the name of the object
class MultiTenantIdentityUserGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")755. MultiTenantIdentityUserGroups¶
List of groups representing named sets of New Relic users within an authentication domain
Available fields:
items: User groupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class MultiTenantIdentityUserGroups(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(MultiTenantIdentityUserGroup))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)756. MultiTenantIdentityUserType¶
A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
Available fields:
id: The id of the user type.name: The name of the user type.
class MultiTenantIdentityUserType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")757. NerdStorageAccountScope¶
Available fields:
collection: The collection to be retrieved.document: A Nerdpack document is formed by an identifier (called documentId) and a set of data associated with it.
class NerdStorageAccountScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("collection", "document")
collection = sgqlc.types.Field(
sgqlc.types.list_of("NerdStorageCollectionMember"),
graphql_name="collection",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The collection from which documents
will be retrieved.
"""
document = sgqlc.types.Field(
NerdStorageDocument,
graphql_name="document",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="documentId",
default=None,
),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The collection that the document
belongs to.
* `document_id` (`String!`): The documentId to be retrieved.
"""758. NerdStorageActorScope¶
Available fields:
collection: Nerdpack documents are stored inside a collection. A collection can be thought of as a key-value storage where each document is one of these key-value pairs.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
document: A Nerdpack document is formed by an identifier (called documentId) and a set of data associated with it.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
class NerdStorageActorScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("collection", "document")
collection = sgqlc.types.Field(
sgqlc.types.list_of("NerdStorageCollectionMember"),
graphql_name="collection",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The collection from which documents
will be retrieved.
"""
document = sgqlc.types.Field(
NerdStorageDocument,
graphql_name="document",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="documentId",
default=None,
),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The collection that the document
belongs to.
* `document_id` (`String!`): The documentId to be retrieved.
"""759. NerdStorageCollectionMember¶
Available fields:
document: The NerdStorage document.id: The documentId.
class NerdStorageCollectionMember(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("document", "id")
document = sgqlc.types.Field(NerdStorageDocument, graphql_name="document")
id = sgqlc.types.Field(String, graphql_name="id")760. NerdStorageDeleteResult¶
Available fields:
deleted
class NerdStorageDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deleted",)
deleted = sgqlc.types.Field(Int, graphql_name="deleted")761. NerdStorageEntityScope¶
Available fields:
collectiondocument
class NerdStorageEntityScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("collection", "document")
collection = sgqlc.types.Field(
sgqlc.types.list_of(NerdStorageCollectionMember),
graphql_name="collection",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"scope_by_actor",
sgqlc.types.Arg(Boolean, graphql_name="scopeByActor", default=None),
),
)
),
)
document = sgqlc.types.Field(
NerdStorageDocument,
graphql_name="document",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="documentId",
default=None,
),
),
(
"scope_by_actor",
sgqlc.types.Arg(Boolean, graphql_name="scopeByActor", default=None),
),
)
),
)
"""Arguments:
* `collection` (`String!`)None
* `document_id` (`String!`)None
* `scope_by_actor` (`Boolean`)None
"""762. NerdStorageVaultActorStitchedFields¶
Available fields:
secret: Fetch a single secret by key.secrets: List the keys and values of all secrets you have access to for the current scope and nerdpack.
class NerdStorageVaultActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("secret", "secrets")
secret = sgqlc.types.Field(
"NerdStorageVaultSecret",
graphql_name="secret",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
)
),
)
secrets = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("NerdStorageVaultSecret"))
),
graphql_name="secrets",
)763. NerdStorageVaultDeleteSecretResult¶
Result of a mutation.
Available fields:
errors: Any errors that happend during the mutation.status: The status of the mutation.
class NerdStorageVaultDeleteSecretResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "status")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("NerdStorageVaultResultError")),
graphql_name="errors",
)
status = sgqlc.types.Field(
sgqlc.types.non_null(NerdStorageVaultResultStatus), graphql_name="status"
)764. NerdStorageVaultResultError¶
Mutation error information.
Available fields:
message: The error message.type: The type of error that occured when performing the mutation.
class NerdStorageVaultResultError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(NerdStorageVaultErrorType), graphql_name="type"
)765. NerdStorageVaultSecret¶
Secret key and value.
Available fields:
key: The unique identifier of the secret.value: The value of the secret.
class NerdStorageVaultSecret(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(SecureValue), graphql_name="value")766. NerdStorageVaultWriteSecretResult¶
Information about the result of the write secret mutation
Available fields:
errors: Any errors that happend during the mutation.status: The status of the mutation.
class NerdStorageVaultWriteSecretResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "status")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(NerdStorageVaultResultError)),
graphql_name="errors",
)
status = sgqlc.types.Field(
sgqlc.types.non_null(NerdStorageVaultResultStatus), graphql_name="status"
)767. NerdpackAllowListResult¶
Result of an allow list mutation.
Available fields:
nerdpack: Nerdpack to allow to subscribe.resultsPerAccount: Subscription allow list result per account.
class NerdpackAllowListResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nerdpack", "results_per_account")
nerdpack = sgqlc.types.Field(
sgqlc.types.non_null("NerdpackData"), graphql_name="nerdpack"
)
results_per_account = sgqlc.types.Field(
sgqlc.types.list_of("NerdpackMutationResultPerAccount"),
graphql_name="resultsPerAccount",
)768. NerdpackAllowedAccount¶
Information about an account present on the allow-list
Available fields:
accountId: Allowed account id
class NerdpackAllowedAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id",)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")769. NerdpackAssetInfo¶
Info about Nerdpack assets.
Available fields:
name: Name of the asset.sizeInBytes: Size of the asset, in Bytes.
class NerdpackAssetInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "size_in_bytes")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
size_in_bytes = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="sizeInBytes"
)770. NerdpackData¶
The Nerdpack root object. Contains the Nerdpack information including the list of versions and subscriptions.
Available fields:
accountId: Unique identifier of the account that owns the Nerdpack.allowedAccounts: Get the list of accounts specified on the allow list. If the user is authorized to the nerdpack owner account all the allowed accounts will be displayed, otherwise, only the intersection of allowed accounts and user authorized accounts will be displayed.id: Unique V5 uuid that identifies the Nerdpack.subscriptionModel: Type that defines the rules for account subscription.subscriptions: List of subscriptions on versions of the given Nerdpack.versions: Retrieve the versions for the given Nerdpack.
class NerdpackData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"allowed_accounts",
"id",
"subscription_model",
"subscriptions",
"versions",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
allowed_accounts = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackAllowedAccount), graphql_name="allowedAccounts"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
subscription_model = sgqlc.types.Field(
NerdpackSubscriptionModel, graphql_name="subscriptionModel"
)
subscriptions = sgqlc.types.Field(
sgqlc.types.list_of("NerdpackSubscription"), graphql_name="subscriptions"
)
versions = sgqlc.types.Field(
"NerdpackVersionsResult",
graphql_name="versions",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
NerdpackVersionFilter, graphql_name="filter", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Pagination cursor. Defaults to first page
* `filter` (`NerdpackVersionFilter`): Version filter
"""771. NerdpackMutationResultPerAccount¶
Mutation result for the given acccount.
Available fields:
accountId: Given account ID.reason: Error type if mutation failed.result: Mutation result for the given acccount.
class NerdpackMutationResultPerAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "reason", "result")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
reason = sgqlc.types.Field(NerdpackMutationErrorType, graphql_name="reason")
result = sgqlc.types.Field(
sgqlc.types.non_null(NerdpackMutationResult), graphql_name="result"
)772. NerdpackNerdpacks¶
Provides fields to query nerdpacks by different conditions
Available fields:
effectiveSubscribedVersions: Get the list of stable core nerdpack versions together with nerdpack versions which the requesting user’s account is subscribed. This query allows for version or channel overrides by providing OverrideVersionRules objects.nerdpack: If a Nerdpack with the given uuid exists, retrieve the Nerdpack object.subscribable: Returns the list of subscribable Nerdpacks of the current user.
class NerdpackNerdpacks(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("effective_subscribed_versions", "nerdpack", "subscribable")
effective_subscribed_versions = sgqlc.types.Field(
sgqlc.types.list_of("NerdpackVersion"),
graphql_name="effectiveSubscribedVersions",
args=sgqlc.types.ArgDict(
(
(
"overrides",
sgqlc.types.Arg(
sgqlc.types.list_of(NerdpackOverrideVersionRules),
graphql_name="overrides",
default=None,
),
),
)
),
)
"""Arguments:
* `overrides` (`[NerdpackOverrideVersionRules]`): List of version
override rules per Nerdpack. The query will return the version
that matches the specified rules (if it exists) for a given
nerdpack instead of deciding which version has priority
"""
nerdpack = sgqlc.types.Field(
NerdpackData,
graphql_name="nerdpack",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): Nerdpack id.
"""
subscribable = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackData),
graphql_name="subscribable",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_filter",
sgqlc.types.Arg(
NerdpackDataFilter, graphql_name="nerdpackFilter", default=None
),
),
)
),
)
"""Arguments:
* `nerdpack_filter` (`NerdpackDataFilter`): Nerdpack filter data.
"""773. NerdpackRemovedTagInfo¶
Information about removed tag
Available fields:
nerdpackId: UUID of the nerdpacktagName: Tag removedversion: Version affected
class NerdpackRemovedTagInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nerdpack_id", "tag_name", "version")
nerdpack_id = sgqlc.types.Field(ID, graphql_name="nerdpackId")
tag_name = sgqlc.types.Field(NerdpackTagName, graphql_name="tagName")
version = sgqlc.types.Field(SemVer, graphql_name="version")774. NerdpackRemovedTagResponse¶
Removed Tag response
Available fields:
removedTagInfo: Optional removed tag informationstatus: The status of the response. Tells is the tag was deleted or not
class NerdpackRemovedTagResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("removed_tag_info", "status")
removed_tag_info = sgqlc.types.Field(
NerdpackRemovedTagInfo, graphql_name="removedTagInfo"
)
status = sgqlc.types.Field(NerdpackRemovedTagResponseType, graphql_name="status")775. NerdpackSubscribeResult¶
Subscription result.
Available fields:
nerdpack: Nerdpack to be subscribed to.resultsPerAccount: Subscription result per account.tag: Tag associated with the version.
class NerdpackSubscribeResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nerdpack", "results_per_account", "tag")
nerdpack = sgqlc.types.Field(
sgqlc.types.non_null(NerdpackData), graphql_name="nerdpack"
)
results_per_account = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackMutationResultPerAccount),
graphql_name="resultsPerAccount",
)
tag = sgqlc.types.Field(NerdpackTagName, graphql_name="tag")776. NerdpackSubscription¶
Nerdpack subscription information.
Available fields:
accessType: What type of access the user has over this subscription. Eg: direct or inherited.accountId: Unique identifier of the account that has subscribed to the Nerdpack.nerdpackVersion: Nerdpack associated to the subscribed version.tag: Tag associated with the version.
class NerdpackSubscription(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("access_type", "account_id", "nerdpack_version", "tag")
access_type = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackSubscriptionAccessType), graphql_name="accessType"
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
nerdpack_version = sgqlc.types.Field(
"NerdpackVersion", graphql_name="nerdpackVersion"
)
tag = sgqlc.types.Field(NerdpackTagName, graphql_name="tag")777. NerdpackUnsubscribeResult¶
Result of trying to remove the subscription.
Available fields:
nerdpack: Nerdpack to be unsubscribed from.resultsPerAccount: Unsubscribe result per account.
class NerdpackUnsubscribeResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nerdpack", "results_per_account")
nerdpack = sgqlc.types.Field(
sgqlc.types.non_null(NerdpackData), graphql_name="nerdpack"
)
results_per_account = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackMutationResultPerAccount),
graphql_name="resultsPerAccount",
)778. NerdpackVersion¶
Contains files and information associated with a specific version of a Nerdpack.
Available fields:
assets: List of assets present on this Nerdpack version.cliVersion: Version of the CLI used to generate the Nerdpack.createdAt: Timestamp for the creation on the Nerdpack version.createdByUser: Unique identifier of the user who created the version.description: A brief description of the artifact.displayName: Human-readable Nerdpack’s name.icon: Icon URL of PackagenerdpackId: Unique uuid V5 that identifies the Nerdpack.repositoryUrl: URL to the repository with the Nerdpack source code.sdkVersion: Version of the SDK used to generate the Nerdpack.subscriptionModel: Nerdpack subscription model to filter.tags: List of tags associated with the Nerdpack version.version: Semver-compliant Nerdpack version.
class NerdpackVersion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"assets",
"cli_version",
"created_at",
"created_by_user",
"description",
"display_name",
"icon",
"nerdpack_id",
"repository_url",
"sdk_version",
"subscription_model",
"tags",
"version",
)
assets = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(NerdpackAssetInfo))
),
graphql_name="assets",
)
cli_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="cliVersion"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by_user = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="createdByUser"
)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
icon = sgqlc.types.Field(String, graphql_name="icon")
nerdpack_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="nerdpackId")
repository_url = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="repositoryUrl"
)
sdk_version = sgqlc.types.Field(String, graphql_name="sdkVersion")
subscription_model = sgqlc.types.Field(
NerdpackSubscriptionModel, graphql_name="subscriptionModel"
)
tags = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(NerdpackTagName))
),
graphql_name="tags",
)
version = sgqlc.types.Field(sgqlc.types.non_null(SemVer), graphql_name="version")779. NerdpackVersionsResult¶
Results of the nerdpack versions query.
Available fields:
nextCursor: Cursor that can be used to retrieve the next results page.results: List of nerdpack version objects.totalCount: Total amount of available version objects for the given nerdpack (including the ones not showed in the current page)
class NerdpackVersionsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(NerdpackVersion), graphql_name="results"
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")780. Nr1CatalogActorStitchedFields¶
Available fields:
alertPolicyTemplate: Information related to a alert policy templatecategories: List of available categories for filtering and searchingdashboardTemplate: Information related to a dashboard templatedataSource: Information related to a data sourcenerdpack: Information related to a deployed Nerdpacknerdpacks: List of nerdpacks available in the catalogquickstart: Catalog information related to a quickstartquickstarts: List of Quickstarts available in New Relic I/Osearch: Search for items in the catalog
class Nr1CatalogActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"alert_policy_template",
"categories",
"dashboard_template",
"data_source",
"nerdpack",
"nerdpacks",
"quickstart",
"quickstarts",
"search",
)
alert_policy_template = sgqlc.types.Field(
"Nr1CatalogAlertPolicyTemplate",
graphql_name="alertPolicyTemplate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
categories = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogCategory")),
graphql_name="categories",
)
dashboard_template = sgqlc.types.Field(
"Nr1CatalogDashboardTemplate",
graphql_name="dashboardTemplate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
data_source = sgqlc.types.Field(
"Nr1CatalogDataSource",
graphql_name="dataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
nerdpack = sgqlc.types.Field(
"Nr1CatalogNerdpack",
graphql_name="nerdpack",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
nerdpacks = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogNerdpack")),
graphql_name="nerdpacks",
)
quickstart = sgqlc.types.Field(
"Nr1CatalogQuickstart",
graphql_name="quickstart",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
quickstarts = sgqlc.types.Field(
"Nr1CatalogQuickstartsListing",
graphql_name="quickstarts",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous Quickstarts query.
"""
search = sgqlc.types.Field(
"Nr1CatalogSearchResponse",
graphql_name="search",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
Nr1CatalogSearchFilter, graphql_name="filter", default=None
),
),
("query", sgqlc.types.Arg(String, graphql_name="query", default=None)),
(
"sort_by",
sgqlc.types.Arg(
Nr1CatalogSearchSortOption,
graphql_name="sortBy",
default="ALPHABETICAL",
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): Cursor for pagination. Supplied by a
previous search.
* `filter` (`Nr1CatalogSearchFilter`): Set of filters to apply to
the search
* `query` (`String`): Search query string
* `sort_by` (`Nr1CatalogSearchSortOption`): Method used to sort
the search results (default: `ALPHABETICAL`)
"""781. Nr1CatalogAlertConditionOutline¶
An outline of a created alert condition
Available fields:
alertConditionTemplate: The template id of the created alert conditionid: The id of the created alert condition
class Nr1CatalogAlertConditionOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("alert_condition_template", "id")
alert_condition_template = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogAlertConditionTemplate"),
graphql_name="alertConditionTemplate",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")782. Nr1CatalogAlertConditionTemplate¶
Information about an alert condition template
Available fields:
id: The unique identifier for the alert condition templatemetadata: Metadata associated with the alert condition template
class Nr1CatalogAlertConditionTemplate(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogAlertConditionTemplateMetadata"),
graphql_name="metadata",
)783. Nr1CatalogAlertConditionTemplateMetadata¶
Metadata associated with the alert condition template
Available fields:
description: A short form description for the alert condition templatedisplayName: The human-readable name for the alert condition templatetype: Determines the type of alert condition template that will be created
class Nr1CatalogAlertConditionTemplateMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "display_name", "type")
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogAlertConditionType), graphql_name="type"
)784. Nr1CatalogAlertPolicyOutline¶
An outline of a created alert policy
Available fields:
conditions: A list of created alert conditions under this policyid: The id of the created alert policy
class Nr1CatalogAlertPolicyOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("conditions", "id")
conditions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogAlertConditionOutline)),
graphql_name="conditions",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")785. Nr1CatalogAlertPolicyTemplate¶
Information about an alert policy template
Available fields:
id: The unique identifier for the alert policy templatemetadata: Metadata associated with the alert policy templatesupportLevel: Level of support expected for the alert policy templateupdatedAt: A timestamp that indicates when the alert policy template was last updated
class Nr1CatalogAlertPolicyTemplate(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "support_level", "updated_at")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
"Nr1CatalogAlertPolicyTemplateMetadata", graphql_name="metadata"
)
support_level = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSupportLevel), graphql_name="supportLevel"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)786. Nr1CatalogAlertPolicyTemplateMetadata¶
Metadata associated with the alert policy template
Available fields:
authors: A list of authors that created the alert policy templatecategories: The list of categories for filtering, searching, and grouping associated with the alert policy templatecategoryTerms: The list of category terms associated with the alert policy templateconditions: The list of alert condition templates attached to the alert policy templatedisplayName: The human-readable name for the alert policy templateicon: The corresponding icon for the alert policy templaterequiredDataSources: A list of required data sources needed to populate data in the alert policy.
class Nr1CatalogAlertPolicyTemplateMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authors",
"categories",
"category_terms",
"conditions",
"display_name",
"icon",
"required_data_sources",
)
authors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogAuthor"))
),
graphql_name="authors",
)
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogCategory"))
),
graphql_name="categories",
)
category_terms = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="categoryTerms",
)
conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogAlertConditionTemplate))
),
graphql_name="conditions",
)
display_name = sgqlc.types.Field(String, graphql_name="displayName")
icon = sgqlc.types.Field("Nr1CatalogIcon", graphql_name="icon")
required_data_sources = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogDataSource"))
),
graphql_name="requiredDataSources",
)787. Nr1CatalogAuthor¶
Information about an author
Available fields:
name: The name of the author
class Nr1CatalogAuthor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name",)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")788. Nr1CatalogCategory¶
A thematic grouping for catalog items
Available fields:
displayName: The human readable name of the categoryslug: The url friendly name of the categoryterms: A list of terms that match catalog items to this category
class Nr1CatalogCategory(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "slug", "terms")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
slug = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="slug")
terms = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="terms",
)789. Nr1CatalogCategoryFacet¶
Information about a facet count on a category
Available fields:
count: The count of results for this categorydisplayName: The category’s display name
class Nr1CatalogCategoryFacet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "display_name")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)790. Nr1CatalogCommunityContactChannel¶
A contact channel where users can get support via the community
Available fields:
url: The URL linking to a website for support
class Nr1CatalogCommunityContactChannel(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")791. Nr1CatalogComponentFacet¶
Information about a facet count on a component
Available fields:
component: The type of componentcount: The count of results for this component
class Nr1CatalogComponentFacet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("component", "count")
component = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSearchComponentType), graphql_name="component"
)
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")792. Nr1CatalogDashboardOutline¶
An outline of a created dashboard
Available fields:
dashboardGuid: The guid of the created dashboard
class Nr1CatalogDashboardOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("dashboard_guid",)
dashboard_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="dashboardGuid"
)793. Nr1CatalogDashboardTemplate¶
Information about a dashboard template
Available fields:
id: The unique identifier for the dashboard templatemetadata: Metadata associated with the dashboard templatesupportLevel: Level of support expected for the dashboard templateupdatedAt: A timestamp that indicates when the dashboard template was last updated
class Nr1CatalogDashboardTemplate(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "support_level", "updated_at")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogDashboardTemplateMetadata"),
graphql_name="metadata",
)
support_level = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSupportLevel), graphql_name="supportLevel"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="updatedAt"
)794. Nr1CatalogDashboardTemplateMetadata¶
Metadata associated with a dashboard template
Available fields:
authors: A list of authors that created the dashboard templatecategories: The list of categories for filtering, searching, and grouping associated with the dashboard templatecategoryTerms: The list of category terms associated with the dashboard templatedescription: A short form description for a dashboard template.displayName: The human-readable name for a dashboard template.previews: A list of previews for a dashboard template, such as screenshots.requiredDataSources: A list of required data sources needed to populate data in the dashboard.
class Nr1CatalogDashboardTemplateMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authors",
"categories",
"category_terms",
"description",
"display_name",
"previews",
"required_data_sources",
)
authors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogAuthor))
),
graphql_name="authors",
)
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogCategory))
),
graphql_name="categories",
)
category_terms = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="categoryTerms",
)
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
previews = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogPreview))
),
graphql_name="previews",
)
required_data_sources = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogDataSource"))
),
graphql_name="requiredDataSources",
)795. Nr1CatalogDataSource¶
Information about a data source
Available fields:
id: The unique identifier for the data sourcemetadata: Metadata associated with the data source
class Nr1CatalogDataSource(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogDataSourceMetadata"), graphql_name="metadata"
)796. Nr1CatalogDataSourceInstall¶
Information about a data source install
Available fields:
fallback: Provides context about how the fallback install should proceedprimary: Provides context about how the primary install should proceed
class Nr1CatalogDataSourceInstall(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("fallback", "primary")
fallback = sgqlc.types.Field(
"Nr1CatalogDataSourceInstallDirective", graphql_name="fallback"
)
primary = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogDataSourceInstallDirective"),
graphql_name="primary",
)797. Nr1CatalogDataSourceMetadata¶
Metadata associated with a data source
Available fields:
autoInstallAlertPolicyTemplates: A list of alert policy templates that are auto installed upon data source installationautoInstallDashboardTemplates: A list of dashboard templates that are auto installed upon data source installationcategories: The categories for the data sourcedescription: A short form description for the data sourcedisplayName: The human-readable name for the data sourceicon: The corresponding icon for the data sourceinstall: Install information for the data sourcekeywords: A list of keywords for filtering and searching
class Nr1CatalogDataSourceMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"auto_install_alert_policy_templates",
"auto_install_dashboard_templates",
"categories",
"description",
"display_name",
"icon",
"install",
"keywords",
)
auto_install_alert_policy_templates = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogAlertPolicyTemplate))
),
graphql_name="autoInstallAlertPolicyTemplates",
)
auto_install_dashboard_templates = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogDashboardTemplate))
),
graphql_name="autoInstallDashboardTemplates",
)
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogCategory))
),
graphql_name="categories",
)
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
icon = sgqlc.types.Field("Nr1CatalogIcon", graphql_name="icon")
install = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogDataSourceInstall), graphql_name="install"
)
keywords = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="keywords",
)798. Nr1CatalogEmailContactChannel¶
A contact channel where users can get support via email
Available fields:
address: The email address for email support
class Nr1CatalogEmailContactChannel(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("address",)
address = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="address")799. Nr1CatalogIcon¶
Information about an icon
Available fields:
url: The publicly accessible URL for the icon
class Nr1CatalogIcon(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")800. Nr1CatalogInstallAlertPolicyTemplateResult¶
Information about the mutation result when installing an alert policy template
Available fields:
alertPolicyTemplate: The template that was used for the installationcreatedAlertPolicy: An outline of the created alert policy
class Nr1CatalogInstallAlertPolicyTemplateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("alert_policy_template", "created_alert_policy")
alert_policy_template = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogAlertPolicyTemplate),
graphql_name="alertPolicyTemplate",
)
created_alert_policy = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogAlertPolicyOutline),
graphql_name="createdAlertPolicy",
)801. Nr1CatalogInstallDashboardTemplateResult¶
Information about the mutation result when installing a dashboard template
Available fields:
createdDashboard: An outline of the created dashboarddashboardTemplate: The template that was used for the installation
class Nr1CatalogInstallDashboardTemplateResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_dashboard", "dashboard_template")
created_dashboard = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogDashboardOutline),
graphql_name="createdDashboard",
)
dashboard_template = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogDashboardTemplate),
graphql_name="dashboardTemplate",
)802. Nr1CatalogInstallPlanStep¶
Information pertaining to a specific step in the installation plan
Available fields:
description: A short form description for the install plan stepdisplayName: The human-readable name for the install plan stepfallback: Provides context about how the fallback install plan step should proceedheading: Used as a heading for the install plan stepid: The unique identifier for the install plan stepprimary: Provides context about how the primary install plan step should proceedtarget: Provides context about where the install will occur
class Nr1CatalogInstallPlanStep(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"display_name",
"fallback",
"heading",
"id",
"primary",
"target",
)
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
fallback = sgqlc.types.Field(
Nr1CatalogInstallPlanDirective, graphql_name="fallback"
)
heading = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="heading")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
primary = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogInstallPlanDirective), graphql_name="primary"
)
target = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogInstallPlanTarget"), graphql_name="target"
)803. Nr1CatalogInstallPlanTarget¶
Represents the location of an install
Available fields:
destination: Provides context on the location the install will take placeos: Provides context for the operating system that will be targetedtype: Provides context for the type of installation that will take place
class Nr1CatalogInstallPlanTarget(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("destination", "os", "type")
destination = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogInstallPlanDestination),
graphql_name="destination",
)
os = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(Nr1CatalogInstallPlanOperatingSystem)
)
),
graphql_name="os",
)
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogInstallPlanTargetType), graphql_name="type"
)804. Nr1CatalogIssuesContactChannel¶
A contact channel where users can get support via the repository issues page
Available fields:
url: The URL linking to the repository issues page
class Nr1CatalogIssuesContactChannel(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")805. Nr1CatalogLinkInstallDirective¶
Information about a link install directive
Available fields:
url: The URL of the external link used to guide the user through installation
class Nr1CatalogLinkInstallDirective(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")806. Nr1CatalogNerdletInstallDirective¶
Information about a nerdlet install directive
Available fields:
nerdletId: The nerdlet ID used to guide the user through installationnerdletState: The nerdlet state used to intialize the nerdletrequiresAccount: Determines if an account selection needs to be made prior to installation
class Nr1CatalogNerdletInstallDirective(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nerdlet_id", "nerdlet_state", "requires_account")
nerdlet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="nerdletId")
nerdlet_state = sgqlc.types.Field(
Nr1CatalogRawNerdletState, graphql_name="nerdletState"
)
requires_account = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="requiresAccount"
)807. Nr1CatalogNerdpack¶
Information about the Nerdpack
Available fields:
id: The unique identifier for the Nerdpackmetadata: Metadata associated with the Nerdpack that is available in the New Relic One Catalogvisibility: Indicates the visibility of the Nerdpack
class Nr1CatalogNerdpack(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "metadata", "visibility")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field("Nr1CatalogNerdpackMetadata", graphql_name="metadata")
visibility = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogNerdpackVisibility), graphql_name="visibility"
)808. Nr1CatalogNerdpackMetadata¶
Metadata associated with the Nerdpack that is available in the New Relic One Catalog
Available fields:
additionalInfo: Additional information about the Nerdpackcategories: The list of categories for filtering, searching, and grouping associated with the NerdpackcategoryTerms: The list of category terms associated with the Nerdpackdescription: A short form description for the New Relic One Nerdpack. Used throughout the platform when displaying the Nerdpack.details: The long form description used in the catalog to detail the functionality of the NerdpackdisplayName: The human-readable name for the Nerdpack. Used throughout the New Relic One platform when displaying the Nerdpack.documentation: Additional documentation for the Nerdpackicon: The corresponding icon for the NerdpackincludedArtifactTypes: The types of artifacts (e.g. nerdlet, launcher, etc) contained in the nerdpackkeywords: The list of keywords for filtering and searchingnerdpackItems: Information related to items in the nerdpackpreviews: A list of previews for the Nerdpack, such as screenshots.publishDate: The date the Nerdpack was publishedrepository: The URL to the repository where the source code for the Nerdpack can be found.support: Contact information to get support for the Nerdpacktagline: A tagline for the Nerdpackversion: The nerdpack version the metadata corresponds withwhatsNew: A description of changes for this version of the Nerdpack
class Nr1CatalogNerdpackMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"additional_info",
"categories",
"category_terms",
"description",
"details",
"display_name",
"documentation",
"icon",
"included_artifact_types",
"keywords",
"nerdpack_items",
"previews",
"publish_date",
"repository",
"support",
"tagline",
"version",
"whats_new",
)
additional_info = sgqlc.types.Field(
String,
graphql_name="additionalInfo",
args=sgqlc.types.ArgDict(
(
(
"format",
sgqlc.types.Arg(
Nr1CatalogRenderFormat,
graphql_name="format",
default="MARKDOWN",
),
),
)
),
)
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogCategory))
),
graphql_name="categories",
)
category_terms = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="categoryTerms",
)
description = sgqlc.types.Field(String, graphql_name="description")
details = sgqlc.types.Field(String, graphql_name="details")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
documentation = sgqlc.types.Field(
String,
graphql_name="documentation",
args=sgqlc.types.ArgDict(
(
(
"format",
sgqlc.types.Arg(
Nr1CatalogRenderFormat,
graphql_name="format",
default="MARKDOWN",
),
),
)
),
)
icon = sgqlc.types.Field(Nr1CatalogIcon, graphql_name="icon")
included_artifact_types = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="includedArtifactTypes"
)
keywords = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="keywords",
)
nerdpack_items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogNerdpackItem))
),
graphql_name="nerdpackItems",
)
previews = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogPreview))
),
graphql_name="previews",
)
publish_date = sgqlc.types.Field(DateTime, graphql_name="publishDate")
repository = sgqlc.types.Field(String, graphql_name="repository")
support = sgqlc.types.Field(
sgqlc.types.non_null("Nr1CatalogSupportChannels"), graphql_name="support"
)
tagline = sgqlc.types.Field(String, graphql_name="tagline")
version = sgqlc.types.Field(sgqlc.types.non_null(SemVer), graphql_name="version")
whats_new = sgqlc.types.Field("Nr1CatalogReleaseNote", graphql_name="whatsNew")809. Nr1CatalogQuickstart¶
Information about the quickstart
Available fields:
featured: Determines if this is a featured quickstartid: The unique identifier for the quickstartmetadata: Metadata associated with the quickstartsourceUrl: Specifies the URL where the source definition for the quickstart can be foundsupportLevel: Level of support expected for the quickstart
class Nr1CatalogQuickstart(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("featured", "id", "metadata", "source_url", "support_level")
featured = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="featured")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
metadata = sgqlc.types.Field(
"Nr1CatalogQuickstartMetadata", graphql_name="metadata"
)
source_url = sgqlc.types.Field(String, graphql_name="sourceUrl")
support_level = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSupportLevel), graphql_name="supportLevel"
)810. Nr1CatalogQuickstartMetadata¶
Metadata associated with the quickstart that is available in New Relic I/O
Available fields:
authors: Authors for the quickstartcategories: The list of categories for filtering, searching, and grouping associated with the quickstartcategoryTerms: The list of category terms associated with the quickstartdataSources: The list of data sources associated with the quickstartdescription: A short form description for the quickstart. Used throughout the platform when displaying the quickstart.displayName: The human-readable name for the quickstart. Used throughout the New Relic One platform when displaying the quickstart.icon: The corresponding icon for the quickstartkeywords: A list of keywords for filtering and searchingquickstartComponents: List of components in a quickstartslug: The URL friendly name of the quickstartsummary: A short summary detailing the functionality of the quickstart
class Nr1CatalogQuickstartMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authors",
"categories",
"category_terms",
"data_sources",
"description",
"display_name",
"icon",
"keywords",
"quickstart_components",
"slug",
"summary",
)
authors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogAuthor))
),
graphql_name="authors",
)
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogCategory))
),
graphql_name="categories",
)
category_terms = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="categoryTerms",
)
data_sources = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogDataSource))
),
graphql_name="dataSources",
)
description = sgqlc.types.Field(String, graphql_name="description")
display_name = sgqlc.types.Field(String, graphql_name="displayName")
icon = sgqlc.types.Field(Nr1CatalogIcon, graphql_name="icon")
keywords = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="keywords",
)
quickstart_components = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogQuickstartComponent))
),
graphql_name="quickstartComponents",
)
slug = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="slug")
summary = sgqlc.types.Field(String, graphql_name="summary")811. Nr1CatalogQuickstartsListing¶
Paginated information about Quickstarts
Available fields:
nextCursor: Cursor used to fetch the next set of resultsresults: The list of quickstart resultstotalCount: The total number of quickstart results
class Nr1CatalogQuickstartsListing(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogQuickstart))
),
graphql_name="results",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)812. Nr1CatalogReleaseNote¶
Information about the changes made to the metadata for a version of the Nerdpack
Available fields:
changes: The description of changes made for this version of the Nerdpackversion: The version of the Nerdpack the changes correspond with
class Nr1CatalogReleaseNote(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("changes", "version")
changes = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="changes")
version = sgqlc.types.Field(sgqlc.types.non_null(SemVer), graphql_name="version")813. Nr1CatalogSearchFacets¶
Information about facets from a search
Available fields:
categories: Facet counts for each categorycomponents: Facet counts for each componentfeatured: Count of the number of featured resultstypes: Facet counts for each search result type
class Nr1CatalogSearchFacets(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("categories", "components", "featured", "types")
categories = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogCategoryFacet))
),
graphql_name="categories",
)
components = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogComponentFacet))
),
graphql_name="components",
)
featured = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="featured")
types = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogSearchResultTypeFacet"))
),
graphql_name="types",
)814. Nr1CatalogSearchResponse¶
Information about results returned from a search
Available fields:
facets: Get count information about the filtersnextCursor: Cursor used to fetch the next set of resultsresults: The list of search resultstotalCount: The total number of results that match the search
class Nr1CatalogSearchResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("facets", "next_cursor", "results", "total_count")
facets = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSearchFacets), graphql_name="facets"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("Nr1CatalogSearchResult"))
),
graphql_name="results",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)815. Nr1CatalogSearchResultTypeFacet¶
Information about a facet count on a search result type
Available fields:
count: The count of results for this search result typetype: The type of search result
class Nr1CatalogSearchResultTypeFacet(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "type")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSearchResultType), graphql_name="type"
)816. Nr1CatalogSubmitMetadataError¶
Information about the error that occurred as a result of submitting metadata
Available fields:
description: A human-readable description of the error when submitting metadatafield: The field that caused the error when submitting metadatatype: The type of error that occurred when submitting metadata
class Nr1CatalogSubmitMetadataError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "field", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
field = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="field"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogSubmitMetadataErrorType), graphql_name="type"
)817. Nr1CatalogSubmitMetadataResult¶
Information about the mutation result when submitting metadata
Available fields:
errors: A list of errors that may have occurred as a result of submitting metadatanerdpack: The Nerdpack with updated information as a result of running the mutationresult: The mutation result when submitting metadata
class Nr1CatalogSubmitMetadataResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "nerdpack", "result")
errors = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogSubmitMetadataError)),
graphql_name="errors",
)
nerdpack = sgqlc.types.Field(Nr1CatalogNerdpack, graphql_name="nerdpack")
result = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogMutationResult), graphql_name="result"
)818. Nr1CatalogSupportChannels¶
A container for the various support channels
Available fields:
community: A support channel available via the communityemail: A support channel available via emailissues: A support channel available via an issues page
class Nr1CatalogSupportChannels(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("community", "email", "issues")
community = sgqlc.types.Field(
Nr1CatalogCommunityContactChannel, graphql_name="community"
)
email = sgqlc.types.Field(Nr1CatalogEmailContactChannel, graphql_name="email")
issues = sgqlc.types.Field(Nr1CatalogIssuesContactChannel, graphql_name="issues")819. NrdbMetadata¶
An object containing metadata about the query and result.
Available fields:
eventTypes: A list of the event types that were queried.facets: A list of facets that were queried.messages: Messages from NRDB included with the result.timeWindow: Details about the query time window.
class NrdbMetadata(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("event_types", "facets", "messages", "time_window")
event_types = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="eventTypes"
)
facets = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="facets")
messages = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="messages")
time_window = sgqlc.types.Field("NrdbMetadataTimeWindow", graphql_name="timeWindow")820. NrdbMetadataTimeWindow¶
An object representing details about a query’s time window.
Available fields:
begin: Timestamp marking the query begin time.compareWith: A clause representing the comparison time window.end: Timestamp marking the query end time.since: SINCE clause resulting from the queryuntil: UNTIL clause resulting from the query
class NrdbMetadataTimeWindow(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("begin", "compare_with", "end", "since", "until")
begin = sgqlc.types.Field(EpochMilliseconds, graphql_name="begin")
compare_with = sgqlc.types.Field(String, graphql_name="compareWith")
end = sgqlc.types.Field(EpochMilliseconds, graphql_name="end")
since = sgqlc.types.Field(String, graphql_name="since")
until = sgqlc.types.Field(String, graphql_name="until")821. NrdbQueryProgress¶
An object containing metadata about the execution of an asynchronous NRQL query.
Available fields:
completed: Whether the query has finished executing.queryId: A token for retrieving the results of a previously executed asynchronous query.resultExpiration: Results of the completed query will expire permanently after this long.retryAfter: Wait at least this long before querying for completed results with thequeryId.retryDeadline: The server may cancel the NRDB query after this long if no GraphQL queries have been made to check thequeryId’s status.
class NrdbQueryProgress(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"completed",
"query_id",
"result_expiration",
"retry_after",
"retry_deadline",
)
completed = sgqlc.types.Field(Boolean, graphql_name="completed")
query_id = sgqlc.types.Field(ID, graphql_name="queryId")
result_expiration = sgqlc.types.Field(Seconds, graphql_name="resultExpiration")
retry_after = sgqlc.types.Field(Seconds, graphql_name="retryAfter")
retry_deadline = sgqlc.types.Field(Seconds, graphql_name="retryDeadline")822. NrdbResultContainer¶
A data structure that contains the results of the NRDB query along with other capabilities that enhance those results.
Direct query results are available through results, totalResult and
otherResult. The query you made is accessible through nrql, along with
metadata about the query itself. Enhanced capabilities include
eventDefinitions, suggestedFacets and more.
Available fields:
currentResults: In aCOMPARE WITHquery, thecurrentResultscontain the results for the current comparison time window.embeddedChartUrl: Generate a publicly sharable Embedded Chart URL for the NRQL query.
For more details, see our docs.
eventDefinitions: Retrieve a list of event type definitions, providing descriptions of the event types returned by this query, as well as details of their attributes.metadata: Metadata about the query and result.nrql: The NRQL query that was executed to yield these results.otherResult: In aFACETquery, theotherResultcontains the aggregates representing the events not contained in an individualresultsfacet.previousResults: In aCOMPARE WITHquery, thepreviousResultscontain the results for the previous comparison time window.queryProgress: Metadata about the execution of an asynchronous NRQL query.rawResponse: The raw query results exactly as they are returned from NRDB. NerdGraph provides no additional transformation.results: The query results. This is a flat list of objects who’s structure matches the query submitted.staticChartUrl: Generate a publicly sharable static chart URL for the NRQL query.suggestedFacets: Retrieve a list of suggested NRQL facets for this NRDB query, to be used with theFACETkeyword in NRQL.
Results are based on historical query behaviors.
If the query already has a FACET clause, it will be ignored for the purposes
of suggesting facets.
For more details, see our docs.
suggestedQueries: Suggested queries that could help explain an anomaly in your timeseries based on either statistical differences in the data or historical usage.
If no anomalyTimeWindow is supplied, we will attempt to detect a spike in the NRQL results. If no spike is found, the suggested query results will be empty.
Input NRQL must be a TIMESERIES query and must have exactly one result.
totalResult: In aFACETquery, thetotalResultcontains the aggregates representing all the events, whether or not they are contained in an individualresultsfacet.
class NrdbResultContainer(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"current_results",
"embedded_chart_url",
"event_definitions",
"metadata",
"nrql",
"other_result",
"previous_results",
"query_progress",
"raw_response",
"results",
"static_chart_url",
"suggested_facets",
"suggested_queries",
"total_result",
)
current_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="currentResults"
)
embedded_chart_url = sgqlc.types.Field(
String,
graphql_name="embeddedChartUrl",
args=sgqlc.types.ArgDict(
(
(
"chart_type",
sgqlc.types.Arg(
EmbeddedChartType, graphql_name="chartType", default=None
),
),
)
),
)
"""Arguments:
* `chart_type` (`EmbeddedChartType`): The type of chart
visualization you want rendered. We will default to the best
fit for the provided NRQL query if omitted.
"""
event_definitions = sgqlc.types.Field(
sgqlc.types.list_of(EventDefinition), graphql_name="eventDefinitions"
)
metadata = sgqlc.types.Field(NrdbMetadata, graphql_name="metadata")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
other_result = sgqlc.types.Field(NrdbResult, graphql_name="otherResult")
previous_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="previousResults"
)
query_progress = sgqlc.types.Field(NrdbQueryProgress, graphql_name="queryProgress")
raw_response = sgqlc.types.Field(NrdbRawResults, graphql_name="rawResponse")
results = sgqlc.types.Field(sgqlc.types.list_of(NrdbResult), graphql_name="results")
static_chart_url = sgqlc.types.Field(
String,
graphql_name="staticChartUrl",
args=sgqlc.types.ArgDict(
(
(
"chart_type",
sgqlc.types.Arg(
ChartImageType, graphql_name="chartType", default=None
),
),
(
"format",
sgqlc.types.Arg(
ChartFormatType, graphql_name="format", default="PNG"
),
),
("height", sgqlc.types.Arg(Int, graphql_name="height", default=None)),
("width", sgqlc.types.Arg(Int, graphql_name="width", default=None)),
)
),
)
"""Arguments:
* `chart_type` (`ChartImageType`): The type of static chart
visualization you want rendered. We will default to the best
fit for the provided NRQL query if omitted.
* `format` (`ChartFormatType`): The type of static chart format
you want rendered. (default: `PNG`)
* `height` (`Int`): The height of static chart format you want
rendered.
* `width` (`Int`): The width of static chart format you want
rendered.
"""
suggested_facets = sgqlc.types.Field(
sgqlc.types.list_of("NrqlFacetSuggestion"), graphql_name="suggestedFacets"
)
suggested_queries = sgqlc.types.Field(
"SuggestedNrqlQueryResponse",
graphql_name="suggestedQueries",
args=sgqlc.types.ArgDict(
(
(
"anomaly_time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="anomalyTimeWindow", default=None
),
),
)
),
)
"""Arguments:
* `anomaly_time_window` (`TimeWindowInput`): The time window of a
specific anomaly in milliseconds since Epoch time.
"""
total_result = sgqlc.types.Field(NrdbResult, graphql_name="totalResult")823. NrqlCancelQueryMutationResponse¶
Results from calling the Cancel Query Mutation
Available fields:
queryId: Query ID of the query to be canceledrejectionReason: Message describing why the attempt to cancel a query in progress was not acceptedrequestStatus: Status of the request to cancel the query
class NrqlCancelQueryMutationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("query_id", "rejection_reason", "request_status")
query_id = sgqlc.types.Field(String, graphql_name="queryId")
rejection_reason = sgqlc.types.Field(String, graphql_name="rejectionReason")
request_status = sgqlc.types.Field(
NrqlCancelQueryMutationRequestStatus, graphql_name="requestStatus"
)824. NrqlDropRulesAccountStitchedFields¶
Available fields:
list: List the drop rules for the given account
class NrqlDropRulesAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("list",)
list = sgqlc.types.Field("NrqlDropRulesListDropRulesResult", graphql_name="list")825. NrqlDropRulesCreateDropRuleFailure¶
Error details about the rule that failed to be created and why.
Available fields:
error: Information about why the create failed.submitted: Input information about a submitted rule that was unable to be created.
class NrqlDropRulesCreateDropRuleFailure(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "submitted")
error = sgqlc.types.Field(
sgqlc.types.non_null("NrqlDropRulesError"), graphql_name="error"
)
submitted = sgqlc.types.Field(
sgqlc.types.non_null("NrqlDropRulesCreateDropRuleSubmission"),
graphql_name="submitted",
)826. NrqlDropRulesCreateDropRuleResult¶
The result of which submitted drop rules were successfully and unsuccessfully created.
Available fields:
failures: Rules that were not created and why.successes: Rules that were successfully created.
class NrqlDropRulesCreateDropRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failures", "successes")
failures = sgqlc.types.Field(
sgqlc.types.list_of(NrqlDropRulesCreateDropRuleFailure), graphql_name="failures"
)
successes = sgqlc.types.Field(
sgqlc.types.list_of("NrqlDropRulesDropRule"), graphql_name="successes"
)827. NrqlDropRulesCreateDropRuleSubmission¶
The details that were submitted when creating a drop rule.
Available fields:
accountId: The account the targeted data report to.action: The type of drop rule you want. This changes the way your NRQL string is interpreted.description: Additional information about the rule.nrql: The NRQL string used to match data you want to take the specified action on.
class NrqlDropRulesCreateDropRuleSubmission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "action", "description", "nrql")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
action = sgqlc.types.Field(
sgqlc.types.non_null(NrqlDropRulesAction), graphql_name="action"
)
description = sgqlc.types.Field(String, graphql_name="description")
nrql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="nrql")828. NrqlDropRulesDeleteDropRuleFailure¶
Error details about the rule that failed to be deleted and why.
Available fields:
error: Information about why the delete failed.submitted: Input information about on what was unable to be deleted.
class NrqlDropRulesDeleteDropRuleFailure(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "submitted")
error = sgqlc.types.Field(
sgqlc.types.non_null("NrqlDropRulesError"), graphql_name="error"
)
submitted = sgqlc.types.Field(
sgqlc.types.non_null("NrqlDropRulesDeleteDropRuleSubmission"),
graphql_name="submitted",
)829. NrqlDropRulesDeleteDropRuleResult¶
The result of which drop rules were successfully and unsuccessfully deleted.
Available fields:
failures: Rules that were not deleted and why.successes: Rules that were successfully deleted.
class NrqlDropRulesDeleteDropRuleResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("failures", "successes")
failures = sgqlc.types.Field(
sgqlc.types.list_of(NrqlDropRulesDeleteDropRuleFailure), graphql_name="failures"
)
successes = sgqlc.types.Field(
sgqlc.types.list_of("NrqlDropRulesDropRule"), graphql_name="successes"
)830. NrqlDropRulesDeleteDropRuleSubmission¶
The rules that were attempted to be deleted.
Available fields:
accountId: Account the rule was created on.ruleId: Id of the rule you want to delete.
class NrqlDropRulesDeleteDropRuleSubmission(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "rule_id")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
rule_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="ruleId")831. NrqlDropRulesDropRule¶
Details of a drop rule.
Available fields:
account: The account this drop rule targets.accountId: The account this drop rule targets.action: The behavior of the drop rule.createdAt: The time this drop rule was created.createdBy: The id of the user that created the drop rule.creator: The user reference of the user that created the drop ruledescription: Additional information about the rule.id: The unique id for the drop rule.name: The name of the pipeline cloud rule.nrql: The NRQL used to match data that will receive theaction.pipelineCloudRuleEntityId: The entityId associated with the pipeline cloud rule.source: Who or what registered this rule.
class NrqlDropRulesDropRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"account_id",
"action",
"created_at",
"created_by",
"creator",
"description",
"id",
"name",
"nrql",
"pipeline_cloud_rule_entity_id",
"source",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
action = sgqlc.types.Field(
sgqlc.types.non_null(NrqlDropRulesAction), graphql_name="action"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
created_by = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="createdBy")
creator = sgqlc.types.Field("UserReference", graphql_name="creator")
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
nrql = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="nrql")
pipeline_cloud_rule_entity_id = sgqlc.types.Field(
String, graphql_name="pipelineCloudRuleEntityId"
)
source = sgqlc.types.Field(String, graphql_name="source")832. NrqlDropRulesError¶
Error details when processing drop rule requests.
Available fields:
description: A detailed error message.reason: The category of error that occurred.
class NrqlDropRulesError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "reason")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
reason = sgqlc.types.Field(
sgqlc.types.non_null(NrqlDropRulesErrorReason), graphql_name="reason"
)833. NrqlDropRulesListDropRulesResult¶
The result of the request to list drop rules for an account.
Available fields:
error: Information about why we could not list rules.rules: The list of drop rules queried on the targeted account.
class NrqlDropRulesListDropRulesResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error", "rules")
error = sgqlc.types.Field(NrqlDropRulesError, graphql_name="error")
rules = sgqlc.types.Field(
sgqlc.types.list_of(NrqlDropRulesDropRule), graphql_name="rules"
)834. NrqlFacetSuggestion¶
A suggested NRQL facet. Facet suggestions may be either a single attribute, or a list of attributes in the case of multi-attribute facet suggestions.
Available fields:
attributes: A list of attribute names comprising the suggested facet.
Raw attribute names will be returned here. Attribute names may need to be backtick-quoted before inclusion in a NRQL query.
nrql: A modified version of the input NRQL, with aFACET ...clause appended. If the original NRQL had aFACETclause already, it will be replaced.
class NrqlFacetSuggestion(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attributes", "nrql")
attributes = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="attributes"
)
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")835. NrqlHistoricalQuery¶
An NRQL query executed in the past.
Available fields:
accountId: The Account ID queried.nrql: The NRQL query executed.timestamp: The time the query was executed.
class NrqlHistoricalQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "nrql", "timestamp")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
timestamp = sgqlc.types.Field(EpochSeconds, graphql_name="timestamp")836. Organization¶
The Organization object provides basic data about an organization.
Available fields:
accountManagement: This field provides access to AccountManagement data.accountShares: Namespace for querying and filtering the actor’s organization’s shared accountsadministrator: The organization’s administratoraiNotifications: This field provides access to AiNotifications data.authorizationManagement: This field provides access to AuthorizationManagement data.customerId: The customer id for the organization.dataManagement: This field provides access to DataManagement data.id: The ID of the organization.name: The name of the organization.nrqlQueryProgress: Poll for the results of a previously-executed asychronous NRDB query.
The queryId is available in the queryProgress data returned by the original asynchronous query.
See this page for additional asynchronous query documentation.
storageAccountId: The storage account of the organizationtelemetryId: The telemetry id for the organizationuserManagement: This field provides access to UserManagement data.workflowAutomation: This field provides access to WorkflowAutomation data.
class Organization(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_management",
"account_shares",
"administrator",
"ai_notifications",
"authorization_management",
"customer_id",
"data_management",
"id",
"name",
"nrql_query_progress",
"storage_account_id",
"telemetry_id",
"user_management",
"workflow_automation",
)
account_management = sgqlc.types.Field(
AccountManagementOrganizationStitchedFields, graphql_name="accountManagement"
)
account_shares = sgqlc.types.Field(
"OrganizationAccountShares",
graphql_name="accountShares",
args=sgqlc.types.ArgDict(
(
(
"limiting_role_id",
sgqlc.types.Arg(Int, graphql_name="limitingRoleId", default=None),
),
(
"source_organization_id",
sgqlc.types.Arg(
ID, graphql_name="sourceOrganizationId", default=None
),
),
(
"target_organization_id",
sgqlc.types.Arg(
ID, graphql_name="targetOrganizationId", default=None
),
),
)
),
)
"""Arguments:
* `limiting_role_id` (`Int`): Input for filtering by limiting role
id of a shared account.
* `source_organization_id` (`ID`): Input for filtering by source
organization id for a shared account.
* `target_organization_id` (`ID`): Input for filtering by target
organization id of a shared account.
"""
administrator = sgqlc.types.Field(
"OrganizationOrganizationAdministrator", graphql_name="administrator"
)
ai_notifications = sgqlc.types.Field(
AiNotificationsOrganizationStitchedFields, graphql_name="aiNotifications"
)
authorization_management = sgqlc.types.Field(
AuthorizationManagementOrganizationStitchedFields,
graphql_name="authorizationManagement",
)
customer_id = sgqlc.types.Field(String, graphql_name="customerId")
data_management = sgqlc.types.Field(
DataManagementOrganizationStitchedFields, graphql_name="dataManagement"
)
id = sgqlc.types.Field(ID, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
nrql_query_progress = sgqlc.types.Field(
"OrganizationNrdbResultContainer",
graphql_name="nrqlQueryProgress",
args=sgqlc.types.ArgDict(
(
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Int))
),
graphql_name="accounts",
default=None,
),
),
(
"query_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="queryId", default=None
),
),
)
),
)
"""Arguments:
* `accounts` (`[Int!]!`): List of account IDs associated with
`queryId`. Must match the account IDs of the original
asynchronous query. Max of 5 can be supplied.
* `query_id` (`ID!`): A token for retrieving the results of a
previously executed asynchronous query.
"""
storage_account_id = sgqlc.types.Field(Int, graphql_name="storageAccountId")
telemetry_id = sgqlc.types.Field(String, graphql_name="telemetryId")
user_management = sgqlc.types.Field(
"UserManagementOrganizationStitchedFields", graphql_name="userManagement"
)
workflow_automation = sgqlc.types.Field(
"WorkflowAutomationOrganizationStitchedFields",
graphql_name="workflowAutomation",
)837. OrganizationAccount¶
The account type contains the properties of an account
Available fields:
createdAt: The creation timeid: The account idname: The account nameparentId: The parent IDpartnershipId: The partnership IDpartnershipName: The partnership NamepayMethod: The pay methodregionCode: The account region codestatus: The status
class OrganizationAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"id",
"name",
"parent_id",
"partnership_id",
"partnership_name",
"pay_method",
"region_code",
"status",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
parent_id = sgqlc.types.Field(Int, graphql_name="parentId")
partnership_id = sgqlc.types.Field(Int, graphql_name="partnershipId")
partnership_name = sgqlc.types.Field(String, graphql_name="partnershipName")
pay_method = sgqlc.types.Field(String, graphql_name="payMethod")
region_code = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="regionCode"
)
status = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="status")838. OrganizationAccountCollection¶
Accounts
Available fields:
items: AccountsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class OrganizationAccountCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationAccount)),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)839. OrganizationAccountShare¶
An account share
Available fields:
accountId: The ID of the account being sharedid: The account share IDlimitingDataAccessPolicy: The limiting data access policy for the account share.limitingRole: The limiting rolename: The name of the account sharesource: The organization sending the account share.target: The organization receiving the account share.
class OrganizationAccountShare(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"id",
"limiting_data_access_policy",
"limiting_role",
"name",
"source",
"target",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
limiting_data_access_policy = sgqlc.types.Field(
"OrganizationAccountShareLimitingDataAccessPolicyWrapper",
graphql_name="limitingDataAccessPolicy",
)
limiting_role = sgqlc.types.Field(
sgqlc.types.non_null("OrganizationAccountShareLimitingRoleWrapper"),
graphql_name="limitingRole",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
source = sgqlc.types.Field(
sgqlc.types.non_null("OrganizationAccountShareOrganizationWrapper"),
graphql_name="source",
)
target = sgqlc.types.Field(
sgqlc.types.non_null("OrganizationAccountShareOrganizationWrapper"),
graphql_name="target",
)840. OrganizationAccountShareCollection¶
An organization’s shared accounts, both given and received.
Available fields:
items: An organization’s shared accounts, both given and received.nextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationAccountShareCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationAccountShare)),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")841. OrganizationAccountShareLimitingDataAccessPolicyWrapper¶
An account share’s limiting data access policy
Available fields:
id: id
class OrganizationAccountShareLimitingDataAccessPolicyWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")842. OrganizationAccountShareLimitingRoleWrapper¶
An account share’s limiting role
Available fields:
id: id
class OrganizationAccountShareLimitingRoleWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")843. OrganizationAccountShareOrganizationWrapper¶
An account share’s source or target organization
Available fields:
id: idname: name
class OrganizationAccountShareOrganizationWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(ID, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")844. OrganizationAccountShares¶
An organization’s shared accounts, both given and received.
Available fields:
sharedAccounts: An organization’s shared accounts, both given and received.
class OrganizationAccountShares(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("shared_accounts",)
shared_accounts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("OrganizationSharedAccount")),
graphql_name="sharedAccounts",
)845. OrganizationAuthenticationDomain¶
A grouping of users governed by the same user management settings
Available fields:
authenticationType: Method of authenticating usersid: The authentication domain idname: The authentication domain nameorganizationId: The organization the authentication domain belongs toprovisioningType: Method of provisioning users
class OrganizationAuthenticationDomain(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"authentication_type",
"id",
"name",
"organization_id",
"provisioning_type",
)
authentication_type = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationAuthenticationTypeEnum),
graphql_name="authenticationType",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
provisioning_type = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationProvisioningTypeEnum),
graphql_name="provisioningType",
)846. OrganizationAuthenticationDomainCollection¶
Authentication domains
Available fields:
items: Authentication domainsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationAuthenticationDomainCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationAuthenticationDomain))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")847. OrganizationCreateOrganizationResponse¶
The object that’s returned from successfully creating an organization.
Available fields:
jobId: The job id of the organization creation task; query this job id to get latest state
class OrganizationCreateOrganizationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("job_id",)
job_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="jobId")848. OrganizationCreateSharedAccountResponse¶
The object that’s returned from successfully creating a shared account.
Available fields:
sharedAccount: The created shared account.
class OrganizationCreateSharedAccountResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("shared_account",)
shared_account = sgqlc.types.Field(
"OrganizationSharedAccount", graphql_name="sharedAccount"
)849. OrganizationCustomerContract¶
A customer
Available fields:
billingStructure: The customer contract’'s billing structurecustomerId: The customers idid: The customer contracts IDorganizationGroups: The customer contracts organization groupstelemetryId: The customer contracts’'s telemetry id
class OrganizationCustomerContract(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"billing_structure",
"customer_id",
"id",
"organization_groups",
"telemetry_id",
)
billing_structure = sgqlc.types.Field(
OrganizationBillingStructure, graphql_name="billingStructure"
)
customer_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="customerId"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
organization_groups = sgqlc.types.Field(
sgqlc.types.non_null("OrganizationOrganizationGroupWrapper"),
graphql_name="organizationGroups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
OrganizationOrganizationGroupFilterInput,
graphql_name="filter",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`OrganizationOrganizationGroupFilterInput`): The
filter
"""
telemetry_id = sgqlc.types.Field(String, graphql_name="telemetryId")850. OrganizationCustomerContractWrapper¶
Accessible customers
Available fields:
items: Accessible customersnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationCustomerContractWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationCustomerContract))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")851. OrganizationCustomerOrganization¶
A customer organization
Available fields:
contractId: The ID of the organization groupcustomerId: The ID of the customerid: The ID of the organizationname: The name of the organizationstorageAccountId: The ID of the organization storage account
class OrganizationCustomerOrganization(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("contract_id", "customer_id", "id", "name", "storage_account_id")
contract_id = sgqlc.types.Field(ID, graphql_name="contractId")
customer_id = sgqlc.types.Field(String, graphql_name="customerId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
storage_account_id = sgqlc.types.Field(Int, graphql_name="storageAccountId")852. OrganizationCustomerOrganizationWrapper¶
A customer organization
Available fields:
items: Accessible customersnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationCustomerOrganizationWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationCustomerOrganization))
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")853. OrganizationError¶
A user-readable error
Available fields:
message: A description of the error.type: A description of the type of error.
class OrganizationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationUpdateErrorType), graphql_name="type"
)854. OrganizationInformation¶
The attributes of an organization.
Available fields:
id: The ID of the organization.name: The name of the organization.
class OrganizationInformation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")855. OrganizationMembersOrganizationMember¶
A member of an organization
Available fields:
id: The unique identifier for the Organization Membername: The name of the Organization Membertype: The type of the Organization Member
class OrganizationMembersOrganizationMember(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
type = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationMembersOrganizationMemberType),
graphql_name="type",
)856. OrganizationMembersOrganizationMemberCollection¶
A collection of Organization Members
Available fields:
items: The list of Organization MembersnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of results
class OrganizationMembersOrganizationMemberCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(OrganizationMembersOrganizationMember)
)
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")857. OrganizationNrdbResultContainer¶
A data structure that contains the results of the multi account NRDB query along with other capabilities that enhance those results.
Direct query results are available through results, totalResult and
otherResult. The query you made is accessible through nrql, along with
metadata about the query itself.
Available fields:
currentResults: In aCOMPARE WITHquery, thecurrentResultscontain the results for the current comparison time window.metadata: Metadata about the query and result.nrql: The NRQL query that was executed to yield these results.otherResult: In aFACETquery, theotherResultcontains the aggregates representing the events not contained in an individualresultsfacet.previousResults: In aCOMPARE WITHquery, thepreviousResultscontain the results for the previous comparison time window.queryProgress: Metadata about the execution of an asynchronous NRQL query.rawResponse: The raw query results exactly as they are returned from NRDB. NerdGraph provides no additional transformation.results: The query results. This is a flat list of objects who’s structure matches the query submitted.totalResult: In aFACETquery, thetotalResultcontains the aggregates representing all the events, whether or not they are contained in an individualresultsfacet.
class OrganizationNrdbResultContainer(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"current_results",
"metadata",
"nrql",
"other_result",
"previous_results",
"query_progress",
"raw_response",
"results",
"total_result",
)
current_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="currentResults"
)
metadata = sgqlc.types.Field(NrdbMetadata, graphql_name="metadata")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
other_result = sgqlc.types.Field(NrdbResult, graphql_name="otherResult")
previous_results = sgqlc.types.Field(
sgqlc.types.list_of(NrdbResult), graphql_name="previousResults"
)
query_progress = sgqlc.types.Field(NrdbQueryProgress, graphql_name="queryProgress")
raw_response = sgqlc.types.Field(NrdbRawResults, graphql_name="rawResponse")
results = sgqlc.types.Field(sgqlc.types.list_of(NrdbResult), graphql_name="results")
total_result = sgqlc.types.Field(NrdbResult, graphql_name="totalResult")858. OrganizationOrganizationAdministrator¶
The organization’s administrator
Available fields:
organizationId: The organization id of the organization’s administratororganizationName: The organization name of the organization’s administrator
class OrganizationOrganizationAdministrator(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("organization_id", "organization_name")
organization_id = sgqlc.types.Field(ID, graphql_name="organizationId")
organization_name = sgqlc.types.Field(String, graphql_name="organizationName")859. OrganizationOrganizationCreateAsyncCustomerResult¶
An async organization creation result customer
Available fields:
customerId: The customer ID
class OrganizationOrganizationCreateAsyncCustomerResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("customer_id",)
customer_id = sgqlc.types.Field(String, graphql_name="customerId")860. OrganizationOrganizationCreateAsyncJobResult¶
An async organization creation job result
Available fields:
createdUtc: The date and time the job was created in UTCerrorMessage: The error message in case of job failurefinishedUtc: The date and time the job was completed in UTCid: The id of the jobstatus: The status of the job
class OrganizationOrganizationCreateAsyncJobResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_utc", "error_message", "finished_utc", "id", "status")
created_utc = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="createdUtc"
)
error_message = sgqlc.types.Field(String, graphql_name="errorMessage")
finished_utc = sgqlc.types.Field(String, graphql_name="finishedUtc")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
status = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationOrganizationCreateJobResultStatusEnum),
graphql_name="status",
)861. OrganizationOrganizationCreateAsyncOrganizationResult¶
An async organization creation result organization
Available fields:
id: Organization IDname: Organization name
class OrganizationOrganizationCreateAsyncOrganizationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(ID, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")862. OrganizationOrganizationCreateAsyncResult¶
An async organization creation result
Available fields:
customer: Organization Creation Async Job Customerjob: Organization Creation Async Job Resultorganization: Organization Creation Async Job Organization
class OrganizationOrganizationCreateAsyncResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("customer", "job", "organization")
customer = sgqlc.types.Field(
OrganizationOrganizationCreateAsyncCustomerResult, graphql_name="customer"
)
job = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationOrganizationCreateAsyncJobResult),
graphql_name="job",
)
organization = sgqlc.types.Field(
OrganizationOrganizationCreateAsyncOrganizationResult,
graphql_name="organization",
)863. OrganizationOrganizationCreateAsyncResultCollection¶
Organization create async result collection
Available fields:
items: Organization create async resultsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationOrganizationCreateAsyncResultCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(OrganizationOrganizationCreateAsyncResult)
)
),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")864. OrganizationOrganizationGroup¶
A customers organization group
Available fields:
id: The ID of the organization groupname: The name of the organization group
class OrganizationOrganizationGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")865. OrganizationOrganizationGroupWrapper¶
A customers organization groups
Available fields:
items: A customers organization groupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pages
class OrganizationOrganizationGroupWrapper(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor")
items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationOrganizationGroup)),
graphql_name="items",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")866. OrganizationProvisioningUpdateSubscriptionResult¶
Result of subscription update
Available fields:
enqueued: Status of enqueuing update in subscription change serviceerrors: Error message from enqueuing update in subscription change service
class OrganizationProvisioningUpdateSubscriptionResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enqueued", "errors")
enqueued = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enqueued")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("OrganizationProvisioningUserError")
)
),
graphql_name="errors",
)867. OrganizationProvisioningUserError¶
A user-readable error
Available fields:
message: A description of the errorpath: Which input value this error came from
class OrganizationProvisioningUserError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "path")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
path = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="path"
)868. OrganizationRevokeSharedAccountResponse¶
The object that’s returned from successfully revoking a shared account.
Available fields:
sharedAccount: Information about the revoked shared account.
class OrganizationRevokeSharedAccountResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("shared_account",)
shared_account = sgqlc.types.Field(
"OrganizationSharedAccount", graphql_name="sharedAccount"
)869. OrganizationSharedAccount¶
The attributes of an account share.
Available fields:
accountId: The ID of the account being shared.id: The ID of the account share.limitingDataAccessPolicyId: The ID of the limiting data access policy for the account share.limitingRoleId: The ID of the limiting role for the account share.name: The name of the account share.sourceOrganizationId: The ID of the organization sending the account share.sourceOrganizationName: The name of the organization sending the account share.targetOrganizationId: The ID of the organization receiving the account share.targetOrganizationName: The name of the organization receiving the account share.
class OrganizationSharedAccount(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"id",
"limiting_data_access_policy_id",
"limiting_role_id",
"name",
"source_organization_id",
"source_organization_name",
"target_organization_id",
"target_organization_name",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
limiting_data_access_policy_id = sgqlc.types.Field(
ID, graphql_name="limitingDataAccessPolicyId"
)
limiting_role_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="limitingRoleId"
)
name = sgqlc.types.Field(String, graphql_name="name")
source_organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="sourceOrganizationId"
)
source_organization_name = sgqlc.types.Field(
String, graphql_name="sourceOrganizationName"
)
target_organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="targetOrganizationId"
)
target_organization_name = sgqlc.types.Field(
String, graphql_name="targetOrganizationName"
)870. OrganizationUpdateResponse¶
The return object for an update mutation.
Available fields:
errors: A description of any errors with the mutation.organizationInformation: Information about the updated organization.
class OrganizationUpdateResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "organization_information")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(OrganizationError))
),
graphql_name="errors",
)
organization_information = sgqlc.types.Field(
OrganizationInformation, graphql_name="organizationInformation"
)871. OrganizationUpdateSharedAccountResponse¶
The object that’s returned from successfully updating a shared account.
Available fields:
sharedAccount: Information about the updated shared account.
class OrganizationUpdateSharedAccountResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("shared_account",)
shared_account = sgqlc.types.Field(
OrganizationSharedAccount, graphql_name="sharedAccount"
)872. PixieAccountStitchedFields¶
Available fields:
linkedPixieProject: Details for the linked Pixie projectpixieAccessToken: Get a Pixie access token
class PixieAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("linked_pixie_project", "pixie_access_token")
linked_pixie_project = sgqlc.types.Field(
"PixiePixieProject", graphql_name="linkedPixieProject"
)
pixie_access_token = sgqlc.types.Field(SecureValue, graphql_name="pixieAccessToken")873. PixieActorStitchedFields¶
Available fields:
linkedPixieProjects: Details for the linked Pixie projects
class PixieActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("linked_pixie_projects",)
linked_pixie_projects = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("PixieLinkedPixieProject")),
graphql_name="linkedPixieProjects",
)874. PixieLinkPixieProjectError¶
An error object for linking a Pixie project.
Available fields:
message: A message explaining what the error is about.type: The type of error.
class PixieLinkPixieProjectError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(PixieLinkPixieProjectErrorType, graphql_name="type")875. PixieLinkPixieProjectResult¶
The response returned when linking a Pixie project to a New Relic account
Available fields:
errors: An array containing errors, if any.linkedPixieProject: The Pixie project details that were linked. This will be null for unlinkAccount.success: Whether the linking succeeded or not. Check the “errors” list for details
class PixieLinkPixieProjectResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "linked_pixie_project", "success")
errors = sgqlc.types.Field(
sgqlc.types.list_of(PixieLinkPixieProjectError), graphql_name="errors"
)
linked_pixie_project = sgqlc.types.Field(
"PixiePixieProject", graphql_name="linkedPixieProject"
)
success = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="success")876. PixieLinkedPixieProject¶
Pixie Project with the New Relic account
Available fields:
accountId: The New Relic account idpixieProject: The linked Pixie Project
class PixieLinkedPixieProject(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_id", "pixie_project")
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
pixie_project = sgqlc.types.Field(
sgqlc.types.non_null("PixiePixieProject"), graphql_name="pixieProject"
)877. PixiePixieProject¶
Pixie Project keys linked to a New Relic account
Available fields:
apiKey: Pixie API keydeployKey: Pixie Deploy key
class PixiePixieProject(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("api_key", "deploy_key")
api_key = sgqlc.types.Field(SecureValue, graphql_name="apiKey")
deploy_key = sgqlc.types.Field(SecureValue, graphql_name="deployKey")878. PixieRecordPixieTosAcceptanceError¶
An error object for recording the Pixie terms of service acceptance
Available fields:
message: A message explaining what the error is about.type: The type of error.
class PixieRecordPixieTosAcceptanceError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(
PixieRecordPixieTosAcceptanceErrorType, graphql_name="type"
)879. PixieRecordPixieTosAcceptanceResult¶
The reponse returned when record the acceptance of the Pixie terms of service on a given account
Available fields:
errors: An array containings errors, if any.success: Whether the Pixie terms of service acceptance was successfully recorded or not.
class PixieRecordPixieTosAcceptanceResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "success")
errors = sgqlc.types.Field(
sgqlc.types.list_of(PixieRecordPixieTosAcceptanceError), graphql_name="errors"
)
success = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="success")880. QueryHistoryActorStitchedFields¶
Type defined so its fields will be merged directly into NerdGraph’s actor type.
Available fields:
nrql: List of records of the query history for the current user.
class QueryHistoryActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql",)
nrql = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("QueryHistoryNrqlHistoryResult")),
graphql_name="nrql",
args=sgqlc.types.ArgDict(
(
(
"options",
sgqlc.types.Arg(
QueryHistoryQueryHistoryOptionsInput,
graphql_name="options",
default=None,
),
),
)
),
)
"""Arguments:
* `options` (`QueryHistoryQueryHistoryOptionsInput`): Input
options to select query records.
"""881. QueryHistoryNrqlHistoryResult¶
Represents the result of the query history record.
Available fields:
accountIds: List of cross accounts where the query is executed.createdAt: The time the query was created as an ISO8601 formatted string.query: Query executed.
class QueryHistoryNrqlHistoryResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids", "created_at", "query")
account_ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(Int)), graphql_name="accountIds"
)
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
query = sgqlc.types.Field(Nrql, graphql_name="query")882. ReferenceEntityCreateRepositoryError¶
Type that wraps the errors from a entity create operation.
Available fields:
guid: Guid related to the error.message: User-friendly message describing the error.type: Describes all potential error types that a create operation might return.
class ReferenceEntityCreateRepositoryError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid", "message", "type")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")
type = sgqlc.types.Field(
sgqlc.types.non_null(ReferenceEntityCreateRepositoryErrorType),
graphql_name="type",
)883. ReferenceEntityCreateRepositoryResult¶
Response type for create operations over entities.
Available fields:
created: The list of entities guids that have been created correctly.failures: List of failures for the create operation.updated: The list of entities guids that have been updated correctly.
class ReferenceEntityCreateRepositoryResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created", "failures", "updated")
created = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))),
graphql_name="created",
)
failures = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(ReferenceEntityCreateRepositoryError)
)
),
graphql_name="failures",
)
updated = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))),
graphql_name="updated",
)884. RequestContext¶
This object exposes contextual information about an API request.
Available fields:
userId: The id of the user making this request
class RequestContext(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("user_id",)
user_id = sgqlc.types.Field(ID, graphql_name="userId")885. RootMutationType¶
This is the root of all GraphQL mutations. Unlike queries, mutations
represent actions that have a side effects, like create or update.
Available fields:
accountManagementCancelAccount: Cancels an account.accountManagementCreateAccount: Creates an organization-scoped account.accountManagementUpdateAccount: Updates an account.agentApplicationAddAppToEntityPlatform: Reindex Application that already exists in systemagentApplicationCreateBrowser: If you aren’t using an auto-instrumenting agent on the backend, use this to set up browser monitoring for an application. For more information on enabling copy/paste, see our docsagentApplicationCreateMobile: Create a new mobile application.agentApplicationDelete: Deletes a browser, mobile, or APM application. This isn’t allowed if an application is actively reporting data.agentApplicationEnableApmBrowser: Enable browser monitoring for an application monitored by APM. For information about specific APM agents, see our docsagentApplicationSegmentsReplaceAllBrowserSegmentAllowList: Replaces the entity’s allow list with the provided segments.agentApplicationSettingsUpdate: Update configuration for APM applications. Includes thresholds for how often to record Transaction traces, SQL traces, enabling Distributed traces, ignoring certain error classes. This is the main mutation that powers the Application > Settings page in APM.aiDecisionsAcceptSuggestion: Accept and deploy an existing suggested rule.aiDecisionsCreateImplicitRule: Create and deploy a new implicit rule.aiDecisionsCreateRule: Create and deploy a new rule.aiDecisionsCreateSuggestion: Create a new suggested rule.aiDecisionsDeclineSuggestion: Decline an existing suggested rule.aiDecisionsDeleteMergeFeedback: Delete existing feedback for a merge.aiDecisionsDeleteRule: Delete an existing rule.aiDecisionsDeleteSuggestion: Delete an existing suggested rule.aiDecisionsDisableRule: Disable an existing enabled rule.aiDecisionsEnableRule: Enable an existing disabled rule.aiDecisionsFindApplicableIncidents: Create a search operation to fetch applicable incidents for a rule expressionaiDecisionsPostponeSuggestion: Postpone an existing suggested rule.aiDecisionsRecordMergeFeedback: Record feedback for a mergeaiDecisionsSimulate: Create an arbitrary expression simulation.aiDecisionsUpdateImplicitRule: Update an existing implicit rule.aiDecisionsUpdateRule: Update an existing rule.aiIssuesAckIssue: Acknowledge issueaiIssuesCloseIncident: Close incidentaiIssuesResolveIssue: Resolve issueaiIssuesUnackIssue: Unacknowledge issueaiIssuesUpdateGracePeriod: Set interval between issue being created and being activated (and user being notified)aiIssuesUpdateIssueTtl: Update issue TTLaiNotificationsCreateChannel: Create a ChannelaiNotificationsCreateDestination: Create a DestinationaiNotificationsDeleteChannel: Delete a ChannelaiNotificationsDeleteDestination: Delete a DestinationaiNotificationsTestChannel: Test notificationsaiNotificationsTestChannelById: Test channel by channelIdaiNotificationsTestDestination: Test connectionaiNotificationsTestDestinationById: Test connection by destination idaiNotificationsUpdateChannel: Update a ChannelaiNotificationsUpdateDestination: Update a DestinationaiWorkflowsCreateWorkflow: Create a new Workflow with issues filter, enrichments and destinationsaiWorkflowsDeleteWorkflow: Delete a workflow and all it’s sub entities: filter, enrichments and destinationsaiWorkflowsTestWorkflow: test a workflow and all it’s sub entities: filter, enrichments and destinationsaiWorkflowsUpdateWorkflow: Update Workflow with issues filter, enrichments and destinationsalertsConditionDelete: Delete an Alerts condition.alertsMutingRuleCreate: Create a muting rule for New Relic Alerts violations.alertsMutingRuleDelete: Delete a muting rule for New Relic Alerts violations.alertsMutingRuleUpdate: Update a muting rule for New Relic Alerts violations.alertsNrqlConditionBaselineCreate: Create a baseline NRQL condition.alertsNrqlConditionBaselineUpdate: Update a baseline NRQL condition.alertsNrqlConditionStaticCreate: Create a static NRQL condition.alertsNrqlConditionStaticUpdate: Update a static NRQL condition.alertsPolicyCreate: Create an Alerts policy.alertsPolicyDelete: Delete an Alerts policy. This archives all conditions associated to the policy.alertsPolicyUpdate: Update an Alerts policy.alertsUpdateCrossAccountElection: Update the cross-account election status for the specified account.alertsUpdateCrossAccountElections: Update the cross-account election status for the specified accounts.apiAccessCreateKeys: Create keys. You can create keys for multiple accounts at once. You can read more about managing keys on this documentation page.apiAccessDeleteKeys: A mutation to delete keys.apiAccessUpdateKeys: Update keys. You can update keys for multiple accounts at once. You can read more about managing keys on this documentation page.authenticationDomainDelete: Delete an authentication domainauthorizationManagementGrantAccess: Grant access to a Group, User, System Identity, System Identity Group, or OrganizationauthorizationManagementRevokeAccess: Revoke access for a groupauthorizationManagementUpdateAccess: Update access grantschangeTrackingCreateDeployment: Creates a new deployment record in NRDB and its associated deployment marker.changeTrackingCreateEvent: Coming soon! If you’d like to sign up to receive access to our Public Preview, you can sign up under Administration -> Previews & Trial.
US, AMEA, LATAM: Sign Up Here EU: Sign Up Here
Creates a new change tracking event in NRDB and its associated marker.
cloudConfigureIntegration: Create or modify a cloud integration.
For details and mutation examples visit our docs.
cloudDisableIntegration: Disable a cloud integration. Stops collecting data for the specified integration.
For details and mutation examples visit our docs.
cloudLinkAccount: Link a cloud provider account to a New Relic Account.
For details and mutation examples visit our docs.
cloudMigrateAwsGovCloudToAssumeRole: Migrate one or more existing AWS GovCloud Accounts to use AssumeRole authentication.
For details and mutation examples visit our docs.
cloudOciGenerateInstrumentedPayloadUrl: OCI ProvidercloudOciGenerateLogGroupInstrumentedPayloadUrl: OCI ProvidercloudRenameAccount: Rename one or more linked cloud provider accounts.
For details and mutation examples visit our docs.
cloudUnlinkAccount: Unlink one or more cloud provider accounts. Stops collecting data for all the associated integrations.
For details and mutation examples visit our docs.
cloudUpdateAccount: Update one or more Cloud Provider accounts to a NewRelic account. Updates each Linked account with the passed parameters.collaborationCreateCodeMark: Create code markcollaborationCreateComment: Create a new comment on a threadcollaborationCreateContext: Create a contextcollaborationCreateEmail: Create a new email address to mentioncollaborationCreateExternalServiceConnection: Create an external service connectioncollaborationCreateMention: Create a new mentioncollaborationCreateThread: Create a new threadcollaborationDeactivateCodeMark: deactivates code markcollaborationDeactivateComment: Deactivate a commentcollaborationDeactivateContext: Deactivate a contextcollaborationDeactivateExternalServiceConnection: Deactivate an external service connectioncollaborationDeactivateFile: Deactivate a filecollaborationDeactivateMention: Deactivate a mentioncollaborationDeactivateThread: Deactivate a threadcollaborationFeedbackOnBotResponse: Rate a bot reponsecollaborationGetUploadUrl: Upload a new filecollaborationRegisterEmail: Register the current user’s email and map it to any mentionscollaborationSendMessage: Send a message without a threadcollaborationSetExternalServiceConnectionChannel: Set the channel of the external service connectioncollaborationSocketSubscribe: Subscribe your websocket to one or more subscriptionKeyscollaborationSubscribeToThread: Subscribe to a threadcollaborationUnsubscribeFromThread: Unsubscribe from a threadcollaborationUpdateComment: Update a commentcollaborationUpdateContextAddComment: Add a comment to the context’s comment countcollaborationUpdateContextAddThread: Add a thread to a context’s thread countcollaborationUpdateSubscriptionReadInfo: Update unread counts for a subscriptioncollaborationUpdateThreadAddComment: Update a thread with a new commentcollaborationUpdateThreadStatus: Update a thread’s statuscustomRoleCreate: Create a new custom role at a specified authorization scopecustomRoleDelete: Delete an existing custom rolecustomRoleUpdate: Update an existing custom role’s name or permissionsdashboardAddWidgetsToPage: Add widgets to aDashboardPagedashboardCreate: Create aDashboardEntitydashboardCreateLiveUrl: Creates a public Live URL where aDashboardEntitywill show data changes in real time.dashboardCreateSnapshotUrl: Creates a public URL where aDashboardPagecan be accessed in the form of a static snapshot.dashboardDelete: Delete an existingDashboardEntitydashboardResetLiveUrlPassword: Resets the password of a created public Live URLdashboardRevokeLiveUrl: Revokes aDashboardEntitypublic live URLdashboardUndelete: Undelete aDashboardEntitythat was previously deleted.dashboardUpdate: Update an existingDashboardEntitydashboardUpdateLiveUrl: Updates a created public Live URLdashboardUpdateLiveUrlAuth: Updates the auth policies of a created public Live URLdashboardUpdateLiveUrlCreationPolicies: Set the live url creation policies for a list of accounts.dashboardUpdatePage: Update a page in a dashboard.dashboardUpdateWidgetsInPage: Update an existing set ofWidgets in aDashboardPagedashboardWidgetRevokeLiveUrl: Revokes aDashboardWidgetpublic live URL that was created in advance.dataAccessPolicyCreate: Creates a new data access policy.dataAccessPolicyDelete: Deletes an existing data access policy.dataAccessPolicyUpdate: Updates an existing data access policy.dataManagementCopyRetentions: Bulk copy account rules to list of accountsdataManagementCreateAccountLimit: Create a new account limitdataManagementCreateEventRetentionRule: Create a new event retention rule for a namespace on an accountdataManagementCreateOrganizationLimit: Create a new organization limitdataManagementCreateRetentionRules: Create event retention rules for namespacesdataManagementDeleteEventRetentionRule: Delete the event retention rule for a namespace on an account, if it existsdataManagementExpireOrganizationLimit: Expire an organization limitdataManagementUpdateFeatureSettings: Mutation to add and change a feature setting toggle for an accountedgeCreateTraceFilterRules: Create one or more trace filter rules, as defined by theCreateTraceFilterRulesInput.edgeCreateTraceObserver: Create one or more trace observers, as defined by theCreateTraceObserverInput. Currently, only one trace observer can be created per provider region.edgeDeleteTraceFilterRules: Delete one or more trace filter rules, as defined by theDeleteTraceFilterRulesInput.edgeDeleteTraceObserversedgeUpdateTraceObservers: Update one or more trace observers, as defined by theUpdateTraceObserverInput.entityDelete: Delete an entityentityGoldenMetricsOverride: Override the default golden metrics given an account or a collection guid. Only use one contextentityGoldenMetricsReset: Reset the default golden metrics given an account or a collection guid. Only use one contextentityGoldenTagsOverride: Override the default tags given an account or a collection guid. Only use one contextentityGoldenTagsReset: Reset the default tags given an account or a collection guid. Only use one contextentityManagementAddCollectionMembers: Adds entities to a collection. Returns the list of ids corresponding to the entities effectively added to the collection.entityManagementCreateAiAgent: Creates an entity of type AiAgentEntity.entityManagementCreateAiTool: Creates an entity of type AiToolEntity.entityManagementCreateCollection: Creates an entity of type CollectionEntity.entityManagementCreateConfluenceIntegration: Creates an entity of type ConfluenceIntegration.entityManagementCreateConfluenceRagSettings: Creates an entity of type ConfluenceRagSettingsEntity.entityManagementCreateGitRepository: Creates an entity of type GitRepositoryEntity.entityManagementCreateImpactProfile: Creates an entity of type ImpactProfileEntity.entityManagementCreateInboxIssueCategory: Creates an entity of type InboxIssueCategoryEntity.entityManagementCreateIncidentLink: Creates an entity of type IncidentLinkEntity.entityManagementCreateIncidentTimeline: Creates an entity of type IncidentTimelineEntity.entityManagementCreateMcpServer: Creates an entity of type McpServerEntity.entityManagementCreatePipelineCloudRule: Creates an entity of type PipelineCloudRuleEntity.entityManagementCreateRagTool: Creates an entity of type RagToolEntity.entityManagementCreateRelationship: Creates an entity relationship.entityManagementCreateScorecard: Creates an entity of type ScorecardEntity.entityManagementCreateScorecardRule: Creates an entity of type ScorecardRuleEntity.entityManagementCreateTeam: Creates an entity of type TeamEntity.entityManagementDelete: Deletes an entity.entityManagementDeleteRelationship: Deletes an entity relationship.entityManagementRemoveCollectionMembers: Removes entities from a collection. Returns the list of ids corresponding to the entities effectively removed from the collection.entityManagementUpdate: Updates a generic entity.entityManagementUpdateAiAgent: Updates an entity of type AiAgentEntity.entityManagementUpdateAiTool: Updates an entity of type AiToolEntity.entityManagementUpdateCollection: Updates an entity of type CollectionEntity.entityManagementUpdateConfluenceIntegration: Updates an entity of type ConfluenceIntegration.entityManagementUpdateConfluenceRagSettings: Updates an entity of type ConfluenceRagSettingsEntity.entityManagementUpdateGitRepository: Updates an entity of type GitRepositoryEntity.entityManagementUpdateImpactProfile: Updates an entity of type ImpactProfileEntity.entityManagementUpdateInboxIssueCategory: Updates an entity of type InboxIssueCategoryEntity.entityManagementUpdateIncidentLink: Updates an entity of type IncidentLinkEntity.entityManagementUpdateIncidentTimeline: Updates an entity of type IncidentTimelineEntity.entityManagementUpdateMcpServer: Updates an entity of type McpServerEntity.entityManagementUpdatePipelineCloudRule: Updates an entity of type PipelineCloudRuleEntity.entityManagementUpdateRagTool: Updates an entity of type RagToolEntity.entityManagementUpdateRelationship: Updates a relationship.entityManagementUpdateScorecard: Updates an entity of type ScorecardEntity.entityManagementUpdateScorecardRule: Updates an entity of type ScorecardRuleEntity.entityManagementUpdateTeam: Updates an entity of type TeamEntity.entityManagementUpdateTeamsHierarchyLevel: Updates an entity of type TeamsHierarchyLevelEntity.entityManagementUpdateTeamsOrganizationSettings: Updates an entity of type TeamsOrganizationSettingsEntity.entityRelationshipUserDefinedCreateOrReplace: Create a relationship between entities.entityRelationshipUserDefinedDelete: Delete a relationship between entities. If no type is provided, it will delete all relationships between source and target.errorsInboxAssignErrorGroup: Assigns a user to an error grouperrorsInboxDeleteErrorGroupResource: Removes a resource from an error group.errorsInboxUpdateErrorGroupState: Updates the states of error groups.eventsToMetricsCreateRule: Create a new rule which will make metrics from event data.eventsToMetricsDeleteRule: Delete an event-to-metric rule.eventsToMetricsUpdateRule: Enable or disable an event-to-metric rule.fleetControlAddFleetMembers: Adds managed entities to a fleetfleetControlCreateFleet: Create a fleet entityfleetControlCreateFleetDeployment: Creates the fleet deploymentfleetControlDeleteFleet: Deletes the fleetfleetControlDeleteFleetDeployment: Deletes the fleet deploymentfleetControlDeploy: Triggers the deploymentfleetControlRemoveFleetMembers: Removes managed entities from a fleetfleetControlUpdateFleet: Updates the fleet detailsfleetControlUpdateFleetDeployment: Updates the fleet deploymenthistoricalDataExportCancelExport: Cancel a historic exporthistoricalDataExportCreateExport: Create a historic exportincidentIntelligenceEnvironmentConsentAccounts: Consent accounts to usage of the Incident Intelligence product in the EU or FedRAMPincidentIntelligenceEnvironmentConsentAuthorizedAccounts: Consent all of the user’s authorized accountsincidentIntelligenceEnvironmentDeleteEnvironment: Deletes an existing environmentincidentIntelligenceEnvironmentDissentAccounts: Dissent accounts to usage of the Incident Intelligence product in the EU or FedRAMP (removes the consent marking)installationCreateInstallStatus: Creates a new install status. An install status is created on behalf of the newrelic-cli whenever the CLI has started an installation and completed an installation.
Guided install: https://
installationCreateRecipeEvent: Creates a new recipe event.
A recipe event is created on behalf of the newrelic-cli whenever the CLI attempts to install the infrastructure-agent, for example.
A recipe event is appended to any existing recipe events, if there are any present in the cache.
Guided install: https://
installationDeleteInstall: Deletes an installation status and all recipe statuses given the accountId.integrationServicesServiceNowInstallation: Creates a ServiceNow installation entity using the provided input.integrationServicesServiceNowUpdate: Updates a ServiceNow entity using the provided input.keyTransactionCreate: Creates a key transaction.keyTransactionDelete: Deletes a key transaction (historical data is not removed).keyTransactionUpdate: Update a key transaction.logConfigurationsCreateDataPartitionRule: Create a new data partition rule.logConfigurationsCreateObfuscationExpression: Create an obfuscation expression.logConfigurationsCreateObfuscationRule: Create an obfuscation rule.logConfigurationsCreateParsingRule: Create a new parsing rule.logConfigurationsDeleteDataPartitionRule: Delete an existing data partition rule. This operation will result in data to be allocated in the main NRDB storage (Log) if no other data partition rule exists intercepting the logs matching this rule. A deleted data partition rule can be recreated using the same name.logConfigurationsDeleteObfuscationExpression: Delete an obfuscation expression.logConfigurationsDeleteObfuscationRule: Delete an obfuscation rule.logConfigurationsDeleteParsingRule: Delete an existing parsing rule.logConfigurationsUpdateDataPartitionRule: Update an existing data partition rule.logConfigurationsUpdateLiveArchiveConfiguration: Update the Live Archive configuration of an event type.logConfigurationsUpdateObfuscationExpression: Update an existing data partition rule.logConfigurationsUpdateObfuscationRule: Update an existing data partition rule.logConfigurationsUpdateParsingRule: Update an existing parsing rule.logConfigurationsUpsertPipelineConfiguration: Upsert pipeline configuration for an account.machineLearningAddDocumentIndex: Adds an index to a document based on provided configuration settings.machineLearningAddFileDataSource: Add a file data source to projectmachineLearningAddStreamDataSource: Add a stream data source to projectmachineLearningCreateFileDataSource: Creates a file data sourcemachineLearningCreateProject: Creates a projectmachineLearningCreateStreamDataSource: Creates a stream data sourcemachineLearningDeleteConnector: Initiate deletion of connector, connector docs, and indexed docsmachineLearningDeleteFileDataSource: Soft deletes a file data sourcemachineLearningDeleteProject: Delete projectmachineLearningDeleteStreamDataSource: Soft deletes a stream data sourcemachineLearningHaltStreamDataSource: shuts down a stream data sourcemachineLearningIndexConnector: Initiate indexing of a tool manuallymachineLearningRemoveDocumentIndex: Removes an index from a specified document.machineLearningRemoveFileDataSource: Remove a file data source from projectmachineLearningRemoveStreamDataSource: Remove a stream data source from projectmachineLearningStartStreamDataSource: starts a stream data sourcemachineLearningUpdateFileDataSource: Updates a file data sourcemachineLearningUpdateProject: Update projectmachineLearningUpdateStreamDataSource: Updates a stream data sourcemetricNormalizationCreateRule: Creates a metric normalization rulemetricNormalizationDisableRule: Disables a metric normalization rulemetricNormalizationEditRule: edit a metric normalization rulemetricNormalizationEnableRule: Enables a metric normalization rulemobilePushNotificationRemoveDevice: Remove a mobile device from the users list of devicesmobilePushNotificationSendTestPush: Send a test push notification to a users specific mobile devicemobilePushNotificationSendTestPushToAll: Send a test push notification to all of a users mobile devicesnerdStorageDeleteCollection: Delete a NerdStorage collection.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
nerdStorageDeleteDocument: Delete a NerdStorage document.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
nerdStorageVaultDeleteSecret: Delete an existing secret for the selected scope.nerdStorageVaultWriteSecret: Store or modify a secret.nerdStorageWriteDocument: Create a new NerdStorage document.
To use the NerdStorage schema you must specify a Nerdpack ID using the NewRelic-Package-Id header in your request.
nerdpackAddAllowedAccounts: Adds accounts to the Nerdpack allow list. The accounts must belong to the user’s authorized account list.nerdpackCreate: Creates a Nerdpack with a unique and random uuid V5.nerdpackRemoveAllowedAccounts: Removes accounts from the Nerdpack allow list. The accounts must belong to the user’s authorized account list.nerdpackRemoveVersionTag: Remove a specific nerdpack version tag. This operation can only be performed if:
User has untagging capabilities.
User has accepted the terms and conditions.
User’s account is the Nerdpack owner, or is an authorized account, or is an admin account for the Nerdpack owner account.
nerdpackSubscribeAccounts: Make a Nerdpack publication available to a list of accounts. Providing partial results.nerdpackTagVersion: Tag a Nerdpack version. This operation can only be performed if:
User has tagging capabilities.
User has accepted the terms and conditions.
User’s account is the Nerdpack owner, or is an authorized account, or is an admin account for the Nerdpack owner account.
nerdpackUnsubscribeAccounts: Make a Nerdpack publication unavailable to a list of accounts. Providing partial results.nr1CatalogInstallAlertPolicyTemplate: Install an alert policy template on a given account for use in itnr1CatalogInstallDashboardTemplate: Install a dashboard template on a given account for use in itnr1CatalogSubmitMetadata: Submit metadata for a Nerdpack that will be available in the New Relic One CatalognrqlCancelQuery: Attempt to cancel a NRQL query currently being executednrqlDropRulesCreate: Create new drop rule(s).nrqlDropRulesDelete: Delete drop rule(s) by id.organizationCreate: The new organization to create.organizationCreateSharedAccount: The shared account to createorganizationProvisioningUpdatePartnerSubscriptionorganizationRevokeSharedAccount: The shared account to revokeorganizationUpdate: The organization to updateorganizationUpdateSharedAccount: The shared account to updatepixieLinkPixieProject: Link a Pixie project to a New Relic account using a Pixie API keypixieRecordPixieTosAcceptance: Record the Pixie terms of service acceptance for a given accountpixieUnlinkPixieProject: Unlink a Pixie project to a New Relic accountreferenceEntityCreateOrUpdateRepository: Creates or updates repository entities.secretsManagementCreateSecret: creates a new secret with the given key and valuesecretsManagementCreateShareableSecret: creates a new shareable secret with the given key and valuesecretsManagementDeleteSecret: delete a secret from the secret store by keysecretsManagementDeleteSecretVersion: delete a version of the secret from the secret store by key and versionsecretsManagementRecoverSecret: recover a deleted secret from the secret store by keysecretsManagementRecoverSecretVersion: recover a specific version of a secret from the secret storesecretsManagementUpdateSecret: updates the value of a secret with the given keyserviceLevelCreate: Creates a new SLI.serviceLevelDelete: Deletes an existing SLI by the GUID.serviceLevelUpdate: Updates an existing SLI by the GUID.sessionsRevoke: Revoke sessionsstreamingExportCreateRule: Create new streaming rulestreamingExportDeleteRule: Delete a streaming rulestreamingExportDisableRule: Disable an existing streaming rulestreamingExportEnableRule: Enable an existing streaming rulestreamingExportUpdateRule: Update an existing streaming rulesyntheticsCreateBrokenLinksMonitor: Create a Synthetic Broken Links monitorsyntheticsCreateCertCheckMonitor: Create a Synthetic Cert Check (Certificate check) monitorsyntheticsCreateDailyMonitorDowntime: Create a monitor downtime that runs dailysyntheticsCreateMonthlyMonitorDowntime: Create a monitor downtime that runs monthlysyntheticsCreateOnceMonitorDowntime: Create a monitor downtime that runs oncesyntheticsCreatePrivateLocation: Create a Synthetics Private LocationsyntheticsCreateScriptApiMonitor: Create a Synthetic Script Api monitorsyntheticsCreateScriptBrowserMonitor: Create a Synthetic Script Browser MonitorsyntheticsCreateSecureCredential: Queues a request to create a secure credentialsyntheticsCreateSimpleBrowserMonitor: Create a Synthetic Simple (Ping) monitorsyntheticsCreateSimpleMonitor: Create a Synthetic Simple (Ping) monitorsyntheticsCreateStepMonitor: Create a Synthetic Step monitorsyntheticsCreateWeeklyMonitorDowntime: Create a monitor downtime that runs weeklysyntheticsDeleteMonitor: Delete a Synthetic MonitorsyntheticsDeleteMonitorDowntime: Delete a monitor downtimesyntheticsDeletePrivateLocation: Delete a Synthetics Private LocationsyntheticsDeleteSecureCredential: Queues a request to delete an existing secure credentialsyntheticsEditMonitorDowntime: Edit a monitor downtimesyntheticsPurgePrivateLocationQueue: Purge the job queue for a specified private locationsyntheticsUpdateBrokenLinksMonitor: Update a Synthetic Broken Links monitorsyntheticsUpdateCertCheckMonitor: Update a Synthetic Cert Check (Certificate check) monitorsyntheticsUpdatePrivateLocation: Update a Synthetics Private LocationsyntheticsUpdateScriptApiMonitor: Update a Synthetic Script Api monitorsyntheticsUpdateScriptBrowserMonitor: Update a Synthetic Script Browser MonitorsyntheticsUpdateSecureCredential: Queues a request to update an existing secure credentialsyntheticsUpdateSimpleBrowserMonitor: Update a Synthetic Simple Browser monitorsyntheticsUpdateSimpleMonitor: Update a Synthetic Simple (Ping) monitorsyntheticsUpdateStepMonitor: Update a Synthetic Step monitorsystemIdentityAddToGroups: Add system identities to system identity group(s)systemIdentityCreate: Create a system identity. The systemIdentityCreate mutation is used in the Agent Control install flow. It is not supported for any other use cases at this time.systemIdentityCreateGroup: Create a system identity groupsystemIdentityDelete: Delete a system identitysystemIdentityDeleteGroup: Delete a system identity groupsystemIdentityRemoveFromGroups: Remove system identities from system identity group(s)systemIdentityUpdate: Update a system identitysystemIdentityUpdateGroup: Update a system identity grouptaggingAddTagsToEntity: Adds the provided tags to your specified entity, without deleting existing ones. The maximum number of tag-values per entity is 100; if the sum of existing and new tag-values if over the limit this mutation will fail.
For details and mutation examples, visit our docs.
taggingDeleteTagFromEntity: Delete specific tag keys from the entity.
For details and mutation examples, visit our docs.
taggingDeleteTagValuesFromEntity: Delete specific tag key-values from the entity.
For details and mutation examples, visit our docs.
taggingReplaceTagsOnEntity: Replaces the entity’s entire set of tags with the provided tag set. The maximum number of tag-values per entity is 100; if more than 100 tag-values are provided this mutation will fail.
For details and mutation examples, visit our docs.
userManagementAddUsersToGroups: A mutation for adding user(s) to group(s).userManagementCreateGroup: A mutation for creating a group in an authentication domain.userManagementCreateUser: A mutation for creating a user in an authentication domain.userManagementDeleteGroup: A mutation for deleting a group.userManagementDeleteUser: A mutation for deleting a user.userManagementRemoveUsersFromGroups: A mutation for removing user(s) from group(s).userManagementUpdateGroup: A mutation for updating an existing group.userManagementUpdateUser: A mutation for updating an existing user.whatsNewSetLastReadDate: Updates the date the current user last read the news.workflowAutomationCreateSchedule: Create schedule to run a workflow on a cadenceworkflowAutomationCreateWorkflowDefinition: Creates workflow definitionworkflowAutomationDeleteSchedule: Delete scheduleworkflowAutomationDeleteWorkflowDefinition: Deletes a workflow definitionworkflowAutomationSignalWorkflowRun: Signals workflow runworkflowAutomationStartWorkflowRun: Starts workflow runworkflowAutomationStopWorkflowRun: Stops workflow runworkflowAutomationUpdateWorkflowDefinition: Updates workflow definitionworkloadCreate: Creates a new workload.workloadDelete: Deletes an existing workload.workloadDuplicate: Duplicates an existing workload.workloadUpdate: Updates an existing workload.
class RootMutationType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_management_cancel_account",
"account_management_create_account",
"account_management_update_account",
"agent_application_add_app_to_entity_platform",
"agent_application_create_browser",
"agent_application_create_mobile",
"agent_application_delete",
"agent_application_enable_apm_browser",
"agent_application_segments_replace_all_browser_segment_allow_list",
"agent_application_settings_update",
"ai_decisions_accept_suggestion",
"ai_decisions_create_implicit_rule",
"ai_decisions_create_rule",
"ai_decisions_create_suggestion",
"ai_decisions_decline_suggestion",
"ai_decisions_delete_merge_feedback",
"ai_decisions_delete_rule",
"ai_decisions_delete_suggestion",
"ai_decisions_disable_rule",
"ai_decisions_enable_rule",
"ai_decisions_find_applicable_incidents",
"ai_decisions_postpone_suggestion",
"ai_decisions_record_merge_feedback",
"ai_decisions_simulate",
"ai_decisions_update_implicit_rule",
"ai_decisions_update_rule",
"ai_issues_ack_issue",
"ai_issues_close_incident",
"ai_issues_resolve_issue",
"ai_issues_unack_issue",
"ai_issues_update_grace_period",
"ai_issues_update_issue_ttl",
"ai_notifications_create_channel",
"ai_notifications_create_destination",
"ai_notifications_delete_channel",
"ai_notifications_delete_destination",
"ai_notifications_test_channel",
"ai_notifications_test_channel_by_id",
"ai_notifications_test_destination",
"ai_notifications_test_destination_by_id",
"ai_notifications_update_channel",
"ai_notifications_update_destination",
"ai_workflows_create_workflow",
"ai_workflows_delete_workflow",
"ai_workflows_test_workflow",
"ai_workflows_update_workflow",
"alerts_condition_delete",
"alerts_muting_rule_create",
"alerts_muting_rule_delete",
"alerts_muting_rule_update",
"alerts_nrql_condition_baseline_create",
"alerts_nrql_condition_baseline_update",
"alerts_nrql_condition_static_create",
"alerts_nrql_condition_static_update",
"alerts_policy_create",
"alerts_policy_delete",
"alerts_policy_update",
"alerts_update_cross_account_election",
"alerts_update_cross_account_elections",
"api_access_create_keys",
"api_access_delete_keys",
"api_access_update_keys",
"authentication_domain_delete",
"authorization_management_grant_access",
"authorization_management_revoke_access",
"authorization_management_update_access",
"change_tracking_create_deployment",
"change_tracking_create_event",
"cloud_configure_integration",
"cloud_disable_integration",
"cloud_link_account",
"cloud_migrate_aws_gov_cloud_to_assume_role",
"cloud_oci_generate_instrumented_payload_url",
"cloud_oci_generate_log_group_instrumented_payload_url",
"cloud_rename_account",
"cloud_unlink_account",
"cloud_update_account",
"collaboration_create_code_mark",
"collaboration_create_comment",
"collaboration_create_context",
"collaboration_create_email",
"collaboration_create_external_service_connection",
"collaboration_create_mention",
"collaboration_create_thread",
"collaboration_deactivate_code_mark",
"collaboration_deactivate_comment",
"collaboration_deactivate_context",
"collaboration_deactivate_external_service_connection",
"collaboration_deactivate_file",
"collaboration_deactivate_mention",
"collaboration_deactivate_thread",
"collaboration_feedback_on_bot_response",
"collaboration_get_upload_url",
"collaboration_register_email",
"collaboration_send_message",
"collaboration_set_external_service_connection_channel",
"collaboration_socket_subscribe",
"collaboration_subscribe_to_thread",
"collaboration_unsubscribe_from_thread",
"collaboration_update_comment",
"collaboration_update_context_add_comment",
"collaboration_update_context_add_thread",
"collaboration_update_subscription_read_info",
"collaboration_update_thread_add_comment",
"collaboration_update_thread_status",
"custom_role_create",
"custom_role_delete",
"custom_role_update",
"dashboard_add_widgets_to_page",
"dashboard_create",
"dashboard_create_live_url",
"dashboard_create_snapshot_url",
"dashboard_delete",
"dashboard_reset_live_url_password",
"dashboard_revoke_live_url",
"dashboard_undelete",
"dashboard_update",
"dashboard_update_live_url",
"dashboard_update_live_url_auth",
"dashboard_update_live_url_creation_policies",
"dashboard_update_page",
"dashboard_update_widgets_in_page",
"dashboard_widget_revoke_live_url",
"data_access_policy_create",
"data_access_policy_delete",
"data_access_policy_update",
"data_management_copy_retentions",
"data_management_create_account_limit",
"data_management_create_event_retention_rule",
"data_management_create_organization_limit",
"data_management_create_retention_rules",
"data_management_delete_event_retention_rule",
"data_management_expire_organization_limit",
"data_management_update_feature_settings",
"edge_create_trace_filter_rules",
"edge_create_trace_observer",
"edge_delete_trace_filter_rules",
"edge_delete_trace_observers",
"edge_update_trace_observers",
"entity_delete",
"entity_golden_metrics_override",
"entity_golden_metrics_reset",
"entity_golden_tags_override",
"entity_golden_tags_reset",
"entity_management_add_collection_members",
"entity_management_create_ai_agent",
"entity_management_create_ai_tool",
"entity_management_create_collection",
"entity_management_create_confluence_integration",
"entity_management_create_confluence_rag_settings",
"entity_management_create_git_repository",
"entity_management_create_impact_profile",
"entity_management_create_inbox_issue_category",
"entity_management_create_incident_link",
"entity_management_create_incident_timeline",
"entity_management_create_mcp_server",
"entity_management_create_pipeline_cloud_rule",
"entity_management_create_rag_tool",
"entity_management_create_relationship",
"entity_management_create_scorecard",
"entity_management_create_scorecard_rule",
"entity_management_create_team",
"entity_management_delete",
"entity_management_delete_relationship",
"entity_management_remove_collection_members",
"entity_management_update",
"entity_management_update_ai_agent",
"entity_management_update_ai_tool",
"entity_management_update_collection",
"entity_management_update_confluence_integration",
"entity_management_update_confluence_rag_settings",
"entity_management_update_git_repository",
"entity_management_update_impact_profile",
"entity_management_update_inbox_issue_category",
"entity_management_update_incident_link",
"entity_management_update_incident_timeline",
"entity_management_update_mcp_server",
"entity_management_update_pipeline_cloud_rule",
"entity_management_update_rag_tool",
"entity_management_update_relationship",
"entity_management_update_scorecard",
"entity_management_update_scorecard_rule",
"entity_management_update_team",
"entity_management_update_teams_hierarchy_level",
"entity_management_update_teams_organization_settings",
"entity_relationship_user_defined_create_or_replace",
"entity_relationship_user_defined_delete",
"errors_inbox_assign_error_group",
"errors_inbox_delete_error_group_resource",
"errors_inbox_update_error_group_state",
"events_to_metrics_create_rule",
"events_to_metrics_delete_rule",
"events_to_metrics_update_rule",
"fleet_control_add_fleet_members",
"fleet_control_create_fleet",
"fleet_control_create_fleet_deployment",
"fleet_control_delete_fleet",
"fleet_control_delete_fleet_deployment",
"fleet_control_deploy",
"fleet_control_remove_fleet_members",
"fleet_control_update_fleet",
"fleet_control_update_fleet_deployment",
"historical_data_export_cancel_export",
"historical_data_export_create_export",
"incident_intelligence_environment_consent_accounts",
"incident_intelligence_environment_consent_authorized_accounts",
"incident_intelligence_environment_delete_environment",
"incident_intelligence_environment_dissent_accounts",
"installation_create_install_status",
"installation_create_recipe_event",
"installation_delete_install",
"integration_services_service_now_installation",
"integration_services_service_now_update",
"key_transaction_create",
"key_transaction_delete",
"key_transaction_update",
"log_configurations_create_data_partition_rule",
"log_configurations_create_obfuscation_expression",
"log_configurations_create_obfuscation_rule",
"log_configurations_create_parsing_rule",
"log_configurations_delete_data_partition_rule",
"log_configurations_delete_obfuscation_expression",
"log_configurations_delete_obfuscation_rule",
"log_configurations_delete_parsing_rule",
"log_configurations_update_data_partition_rule",
"log_configurations_update_live_archive_configuration",
"log_configurations_update_obfuscation_expression",
"log_configurations_update_obfuscation_rule",
"log_configurations_update_parsing_rule",
"log_configurations_upsert_pipeline_configuration",
"machine_learning_add_document_index",
"machine_learning_add_file_data_source",
"machine_learning_add_stream_data_source",
"machine_learning_create_file_data_source",
"machine_learning_create_project",
"machine_learning_create_stream_data_source",
"machine_learning_delete_connector",
"machine_learning_delete_file_data_source",
"machine_learning_delete_project",
"machine_learning_delete_stream_data_source",
"machine_learning_halt_stream_data_source",
"machine_learning_index_connector",
"machine_learning_remove_document_index",
"machine_learning_remove_file_data_source",
"machine_learning_remove_stream_data_source",
"machine_learning_start_stream_data_source",
"machine_learning_update_file_data_source",
"machine_learning_update_project",
"machine_learning_update_stream_data_source",
"metric_normalization_create_rule",
"metric_normalization_disable_rule",
"metric_normalization_edit_rule",
"metric_normalization_enable_rule",
"mobile_push_notification_remove_device",
"mobile_push_notification_send_test_push",
"mobile_push_notification_send_test_push_to_all",
"nerd_storage_delete_collection",
"nerd_storage_delete_document",
"nerd_storage_vault_delete_secret",
"nerd_storage_vault_write_secret",
"nerd_storage_write_document",
"nerdpack_add_allowed_accounts",
"nerdpack_create",
"nerdpack_remove_allowed_accounts",
"nerdpack_remove_version_tag",
"nerdpack_subscribe_accounts",
"nerdpack_tag_version",
"nerdpack_unsubscribe_accounts",
"nr1_catalog_install_alert_policy_template",
"nr1_catalog_install_dashboard_template",
"nr1_catalog_submit_metadata",
"nrql_cancel_query",
"nrql_drop_rules_create",
"nrql_drop_rules_delete",
"organization_create",
"organization_create_shared_account",
"organization_provisioning_update_partner_subscription",
"organization_revoke_shared_account",
"organization_update",
"organization_update_shared_account",
"pixie_link_pixie_project",
"pixie_record_pixie_tos_acceptance",
"pixie_unlink_pixie_project",
"reference_entity_create_or_update_repository",
"secrets_management_create_secret",
"secrets_management_create_shareable_secret",
"secrets_management_delete_secret",
"secrets_management_delete_secret_version",
"secrets_management_recover_secret",
"secrets_management_recover_secret_version",
"secrets_management_update_secret",
"service_level_create",
"service_level_delete",
"service_level_update",
"sessions_revoke",
"streaming_export_create_rule",
"streaming_export_delete_rule",
"streaming_export_disable_rule",
"streaming_export_enable_rule",
"streaming_export_update_rule",
"synthetics_create_broken_links_monitor",
"synthetics_create_cert_check_monitor",
"synthetics_create_daily_monitor_downtime",
"synthetics_create_monthly_monitor_downtime",
"synthetics_create_once_monitor_downtime",
"synthetics_create_private_location",
"synthetics_create_script_api_monitor",
"synthetics_create_script_browser_monitor",
"synthetics_create_secure_credential",
"synthetics_create_simple_browser_monitor",
"synthetics_create_simple_monitor",
"synthetics_create_step_monitor",
"synthetics_create_weekly_monitor_downtime",
"synthetics_delete_monitor",
"synthetics_delete_monitor_downtime",
"synthetics_delete_private_location",
"synthetics_delete_secure_credential",
"synthetics_edit_monitor_downtime",
"synthetics_purge_private_location_queue",
"synthetics_update_broken_links_monitor",
"synthetics_update_cert_check_monitor",
"synthetics_update_private_location",
"synthetics_update_script_api_monitor",
"synthetics_update_script_browser_monitor",
"synthetics_update_secure_credential",
"synthetics_update_simple_browser_monitor",
"synthetics_update_simple_monitor",
"synthetics_update_step_monitor",
"system_identity_add_to_groups",
"system_identity_create",
"system_identity_create_group",
"system_identity_delete",
"system_identity_delete_group",
"system_identity_remove_from_groups",
"system_identity_update",
"system_identity_update_group",
"tagging_add_tags_to_entity",
"tagging_delete_tag_from_entity",
"tagging_delete_tag_values_from_entity",
"tagging_replace_tags_on_entity",
"user_management_add_users_to_groups",
"user_management_create_group",
"user_management_create_user",
"user_management_delete_group",
"user_management_delete_user",
"user_management_remove_users_from_groups",
"user_management_update_group",
"user_management_update_user",
"whats_new_set_last_read_date",
"workflow_automation_create_schedule",
"workflow_automation_create_workflow_definition",
"workflow_automation_delete_schedule",
"workflow_automation_delete_workflow_definition",
"workflow_automation_signal_workflow_run",
"workflow_automation_start_workflow_run",
"workflow_automation_stop_workflow_run",
"workflow_automation_update_workflow_definition",
"workload_create",
"workload_delete",
"workload_duplicate",
"workload_update",
)
account_management_cancel_account = sgqlc.types.Field(
AccountManagementManagedAccount,
graphql_name="accountManagementCancelAccount",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`Int!`): The id of the account to cancel.
"""
account_management_create_account = sgqlc.types.Field(
AccountManagementCreateResponse,
graphql_name="accountManagementCreateAccount",
args=sgqlc.types.ArgDict(
(
(
"managed_account",
sgqlc.types.Arg(
sgqlc.types.non_null(AccountManagementCreateInput),
graphql_name="managedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `managed_account` (`AccountManagementCreateInput!`): The
attributes for the account being created.
"""
account_management_update_account = sgqlc.types.Field(
AccountManagementUpdateResponse,
graphql_name="accountManagementUpdateAccount",
args=sgqlc.types.ArgDict(
(
(
"managed_account",
sgqlc.types.Arg(
sgqlc.types.non_null(AccountManagementUpdateInput),
graphql_name="managedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `managed_account` (`AccountManagementUpdateInput!`): The
attributes for updating an account.
"""
agent_application_add_app_to_entity_platform = sgqlc.types.Field(
AgentApplicationAddAppToEntityPlatformResult,
graphql_name="agentApplicationAddAppToEntityPlatform",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The application's account ID.
* `name` (`String!`): The application's name..
"""
agent_application_create_browser = sgqlc.types.Field(
AgentApplicationCreateBrowserResult,
graphql_name="agentApplicationCreateBrowser",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"settings",
sgqlc.types.Arg(
AgentApplicationBrowserSettingsInput,
graphql_name="settings",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account ID.
* `name` (`String!`): The application's name.
* `settings` (`AgentApplicationBrowserSettingsInput`): Browser
settings input object.
"""
agent_application_create_mobile = sgqlc.types.Field(
AgentApplicationCreateMobileResult,
graphql_name="agentApplicationCreateMobile",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The application's account ID.
* `name` (`String!`): The application's name..
"""
agent_application_delete = sgqlc.types.Field(
AgentApplicationDeleteResult,
graphql_name="agentApplicationDelete",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"application_name",
sgqlc.types.Arg(
String, graphql_name="applicationName", default=None
),
),
("force", sgqlc.types.Arg(Boolean, graphql_name="force", default=None)),
(
"guid",
sgqlc.types.Arg(EntityGuid, graphql_name="guid", default=None),
),
)
),
)
"""Arguments:
* `account_id` (`Int`): The account Id associated with application
* `application_name` (`String`): The name of the application
* `force` (`Boolean`): Forces deletion even if the app is still
reporting
* `guid` (`EntityGuid`): An application's GUID.
"""
agent_application_enable_apm_browser = sgqlc.types.Field(
AgentApplicationEnableBrowserResult,
graphql_name="agentApplicationEnableApmBrowser",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"settings",
sgqlc.types.Arg(
AgentApplicationBrowserSettingsInput,
graphql_name="settings",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The affected entity's GUID.
* `settings` (`AgentApplicationBrowserSettingsInput`): Browsers
settings input object.
"""
agent_application_segments_replace_all_browser_segment_allow_list = (
sgqlc.types.Field(
AgentApplicationSegmentsBrowserSegmentAllowListResult,
graphql_name="agentApplicationSegmentsReplaceAllBrowserSegmentAllowList",
args=sgqlc.types.ArgDict(
(
(
"allow_list",
sgqlc.types.Arg(
sgqlc.types.non_null(
AgentApplicationSegmentsBrowserSegmentAllowListInput
),
graphql_name="allowList",
default=None,
),
),
(
"entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="entityGuid",
default=None,
),
),
)
),
)
)
"""Arguments:
* `allow_list`
(`AgentApplicationSegmentsBrowserSegmentAllowListInput!`): The
list of url segments to replace the current allow list with. The
list cannot be Empty.
* `entity_guid` (`EntityGuid!`): The NR1 entity guid
"""
agent_application_settings_update = sgqlc.types.Field(
AgentApplicationSettingsUpdateResult,
graphql_name="agentApplicationSettingsUpdate",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"settings",
sgqlc.types.Arg(
sgqlc.types.non_null(AgentApplicationSettingsUpdateInput),
graphql_name="settings",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The GUID for the affected entity.
* `settings` (`AgentApplicationSettingsUpdateInput!`): Input data
about the entities you want to update and the settings to use.
Any unspecified fields will retain their original values.
"""
ai_decisions_accept_suggestion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsAcceptSuggestion",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"suggestion_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="suggestionId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `suggestion_id` (`ID!`): Suggestion ID.
"""
ai_decisions_create_implicit_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsCreateImplicitRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsRuleBlueprint),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule` (`AiDecisionsRuleBlueprint!`): Rule blueprint to be
created.
"""
ai_decisions_create_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsCreateRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsRuleBlueprint),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule` (`AiDecisionsRuleBlueprint!`): Rule blueprint to be
created.
"""
ai_decisions_create_suggestion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsSuggestion),
graphql_name="aiDecisionsCreateSuggestion",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"suggestion",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsSuggestionBlueprint),
graphql_name="suggestion",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `suggestion` (`AiDecisionsSuggestionBlueprint!`): Suggestion
blueprint to be created.
"""
ai_decisions_decline_suggestion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsDeclineSuggestion",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"suggestion_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="suggestionId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `suggestion_id` (`ID!`): Suggestion ID.
"""
ai_decisions_delete_merge_feedback = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsDeleteMergeFeedback",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"child_issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="childIssueId",
default=None,
),
),
(
"parent_issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="parentIssueId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `child_issue_id` (`ID!`): Child issue ID.
* `parent_issue_id` (`ID!`): Parent issue ID.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_delete_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsDeleteRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_delete_suggestion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsDeleteSuggestion",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"suggestion_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="suggestionId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `suggestion_id` (`ID!`): Suggestion ID.
"""
ai_decisions_disable_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsDisableRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_enable_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsOperationResult),
graphql_name="aiDecisionsEnableRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_find_applicable_incidents = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsApplicableIncidentSearch),
graphql_name="aiDecisionsFindApplicableIncidents",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"search",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsSearchBlueprint),
graphql_name="search",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `search` (`AiDecisionsSearchBlueprint!`): Search operation
blueprint to be created.
"""
ai_decisions_postpone_suggestion = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsPostponeSuggestion",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"suggestion_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="suggestionId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `suggestion_id` (`ID!`): Suggestion ID.
"""
ai_decisions_record_merge_feedback = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsMergeFeedback),
graphql_name="aiDecisionsRecordMergeFeedback",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"child_issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="childIssueId",
default=None,
),
),
(
"opinion",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsOpinion),
graphql_name="opinion",
default=None,
),
),
(
"parent_issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="parentIssueId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `child_issue_id` (`ID!`): Child issue ID.
* `opinion` (`AiDecisionsOpinion!`): Opinion type.
* `parent_issue_id` (`ID!`): Parent issue ID.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_simulate = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsSimulation),
graphql_name="aiDecisionsSimulate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"simulation",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsSimulationBlueprint),
graphql_name="simulation",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `simulation` (`AiDecisionsSimulationBlueprint!`): Simulation
blueprint to be created.
"""
ai_decisions_update_implicit_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsUpdateImplicitRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsRuleBlueprint),
graphql_name="rule",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule` (`AiDecisionsRuleBlueprint!`): Rule blueprint to be
created.
* `rule_id` (`ID!`): Rule ID.
"""
ai_decisions_update_rule = sgqlc.types.Field(
sgqlc.types.non_null(AiDecisionsRule),
graphql_name="aiDecisionsUpdateRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AiDecisionsRuleBlueprint),
graphql_name="rule",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="ruleId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule` (`AiDecisionsRuleBlueprint!`): Rule blueprint to be
created.
* `rule_id` (`ID!`): Rule ID.
"""
ai_issues_ack_issue = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIssueUserActionResponse),
graphql_name="aiIssuesAckIssue",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="issueId", default=None
),
),
)
),
)
ai_issues_close_incident = sgqlc.types.Field(
AiIssuesIncidentUserActionResponse,
graphql_name="aiIssuesCloseIncident",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"incident_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="incidentId",
default=None,
),
),
)
),
)
ai_issues_resolve_issue = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIssueUserActionResponse),
graphql_name="aiIssuesResolveIssue",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="issueId", default=None
),
),
)
),
)
ai_issues_unack_issue = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesIssueUserActionResponse),
graphql_name="aiIssuesUnackIssue",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"issue_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="issueId", default=None
),
),
)
),
)
ai_issues_update_grace_period = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesConfigurationOverrideResponse),
graphql_name="aiIssuesUpdateGracePeriod",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"grace_period",
sgqlc.types.Arg(
sgqlc.types.non_null(AiIssuesGracePeriodConfigurationInput),
graphql_name="gracePeriod",
default=None,
),
),
)
),
)
ai_issues_update_issue_ttl = sgqlc.types.Field(
sgqlc.types.non_null(AiIssuesConfigurationOverrideResponse),
graphql_name="aiIssuesUpdateIssueTtl",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"issue_ttl",
sgqlc.types.Arg(
sgqlc.types.non_null(Seconds),
graphql_name="issueTtl",
default=None,
),
),
)
),
)
ai_notifications_create_channel = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelResponse),
graphql_name="aiNotificationsCreateChannel",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"channel",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsChannelInput),
graphql_name="channel",
default=None,
),
),
)
),
)
ai_notifications_create_destination = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationResponse),
graphql_name="aiNotificationsCreateDestination",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"destination",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationInput),
graphql_name="destination",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
AiNotificationsEntityScopeInput,
graphql_name="scope",
default=None,
),
),
)
),
)
ai_notifications_delete_channel = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDeleteResponse),
graphql_name="aiNotificationsDeleteChannel",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"channel_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="channelId", default=None
),
),
)
),
)
ai_notifications_delete_destination = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDeleteResponse),
graphql_name="aiNotificationsDeleteDestination",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"destination_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="destinationId",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
AiNotificationsEntityScopeInput,
graphql_name="scope",
default=None,
),
),
)
),
)
ai_notifications_test_channel = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelTestResponse),
graphql_name="aiNotificationsTestChannel",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"channel",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsChannelInput),
graphql_name="channel",
default=None,
),
),
(
"variables",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiNotificationsDynamicVariable)
),
graphql_name="variables",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account Id
* `channel` (`AiNotificationsChannelInput!`): Channel to test
notification for
* `variables` (`[AiNotificationsDynamicVariable!]`): Dynamic
variables
"""
ai_notifications_test_channel_by_id = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelTestResponse),
graphql_name="aiNotificationsTestChannelById",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"channel_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="channelId", default=None
),
),
(
"variables",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(AiNotificationsDynamicVariable)
),
graphql_name="variables",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account Id
* `channel_id` (`ID!`): Channel ID to test notification for
* `variables` (`[AiNotificationsDynamicVariable!]`): Dynamic
variables
"""
ai_notifications_test_destination = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationTestResponse),
graphql_name="aiNotificationsTestDestination",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"destination",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationInput),
graphql_name="destination",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
AiNotificationsEntityScopeInput,
graphql_name="scope",
default=None,
),
),
)
),
)
ai_notifications_test_destination_by_id = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationTestResponse),
graphql_name="aiNotificationsTestDestinationById",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"destination_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="destinationId",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
AiNotificationsEntityScopeInput,
graphql_name="scope",
default=None,
),
),
(
"update",
sgqlc.types.Arg(
AiNotificationsDestinationUpdate,
graphql_name="update",
default=None,
),
),
)
),
)
ai_notifications_update_channel = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsChannelResponse),
graphql_name="aiNotificationsUpdateChannel",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"channel",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsChannelUpdate),
graphql_name="channel",
default=None,
),
),
(
"channel_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="channelId", default=None
),
),
)
),
)
ai_notifications_update_destination = sgqlc.types.Field(
sgqlc.types.non_null(AiNotificationsDestinationResponse),
graphql_name="aiNotificationsUpdateDestination",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"destination",
sgqlc.types.Arg(
sgqlc.types.non_null(AiNotificationsDestinationUpdate),
graphql_name="destination",
default=None,
),
),
(
"destination_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="destinationId",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
AiNotificationsEntityScopeInput,
graphql_name="scope",
default=None,
),
),
)
),
)
ai_workflows_create_workflow = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsCreateWorkflowResponse),
graphql_name="aiWorkflowsCreateWorkflow",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"create_workflow_data",
sgqlc.types.Arg(
sgqlc.types.non_null(AiWorkflowsCreateWorkflowInput),
graphql_name="createWorkflowData",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Workflow's account id
* `create_workflow_data` (`AiWorkflowsCreateWorkflowInput!`):
Create Workflow input object
"""
ai_workflows_delete_workflow = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsDeleteWorkflowResponse),
graphql_name="aiWorkflowsDeleteWorkflow",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"delete_channels",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="deleteChannels",
default=True,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Workflow's account id
* `delete_channels` (`Boolean!`): If true, workflow channel will
be deleted along with the workflow (default: `true`)
* `id` (`ID!`): Workflow's id for deletion
"""
ai_workflows_test_workflow = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsTestWorkflowResponse),
graphql_name="aiWorkflowsTestWorkflow",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"test_workflow_data",
sgqlc.types.Arg(
sgqlc.types.non_null(AiWorkflowsTestWorkflowInput),
graphql_name="testWorkflowData",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Workflow's account id
* `test_workflow_data` (`AiWorkflowsTestWorkflowInput!`): Test
Workflow input object
"""
ai_workflows_update_workflow = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsUpdateWorkflowResponse),
graphql_name="aiWorkflowsUpdateWorkflow",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"delete_unused_channels",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="deleteUnusedChannels",
default=True,
),
),
(
"update_workflow_data",
sgqlc.types.Arg(
sgqlc.types.non_null(AiWorkflowsUpdateWorkflowInput),
graphql_name="updateWorkflowData",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Workflow's account id
* `delete_unused_channels` (`Boolean!`): If true, the channels
that are no longer used by the update workflow will be deleted
(default: `true`)
* `update_workflow_data` (`AiWorkflowsUpdateWorkflowInput!`):
Update Workflow input object
"""
alerts_condition_delete = sgqlc.types.Field(
AlertsConditionDeleteResponse,
graphql_name="alertsConditionDelete",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `id` (`ID!`): Alerts condition ID.
"""
alerts_muting_rule_create = sgqlc.types.Field(
AlertsMutingRule,
graphql_name="alertsMutingRuleCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsMutingRuleInput),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `rule` (`AlertsMutingRuleInput!`): Input settings for the muting
rule.
"""
alerts_muting_rule_delete = sgqlc.types.Field(
AlertsMutingRuleDeleteResponse,
graphql_name="alertsMutingRuleDelete",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `id` (`ID!`): Muting rule.
"""
alerts_muting_rule_update = sgqlc.types.Field(
AlertsMutingRule,
graphql_name="alertsMutingRuleUpdate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsMutingRuleUpdateInput),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `id` (`ID!`): Muting rule ID.
* `rule` (`AlertsMutingRuleUpdateInput!`): The input options for
updating a muting rule.
"""
alerts_nrql_condition_baseline_create = sgqlc.types.Field(
"AlertsNrqlBaselineCondition",
graphql_name="alertsNrqlConditionBaselineCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"condition",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsNrqlConditionBaselineInput),
graphql_name="condition",
default=None,
),
),
(
"policy_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="policyId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `condition` (`AlertsNrqlConditionBaselineInput!`): Input
settings for the baseline NRQL condition.
* `policy_id` (`ID!`): Policy ID for the condition.
"""
alerts_nrql_condition_baseline_update = sgqlc.types.Field(
"AlertsNrqlBaselineCondition",
graphql_name="alertsNrqlConditionBaselineUpdate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"condition",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsNrqlConditionUpdateBaselineInput),
graphql_name="condition",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `condition` (`AlertsNrqlConditionUpdateBaselineInput!`): Input
settings for the baseline NRQL condition.
* `id` (`ID!`): Alerts condition ID.
"""
alerts_nrql_condition_static_create = sgqlc.types.Field(
"AlertsNrqlStaticCondition",
graphql_name="alertsNrqlConditionStaticCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"condition",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsNrqlConditionStaticInput),
graphql_name="condition",
default=None,
),
),
(
"policy_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="policyId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `condition` (`AlertsNrqlConditionStaticInput!`): Input settings
for the static NRQL condition.
* `policy_id` (`ID!`): Policy ID for the condition.
"""
alerts_nrql_condition_static_update = sgqlc.types.Field(
"AlertsNrqlStaticCondition",
graphql_name="alertsNrqlConditionStaticUpdate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"condition",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsNrqlConditionUpdateStaticInput),
graphql_name="condition",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `condition` (`AlertsNrqlConditionUpdateStaticInput!`): Input
settings for the static NRQL condition.
* `id` (`ID!`): Alerts condition ID.
"""
alerts_policy_create = sgqlc.types.Field(
AlertsPolicy,
graphql_name="alertsPolicyCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"policy",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsPolicyInput),
graphql_name="policy",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `policy` (`AlertsPolicyInput!`): Policy to be created.
"""
alerts_policy_delete = sgqlc.types.Field(
AlertsPolicyDeleteResponse,
graphql_name="alertsPolicyDelete",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `id` (`ID!`): Policy ID.
"""
alerts_policy_update = sgqlc.types.Field(
AlertsPolicy,
graphql_name="alertsPolicyUpdate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"policy",
sgqlc.types.Arg(
sgqlc.types.non_null(AlertsPolicyUpdateInput),
graphql_name="policy",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `id` (`ID!`): Policy ID.
* `policy` (`AlertsPolicyUpdateInput!`): Fields on the policy to
be updated.
"""
alerts_update_cross_account_election = sgqlc.types.Field(
AlertsCrossAccountElectionStatus,
graphql_name="alertsUpdateCrossAccountElection",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"allowed_condition_account_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(Int)),
graphql_name="allowedConditionAccountIds",
default=None,
),
),
(
"election_status",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="electionStatus",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID.
* `allowed_condition_account_ids` (`[Int!]`): The account IDs of
the accounts that will be allowed to have alert conditions that
use data from this account in a cross account alert. Ignored if
electionStatus is false. When electionStatus is true, null or
empty means all accounts are allowed.
* `election_status` (`Boolean!`): The new election status for the
account.
"""
alerts_update_cross_account_elections = sgqlc.types.Field(
AlertsCrossAccountElectionStatus,
graphql_name="alertsUpdateCrossAccountElections",
args=sgqlc.types.ArgDict(
(
(
"account_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Int))
),
graphql_name="accountIds",
default=None,
),
),
(
"election_status",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="electionStatus",
default=None,
),
),
)
),
)
"""Arguments:
* `account_ids` (`[Int!]!`): Account IDs. (maximum 20)
* `election_status` (`Boolean!`): The new election status for the
accounts.
"""
api_access_create_keys = sgqlc.types.Field(
ApiAccessCreateKeyResponse,
graphql_name="apiAccessCreateKeys",
args=sgqlc.types.ArgDict(
(
(
"keys",
sgqlc.types.Arg(
sgqlc.types.non_null(ApiAccessCreateInput),
graphql_name="keys",
default=None,
),
),
)
),
)
"""Arguments:
* `keys` (`ApiAccessCreateInput!`): A list of the configurations
for each key you want to create.
"""
api_access_delete_keys = sgqlc.types.Field(
ApiAccessDeleteKeyResponse,
graphql_name="apiAccessDeleteKeys",
args=sgqlc.types.ArgDict(
(
(
"keys",
sgqlc.types.Arg(
sgqlc.types.non_null(ApiAccessDeleteInput),
graphql_name="keys",
default=None,
),
),
)
),
)
"""Arguments:
* `keys` (`ApiAccessDeleteInput!`): A list of each key `id` that
you want to delete. You can read more about managing keys on
[this documentation page](https://docs.newrelic.com/docs/apis/ne
rdgraph/examples/use-nerdgraph-manage-license-keys-personal-api-
keys).
"""
api_access_update_keys = sgqlc.types.Field(
ApiAccessUpdateKeyResponse,
graphql_name="apiAccessUpdateKeys",
args=sgqlc.types.ArgDict(
(
(
"keys",
sgqlc.types.Arg(
sgqlc.types.non_null(ApiAccessUpdateInput),
graphql_name="keys",
default=None,
),
),
)
),
)
"""Arguments:
* `keys` (`ApiAccessUpdateInput!`): The configurations of each key
you want to update.
"""
authentication_domain_delete = sgqlc.types.Field(
AuthenticationDomainType,
graphql_name="authenticationDomainDelete",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
authorization_management_grant_access = sgqlc.types.Field(
AuthorizationManagementGrantAccessPayload,
graphql_name="authorizationManagementGrantAccess",
args=sgqlc.types.ArgDict(
(
(
"grant_access_options",
sgqlc.types.Arg(
AuthorizationManagementGrantAccess,
graphql_name="grantAccessOptions",
default=None,
),
),
)
),
)
authorization_management_revoke_access = sgqlc.types.Field(
AuthorizationManagementRevokeAccessPayload,
graphql_name="authorizationManagementRevokeAccess",
args=sgqlc.types.ArgDict(
(
(
"revoke_access_options",
sgqlc.types.Arg(
AuthorizationManagementRevokeAccess,
graphql_name="revokeAccessOptions",
default=None,
),
),
)
),
)
authorization_management_update_access = sgqlc.types.Field(
AuthorizationManagementUpdateAccessPayload,
graphql_name="authorizationManagementUpdateAccess",
args=sgqlc.types.ArgDict(
(
(
"update_access_options",
sgqlc.types.Arg(
sgqlc.types.non_null(AuthorizationManagementUpdateAccess),
graphql_name="updateAccessOptions",
default=None,
),
),
)
),
)
change_tracking_create_deployment = sgqlc.types.Field(
ChangeTrackingDeployment,
graphql_name="changeTrackingCreateDeployment",
args=sgqlc.types.ArgDict(
(
(
"data_handling_rules",
sgqlc.types.Arg(
ChangeTrackingDataHandlingRules,
graphql_name="dataHandlingRules",
default=None,
),
),
(
"deployment",
sgqlc.types.Arg(
sgqlc.types.non_null(ChangeTrackingDeploymentInput),
graphql_name="deployment",
default=None,
),
),
)
),
)
"""Arguments:
* `data_handling_rules` (`ChangeTrackingDataHandlingRules`):
Specify how you would like the API to handle validation
failures. Currently, the following validations should be
considered: - Text fields must be less than 4,096 characters and
encoded as UTF-8. By default, they will be trimmed with an UTF-8
ellipses character (…) placed at the end. - Failures to update
the legacy REST API for APM entities can be used to determine
whether the mutation should proceed.
* `deployment` (`ChangeTrackingDeploymentInput!`): The deployment
to create.
"""
change_tracking_create_event = sgqlc.types.Field(
ChangeTrackingCreateEventResponse,
graphql_name="changeTrackingCreateEvent",
args=sgqlc.types.ArgDict(
(
(
"change_tracking_event",
sgqlc.types.Arg(
sgqlc.types.non_null(ChangeTrackingCreateEventInput),
graphql_name="changeTrackingEvent",
default=None,
),
),
(
"data_handling_rules",
sgqlc.types.Arg(
ChangeTrackingDataHandlingRules,
graphql_name="dataHandlingRules",
default=None,
),
),
)
),
)
"""Arguments:
* `change_tracking_event` (`ChangeTrackingCreateEventInput!`): The
data describing the change tracking event. For more information
on these input fields, [see our
docs](https://docs.newrelic.com/docs/change-tracking/change-
tracking-events/#change-tracking-event-mutation).
* `data_handling_rules` (`ChangeTrackingDataHandlingRules`):
Specify how you would like the API to handle validation
failures. Currently, the following validations should be
considered: - Text fields must be less than 4,096 characters and
encoded as UTF-8. By default, they will be trimmed with an UTF-8
ellipses character (…) placed at the end. - Failures to update
the legacy REST API for APM entities can be used to determine
whether the mutation should proceed. - Events with categories or
types that do not match the [default supported
types](https://docs.newrelic.com/docs/change-tracking/change-
tracking-events/#supported-types) will fail unless passed the
`ALLOW_CUSTOM_CATEGORY_OR_TYPE` flag.
"""
cloud_configure_integration = sgqlc.types.Field(
CloudConfigureIntegrationPayload,
graphql_name="cloudConfigureIntegration",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"integrations",
sgqlc.types.Arg(
sgqlc.types.non_null(CloudIntegrationsInput),
graphql_name="integrations",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `integrations` (`CloudIntegrationsInput!`): The cloud
integrations you want to configure.
"""
cloud_disable_integration = sgqlc.types.Field(
CloudDisableIntegrationPayload,
graphql_name="cloudDisableIntegration",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"integrations",
sgqlc.types.Arg(
CloudDisableIntegrationsInput,
graphql_name="integrations",
default=None,
),
),
)
),
)
cloud_link_account = sgqlc.types.Field(
CloudLinkAccountPayload,
graphql_name="cloudLinkAccount",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"accounts",
sgqlc.types.Arg(
CloudLinkCloudAccountsInput,
graphql_name="accounts",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `accounts` (`CloudLinkCloudAccountsInput`): The cloud provider
account you want to link to your New Relic account.
"""
cloud_migrate_aws_gov_cloud_to_assume_role = sgqlc.types.Field(
CloudMigrateAwsGovCloudToAssumeRolePayload,
graphql_name="cloudMigrateAwsGovCloudToAssumeRole",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
CloudAwsGovCloudMigrateToAssumeroleInput
)
)
),
graphql_name="accounts",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `accounts` (`[CloudAwsGovCloudMigrateToAssumeroleInput!]!`): One
or multiple ARNs for the IAM Role for the different accounts.
"""
cloud_oci_generate_instrumented_payload_url = sgqlc.types.Field(
CloudOciInstrumentedPayloadUrlPayload,
graphql_name="cloudOciGenerateInstrumentedPayloadUrl",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"linked_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="linkedAccountId",
default=None,
),
),
(
"oci_region",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociRegion",
default=None,
),
),
(
"payload",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(CloudOciInstrumentedPayloadInput)
),
graphql_name="payload",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID.
* `linked_account_id` (`Int!`): The linked account identifier.
* `oci_region` (`String!`): The OCI instrumentation region.
* `payload` (`[CloudOciInstrumentedPayloadInput]!`): The payload
describing the OCI instrumentation request.
"""
cloud_oci_generate_log_group_instrumented_payload_url = sgqlc.types.Field(
CloudOciLogGroupInstrumentedPayloadUrlPayload,
graphql_name="cloudOciGenerateLogGroupInstrumentedPayloadUrl",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"linked_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="linkedAccountId",
default=None,
),
),
(
"log_group_payload",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
CloudOciLogGroupInstrumentedPayloadInput
)
)
),
graphql_name="logGroupPayload",
default=None,
),
),
(
"oci_region",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociRegion",
default=None,
),
),
(
"oci_tenant_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="ociTenantId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `linked_account_id` (`Int!`): The linked account identifier.
* `log_group_payload`
(`[CloudOciLogGroupInstrumentedPayloadInput!]!`): The payload
describing the OCI instrumentation request.
* `oci_region` (`String!`): The OCI instrumentation region.
* `oci_tenant_id` (`String!`): The OCI tenant identifier.
"""
cloud_rename_account = sgqlc.types.Field(
CloudRenameAccountPayload,
graphql_name="cloudRenameAccount",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.list_of(CloudRenameAccountsInput),
graphql_name="accounts",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `accounts` (`[CloudRenameAccountsInput]`): The cloud provider
account you want to rename.
"""
cloud_unlink_account = sgqlc.types.Field(
CloudUnlinkAccountPayload,
graphql_name="cloudUnlinkAccount",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.list_of(CloudUnlinkAccountsInput),
graphql_name="accounts",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID
* `accounts` (`[CloudUnlinkAccountsInput]`): The cloud provider
accounts you want to unlink.
"""
cloud_update_account = sgqlc.types.Field(
CloudUpdateAccountPayload,
graphql_name="cloudUpdateAccount",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"accounts",
sgqlc.types.Arg(
sgqlc.types.non_null(CloudUpdateCloudAccountsInput),
graphql_name="accounts",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Your New Relic account ID.
* `accounts` (`CloudUpdateCloudAccountsInput!`): The desired cloud
accounts to be updated.
"""
collaboration_create_code_mark = sgqlc.types.Field(
CollaborationCodeMark,
graphql_name="collaborationCreateCodeMark",
args=sgqlc.types.ArgDict(
(
(
"code",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="code", default=None
),
),
(
"file",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="file", default=None
),
),
(
"permalink",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="permalink",
default=None,
),
),
(
"repo",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="repo", default=None
),
),
(
"sha",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="sha", default=None
),
),
)
),
)
collaboration_create_comment = sgqlc.types.Field(
CollaborationComment,
graphql_name="collaborationCreateComment",
args=sgqlc.types.ArgDict(
(
(
"assistant",
sgqlc.types.Arg(String, graphql_name="assistant", default=None),
),
(
"assistant_config",
sgqlc.types.Arg(
sgqlc.types.list_of(CollaborationAssistantConfigInput),
graphql_name="assistantConfig",
default=None,
),
),
(
"body",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="body", default=None
),
),
(
"capability_id",
sgqlc.types.Arg(String, graphql_name="capabilityId", default=None),
),
(
"context_metadata",
sgqlc.types.Arg(
CollaborationRawContextMetadata,
graphql_name="contextMetadata",
default=None,
),
),
(
"destination_id",
sgqlc.types.Arg(String, graphql_name="destinationId", default=None),
),
(
"display_name",
sgqlc.types.Arg(String, graphql_name="displayName", default=None),
),
(
"n_rconnection_id",
sgqlc.types.Arg(
String, graphql_name="nRConnectionId", default=None
),
),
(
"reference_url",
sgqlc.types.Arg(String, graphql_name="referenceUrl", default=None),
),
(
"slack_channel_id",
sgqlc.types.Arg(
String, graphql_name="slackChannelId", default=None
),
),
(
"suppress3rd_party_file_share",
sgqlc.types.Arg(
Boolean, graphql_name="suppress3rdPartyFileShare", default=None
),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
(
"time_picker_from",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="timePickerFrom", default=None
),
),
(
"time_picker_to",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="timePickerTo", default=None
),
),
)
),
)
"""Arguments:
* `assistant` (`String`): Type of assistant
* `assistant_config` (`[CollaborationAssistantConfigInput]`):
Configuration for assistant
* `body` (`String!`): The message of the comment
* `capability_id` (`String`): Capability Id at the time of comment
creation
* `context_metadata` (`CollaborationRawContextMetadata`): Metadata
to add to the comment
* `destination_id` (`String`): Optional destination Id to send the
comment to
* `display_name` (`String`): Display name at the time of comment
creation
* `n_rconnection_id` (`String`): Websocket Connection Id
* `reference_url` (`String`): Reference URL of the comment
* `slack_channel_id` (`String`): Optional Slack Channel Id to send
the comment to
* `suppress3rd_party_file_share` (`Boolean`): Optional flag if
true, do not share files/screenshots/thumbnails via email, slack
or other future 3rd parties
* `thread_id` (`ID!`): Thread ID where the comment will live
* `time_picker_from` (`EpochMilliseconds`): Optional time picker
start time
* `time_picker_to` (`EpochMilliseconds`): Optional time picker end
time
"""
collaboration_create_context = sgqlc.types.Field(
CollaborationContext,
graphql_name="collaborationCreateContext",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(Int, graphql_name="accountId", default=None),
),
(
"context_metadata",
sgqlc.types.Arg(
CollaborationRawContextMetadata,
graphql_name="contextMetadata",
default=None,
),
),
(
"entity_guid",
sgqlc.types.Arg(
EntityGuid, graphql_name="entityGuid", default=None
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"reference_url",
sgqlc.types.Arg(String, graphql_name="referenceUrl", default=None),
),
)
),
)
collaboration_create_email = sgqlc.types.Field(
CollaborationEmail,
graphql_name="collaborationCreateEmail",
args=sgqlc.types.ArgDict(
(
(
"email_address",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="emailAddress",
default=None,
),
),
)
),
)
collaboration_create_external_service_connection = sgqlc.types.Field(
CollaborationExternalServiceConnection,
graphql_name="collaborationCreateExternalServiceConnection",
args=sgqlc.types.ArgDict(
(
(
"channel_id",
sgqlc.types.Arg(ID, graphql_name="channelId", default=None),
),
(
"external_id",
sgqlc.types.Arg(ID, graphql_name="externalId", default=None),
),
(
"session_id",
sgqlc.types.Arg(ID, graphql_name="sessionId", default=None),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="type", default=None
),
),
)
),
)
"""Arguments:
* `channel_id` (`ID`): Optional 3rd party channel ID
* `external_id` (`ID`): External ID provided by the external
service
* `session_id` (`ID`): Session ID provided by the notifications
gateway when creating the first external message
* `thread_id` (`ID!`): Thread ID where messages from the external
service will be created
* `type` (`String!`): Connection type. One of ['SLACK', 'TEAMS',
'EMAIL']
"""
collaboration_create_mention = sgqlc.types.Field(
CollaborationMention,
graphql_name="collaborationCreateMention",
args=sgqlc.types.ArgDict(
(
(
"comment_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="commentId", default=None
),
),
(
"external_application_type",
sgqlc.types.Arg(
CollaborationExternalApplicationType,
graphql_name="externalApplicationType",
default=None,
),
),
(
"external_creator_id",
sgqlc.types.Arg(ID, graphql_name="externalCreatorId", default=None),
),
(
"mentionable_item_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="mentionableItemId",
default=None,
),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="type", default=None
),
),
)
),
)
"""Arguments:
* `comment_id` (`ID!`): Comment ID where the item ie mentioned
* `external_application_type`
(`CollaborationExternalApplicationType`): The type of external
application associated with this mention (e.g.: SLACK)
* `external_creator_id` (`ID`): The user id of the user mentioning
this item
* `mentionable_item_id` (`ID!`): The ID of the item being
mentioned
* `type` (`String!`): The type of thing being mentioned
"""
collaboration_create_thread = sgqlc.types.Field(
CollaborationThread,
graphql_name="collaborationCreateThread",
args=sgqlc.types.ArgDict(
(
(
"context_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="contextId", default=None
),
),
(
"context_metadata",
sgqlc.types.Arg(
CollaborationRawContextMetadata,
graphql_name="contextMetadata",
default=None,
),
),
(
"external_application_type",
sgqlc.types.Arg(
String, graphql_name="externalApplicationType", default=None
),
),
(
"reference_url",
sgqlc.types.Arg(String, graphql_name="referenceUrl", default=None),
),
(
"visibility",
sgqlc.types.Arg(String, graphql_name="visibility", default=None),
),
)
),
)
"""Arguments:
* `context_id` (`ID!`): Context ID the thread should associate
with
* `context_metadata` (`CollaborationRawContextMetadata`): Metadata
to add to thread
* `external_application_type` (`String`): Indicate that thread is
linked to a external application type
* `reference_url` (`String`): Reference URL
* `visibility` (`String`): Indicate a PRIVATE, or CUSTOMER_SERVICE
thread
"""
collaboration_deactivate_code_mark = sgqlc.types.Field(
CollaborationCodeMark,
graphql_name="collaborationDeactivateCodeMark",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_comment = sgqlc.types.Field(
CollaborationComment,
graphql_name="collaborationDeactivateComment",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_context = sgqlc.types.Field(
CollaborationContext,
graphql_name="collaborationDeactivateContext",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_external_service_connection = sgqlc.types.Field(
CollaborationExternalServiceConnection,
graphql_name="collaborationDeactivateExternalServiceConnection",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_file = sgqlc.types.Field(
String,
graphql_name="collaborationDeactivateFile",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_mention = sgqlc.types.Field(
CollaborationMention,
graphql_name="collaborationDeactivateMention",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_deactivate_thread = sgqlc.types.Field(
CollaborationThread,
graphql_name="collaborationDeactivateThread",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_feedback_on_bot_response = sgqlc.types.Field(
CollaborationBotResponseFeedback,
graphql_name="collaborationFeedbackOnBotResponse",
args=sgqlc.types.ArgDict(
(
(
"content",
sgqlc.types.Arg(String, graphql_name="content", default=None),
),
(
"rating",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="rating", default=None
),
),
(
"response_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="responseId",
default=None,
),
),
)
),
)
collaboration_get_upload_url = sgqlc.types.Field(
CollaborationFile,
graphql_name="collaborationGetUploadUrl",
args=sgqlc.types.ArgDict(
(
(
"file_name",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="fileName", default=None
),
),
(
"is_screenshot",
sgqlc.types.Arg(Boolean, graphql_name="isScreenshot", default=None),
),
)
),
)
collaboration_register_email = sgqlc.types.Field(
CollaborationEmail, graphql_name="collaborationRegisterEmail"
)
collaboration_send_message = sgqlc.types.Field(
CollaborationMessageSent,
graphql_name="collaborationSendMessage",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"body",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="body", default=None
),
),
(
"destination_id",
sgqlc.types.Arg(String, graphql_name="destinationId", default=None),
),
(
"email_addresses",
sgqlc.types.Arg(
sgqlc.types.list_of(String),
graphql_name="emailAddresses",
default=None,
),
),
(
"reference_url",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="referenceUrl",
default=None,
),
),
(
"shared_to_type",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="sharedToType",
default=None,
),
),
(
"slack_channel_id",
sgqlc.types.Arg(
String, graphql_name="slackChannelId", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account that owns the message
* `body` (`String!`): The content of the message
* `destination_id` (`String`): Optional destination Id to send the
message to
* `email_addresses` (`[String]`): Optional email addresses to send
the message to
* `reference_url` (`String!`): Reference URL of the message
* `shared_to_type` (`String!`): message destination type
* `slack_channel_id` (`String`): Optional Slack Channel Id to send
the message to
"""
collaboration_set_external_service_connection_channel = sgqlc.types.Field(
CollaborationExternalServiceConnection,
graphql_name="collaborationSetExternalServiceConnectionChannel",
args=sgqlc.types.ArgDict(
(
(
"channel_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="channelId", default=None
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_socket_subscribe = sgqlc.types.Field(
String,
graphql_name="collaborationSocketSubscribe",
args=sgqlc.types.ArgDict(
(
(
"nr_connection_id",
sgqlc.types.Arg(
String, graphql_name="nrConnectionId", default=None
),
),
(
"subscription_keys",
sgqlc.types.Arg(
sgqlc.types.list_of(String),
graphql_name="subscriptionKeys",
default=None,
),
),
)
),
)
"""Arguments:
* `nr_connection_id` (`String`): New Relic Connection ID
* `subscription_keys` (`[String]`): An array of subscription keys
to subscribe to
"""
collaboration_subscribe_to_thread = sgqlc.types.Field(
CollaborationSubscriber,
graphql_name="collaborationSubscribeToThread",
args=sgqlc.types.ArgDict(
(
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
("user_id", sgqlc.types.Arg(ID, graphql_name="userId", default=None)),
)
),
)
collaboration_unsubscribe_from_thread = sgqlc.types.Field(
CollaborationSubscriber,
graphql_name="collaborationUnsubscribeFromThread",
args=sgqlc.types.ArgDict(
(
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
)
),
)
collaboration_update_comment = sgqlc.types.Field(
CollaborationComment,
graphql_name="collaborationUpdateComment",
args=sgqlc.types.ArgDict(
(
(
"body",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="body", default=None
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_update_context_add_comment = sgqlc.types.Field(
CollaborationContext,
graphql_name="collaborationUpdateContextAddComment",
args=sgqlc.types.ArgDict(
(
(
"comment_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="commentId", default=None
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
collaboration_update_context_add_thread = sgqlc.types.Field(
CollaborationContext,
graphql_name="collaborationUpdateContextAddThread",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
)
),
)
collaboration_update_subscription_read_info = sgqlc.types.Field(
CollaborationSubscriber,
graphql_name="collaborationUpdateSubscriptionReadInfo",
args=sgqlc.types.ArgDict(
(
(
"comments_read_count",
sgqlc.types.Arg(
Int, graphql_name="commentsReadCount", default=None
),
),
(
"last_comment_read_id",
sgqlc.types.Arg(ID, graphql_name="lastCommentReadId", default=None),
),
(
"mentions_read_count",
sgqlc.types.Arg(
Int, graphql_name="mentionsReadCount", default=None
),
),
(
"thread_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="threadId", default=None
),
),
)
),
)
collaboration_update_thread_add_comment = sgqlc.types.Field(
CollaborationThread,
graphql_name="collaborationUpdateThreadAddComment",
args=sgqlc.types.ArgDict(
(
(
"comment_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="commentId", default=None
),
),
)
),
)
collaboration_update_thread_status = sgqlc.types.Field(
CollaborationThread,
graphql_name="collaborationUpdateThreadStatus",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"status",
sgqlc.types.Arg(
CollaborationStatus, graphql_name="status", default=None
),
),
)
),
)
custom_role_create = sgqlc.types.Field(
CustomRoleRoleMutationResult,
graphql_name="customRoleCreate",
args=sgqlc.types.ArgDict(
(
(
"container",
sgqlc.types.Arg(
sgqlc.types.non_null(CustomRoleContainerInput),
graphql_name="container",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"permission_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Int))
),
graphql_name="permissionIds",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="scope", default=None
),
),
)
),
)
"""Arguments:
* `container` (`CustomRoleContainerInput!`): The container the
role is being created in (organization)
* `name` (`String!`): The name of the custom role
* `permission_ids` (`[Int!]!`): The IDs of the permissions this
role will grant
* `scope` (`String!`): The authorization scope this role will
grant permissions
"""
custom_role_delete = sgqlc.types.Field(
CustomRoleRoleMutationResult,
graphql_name="customRoleDelete",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
custom_role_update = sgqlc.types.Field(
CustomRoleRoleMutationResult,
graphql_name="customRoleUpdate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"permission_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(Int),
graphql_name="permissionIds",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`Int!`): The ID of the custom role to update
* `name` (`String`): The new name of the custom role
* `permission_ids` (`[Int]`): The new IDs of the permissions this
role will grant. This will replace the existing permissions
assigned to this role
"""
dashboard_add_widgets_to_page = sgqlc.types.Field(
DashboardAddWidgetsToPageResult,
graphql_name="dashboardAddWidgetsToPage",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"widgets",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(DashboardWidgetInput)
)
),
graphql_name="widgets",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardPage` where widgets will be added.
* `widgets` (`[DashboardWidgetInput!]!`): Widgets input holding
all required widgets data.
"""
dashboard_create = sgqlc.types.Field(
DashboardCreateResult,
graphql_name="dashboardCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"dashboard",
sgqlc.types.Arg(
sgqlc.types.non_null(DashboardInput),
graphql_name="dashboard",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID where the `DashboardEntity`
will be created.
* `dashboard` (`DashboardInput!`): Dashboard input holding all
required `DashboardEntity` data.
"""
dashboard_create_live_url = sgqlc.types.Field(
DashboardLiveUrl,
graphql_name="dashboardCreateLiveUrl",
args=sgqlc.types.ArgDict(
(
(
"auth",
sgqlc.types.Arg(
DashboardLiveUrlAuthCreationInput,
graphql_name="auth",
default=None,
),
),
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"options",
sgqlc.types.Arg(
DashboardLiveUrlOptionsInput,
graphql_name="options",
default=None,
),
),
)
),
)
"""Arguments:
* `auth` (`DashboardLiveUrlAuthCreationInput`): The auth policies
that will be used to protect the Live URL
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardEntity` to be accessed through a public URL.
* `options` (`DashboardLiveUrlOptionsInput`): Options to configure
the live url when is created
"""
dashboard_create_snapshot_url = sgqlc.types.Field(
String,
graphql_name="dashboardCreateSnapshotUrl",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"params",
sgqlc.types.Arg(
DashboardSnapshotUrlInput, graphql_name="params", default=None
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardPage` to be accessed as a snapshot through a public
URL.
* `params` (`DashboardSnapshotUrlInput`): Optional input
parameters for the generated snapshot.
"""
dashboard_delete = sgqlc.types.Field(
DashboardDeleteResult,
graphql_name="dashboardDelete",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardEntity` to be deleted. A dashboard guid must be
specified. Dashboard page guids are not supported.
"""
dashboard_reset_live_url_password = sgqlc.types.Field(
DashboardResetLiveUrlPasswordResult,
graphql_name="dashboardResetLiveUrlPassword",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): the unique identifier of the public live URL to
reset the password.
"""
dashboard_revoke_live_url = sgqlc.types.Field(
DashboardRevokeLiveDashboardUrlResult,
graphql_name="dashboardRevokeLiveUrl",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The unique identifier of the public live dashboard
URL to be revoked.
"""
dashboard_undelete = sgqlc.types.Field(
DashboardUndeleteResult,
graphql_name="dashboardUndelete",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardEntity` to be undeleted. A dashboard guid must be
specified. Dashboard page guids are not supported.
"""
dashboard_update = sgqlc.types.Field(
DashboardUpdateResult,
graphql_name="dashboardUpdate",
args=sgqlc.types.ArgDict(
(
(
"dashboard",
sgqlc.types.Arg(
sgqlc.types.non_null(DashboardInput),
graphql_name="dashboard",
default=None,
),
),
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `dashboard` (`DashboardInput!`): Dashboard input holding all
required data from an existing `DashboardEntity`.
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardEntity` to be updated.
"""
dashboard_update_live_url = sgqlc.types.Field(
DashboardLiveUrl,
graphql_name="dashboardUpdateLiveUrl",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"options",
sgqlc.types.Arg(
DashboardLiveUrlOptionsInput,
graphql_name="options",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The unique identifier of the public live URL to be
updated.
* `options` (`DashboardLiveUrlOptionsInput`): Options to configure
the live url when is updated
"""
dashboard_update_live_url_auth = sgqlc.types.Field(
DashboardLiveUrlAuth,
graphql_name="dashboardUpdateLiveUrlAuth",
args=sgqlc.types.ArgDict(
(
(
"auth",
sgqlc.types.Arg(
sgqlc.types.non_null(DashboardLiveUrlAuthUpdateInput),
graphql_name="auth",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `auth` (`DashboardLiveUrlAuthUpdateInput!`): The auth policies
that will be used to protect the Live URL
* `id` (`ID!`): The unique identifier of the public live URL to be
updated.
"""
dashboard_update_live_url_creation_policies = sgqlc.types.Field(
DashboardLiveUrlCreationPoliciesResult,
graphql_name="dashboardUpdateLiveUrlCreationPolicies",
args=sgqlc.types.ArgDict(
(
(
"policies",
sgqlc.types.Arg(
sgqlc.types.non_null(
DashboardUpdateLiveUrlCreationPoliciesInput
),
graphql_name="policies",
default=None,
),
),
)
),
)
"""Arguments:
* `policies` (`DashboardUpdateLiveUrlCreationPoliciesInput!`):
Parameters for setting the live url creation policies.
"""
dashboard_update_page = sgqlc.types.Field(
DashboardUpdatePageResult,
graphql_name="dashboardUpdatePage",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"page",
sgqlc.types.Arg(
sgqlc.types.non_null(DashboardUpdatePageInput),
graphql_name="page",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the Page to
be updated.
* `page` (`DashboardUpdatePageInput!`): Page input holding all
required data to update a page.
"""
dashboard_update_widgets_in_page = sgqlc.types.Field(
DashboardUpdateWidgetsInPageResult,
graphql_name="dashboardUpdateWidgetsInPage",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"widgets",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(DashboardUpdateWidgetInput)
)
),
graphql_name="widgets",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): Unique entity identifier of the
`DashboardPage` where widgets will be updated.
* `widgets` (`[DashboardUpdateWidgetInput!]!`): Widgets input
holding all required widgets data.
"""
dashboard_widget_revoke_live_url = sgqlc.types.Field(
DashboardRevokeLiveUrlResult,
graphql_name="dashboardWidgetRevokeLiveUrl",
args=sgqlc.types.ArgDict(
(
(
"uuid",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="uuid", default=None
),
),
)
),
)
"""Arguments:
* `uuid` (`ID!`): The unique identifier of the public live URL to
be revoked.
"""
data_access_policy_create = sgqlc.types.Field(
DataAccessPolicyCreatePayload,
graphql_name="dataAccessPolicyCreate",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"organization_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="organizationId",
default=None,
),
),
(
"policy",
sgqlc.types.Arg(
sgqlc.types.non_null(DataAccessPolicyRawDocument),
graphql_name="policy",
default=None,
),
),
(
"version",
sgqlc.types.Arg(String, graphql_name="version", default=None),
),
)
),
)
"""Arguments:
* `name` (`String!`): The name of the data access policy.
* `organization_id` (`ID!`): The ID of the organization associated
with the policy.
* `policy` (`DataAccessPolicyRawDocument!`): The policy details,
including event types to allow or except.
* `version` (`String`): The version of the policy.
"""
data_access_policy_delete = sgqlc.types.Field(
DataAccessPolicyDeletePayload,
graphql_name="dataAccessPolicyDelete",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The unique identifier of the policy to delete.
"""
data_access_policy_update = sgqlc.types.Field(
DataAccessPolicyUpdatePayload,
graphql_name="dataAccessPolicyUpdate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"policy",
sgqlc.types.Arg(
DataAccessPolicyRawDocument, graphql_name="policy", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The unique identifier of the policy to update.
* `name` (`String`): The updated name of the data access policy.
* `policy` (`DataAccessPolicyRawDocument`): The updated policy
details, including event types.
"""
data_management_copy_retentions = sgqlc.types.Field(
DataManagementBulkCopyResult,
graphql_name="dataManagementCopyRetentions",
args=sgqlc.types.ArgDict(
(
(
"destination_account_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(Int)),
graphql_name="destinationAccountIds",
default=None,
),
),
(
"source_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="sourceAccountId",
default=None,
),
),
)
),
)
"""Arguments:
* `destination_account_ids` (`[Int]!`): A list of IDs for the
accounts that should have the source account retentions applied.
* `source_account_id` (`Int!`): The ID of the source account
"""
data_management_create_account_limit = sgqlc.types.Field(
DataManagementAccountLimit,
graphql_name="dataManagementCreateAccountLimit",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"account_limit",
sgqlc.types.Arg(
DataManagementAccountLimitInput,
graphql_name="accountLimit",
default=None,
),
),
)
),
)
data_management_create_event_retention_rule = sgqlc.types.Field(
DataManagementRule,
graphql_name="dataManagementCreateEventRetentionRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"namespace",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="namespace",
default=None,
),
),
(
"retention_in_days",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="retentionInDays",
default=None,
),
),
)
),
)
data_management_create_organization_limit = sgqlc.types.Field(
DataManagementLimitOverride,
graphql_name="dataManagementCreateOrganizationLimit",
args=sgqlc.types.ArgDict(
(
(
"organization_limit",
sgqlc.types.Arg(
DataManagementOrganizationLimitInput,
graphql_name="organizationLimit",
default=None,
),
),
)
),
)
data_management_create_retention_rules = sgqlc.types.Field(
sgqlc.types.list_of(DataManagementRule),
graphql_name="dataManagementCreateRetentionRules",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"retention_rules",
sgqlc.types.Arg(
sgqlc.types.list_of(DataManagementRuleInput),
graphql_name="retentionRules",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The ID of the account the new retention
rules will apply to
* `retention_rules` (`[DataManagementRuleInput]`): List of
rule_input params (:namespace, :retention_in_days) for new rules
to be created
"""
data_management_delete_event_retention_rule = sgqlc.types.Field(
DataManagementRule,
graphql_name="dataManagementDeleteEventRetentionRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"namespace",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="namespace",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The ID of the event retention rule's
account
* `namespace` (`String!`): The event retention rule's namespace
"""
data_management_expire_organization_limit = sgqlc.types.Field(
DataManagementLimitOverride,
graphql_name="dataManagementExpireOrganizationLimit",
args=sgqlc.types.ArgDict(
(
(
"organization_limit",
sgqlc.types.Arg(
DataManagementOrganizationLimitLookupInput,
graphql_name="organizationLimit",
default=None,
),
),
)
),
)
data_management_update_feature_settings = sgqlc.types.Field(
DataManagementFeatureSetting,
graphql_name="dataManagementUpdateFeatureSettings",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"setting",
sgqlc.types.Arg(
DataManagementAccountFeatureSettingInput,
graphql_name="setting",
default=None,
),
),
)
),
)
edge_create_trace_filter_rules = sgqlc.types.Field(
sgqlc.types.non_null(EdgeCreateTraceFilterRuleResponses),
graphql_name="edgeCreateTraceFilterRules",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rules",
sgqlc.types.Arg(
sgqlc.types.non_null(EdgeCreateTraceFilterRulesInput),
graphql_name="rules",
default=None,
),
),
(
"trace_observer_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="traceObserverId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): ID of the account in the account family
the trace observer belongs to.
* `rules` (`EdgeCreateTraceFilterRulesInput!`): A grouping of
trace filter rule configurations
* `trace_observer_id` (`Int!`): ID of the trace observer to apply
the trace filter(s) to.
"""
edge_create_trace_observer = sgqlc.types.Field(
sgqlc.types.non_null(EdgeCreateTraceObserverResponses),
graphql_name="edgeCreateTraceObserver",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"trace_observer_configs",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EdgeCreateTraceObserverInput)
)
),
graphql_name="traceObserverConfigs",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): ID of the account in the account family
the trace observer(s) belong to.
* `trace_observer_configs` (`[EdgeCreateTraceObserverInput!]!`):
One or more `CreateTraceObserverInput` that describe the trace
observer to be created.
"""
edge_delete_trace_filter_rules = sgqlc.types.Field(
sgqlc.types.non_null(EdgeDeleteTraceFilterRuleResponses),
graphql_name="edgeDeleteTraceFilterRules",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rules",
sgqlc.types.Arg(
sgqlc.types.non_null(EdgeDeleteTraceFilterRulesInput),
graphql_name="rules",
default=None,
),
),
(
"trace_observer_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="traceObserverId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): ID of the account in the account family
the trace observer belongs to.
* `rules` (`EdgeDeleteTraceFilterRulesInput!`): A grouping of
trace filter rule configurations
* `trace_observer_id` (`Int!`): ID of the trace observer to remove
the provided trace filter(s) from.
"""
edge_delete_trace_observers = sgqlc.types.Field(
sgqlc.types.non_null(EdgeDeleteTraceObserverResponses),
graphql_name="edgeDeleteTraceObservers",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"trace_observer_configs",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EdgeDeleteTraceObserverInput)
)
),
graphql_name="traceObserverConfigs",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): ID of the account in the account family
the trace observer(s) belong to.
* `trace_observer_configs` (`[EdgeDeleteTraceObserverInput!]!`):
One or more `DeleteTraceObserverInput` that describe the trace
observer to be deleted.
"""
edge_update_trace_observers = sgqlc.types.Field(
sgqlc.types.non_null(EdgeUpdateTraceObserverResponses),
graphql_name="edgeUpdateTraceObservers",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"trace_observer_configs",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EdgeUpdateTraceObserverInput)
)
),
graphql_name="traceObserverConfigs",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): ID of the account in the account family
the trace observer(s) belong to.
* `trace_observer_configs` (`[EdgeUpdateTraceObserverInput!]!`):
One or more `UpdateTraceObserverInput` that describe the trace
observer to be updated.
"""
entity_delete = sgqlc.types.Field(
EntityDeleteResult,
graphql_name="entityDelete",
args=sgqlc.types.ArgDict(
(
(
"force_delete",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="forceDelete",
default=False,
),
),
(
"guids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityGuid))
),
graphql_name="guids",
default=None,
),
),
)
),
)
"""Arguments:
* `force_delete` (`Boolean!`): Set to true to skip safety checks
and force-delete the entity (default: `false`)
* `guids` (`[EntityGuid!]!`): List of guids to be deleted
"""
entity_golden_metrics_override = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenMetricsDomainTypeScopedResponse),
graphql_name="entityGoldenMetricsOverride",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGoldenContextInput),
graphql_name="context",
default=None,
),
),
(
"domain_type",
sgqlc.types.Arg(
sgqlc.types.non_null(DomainTypeInput),
graphql_name="domainType",
default=None,
),
),
(
"metrics",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityGoldenMetricInput)
)
),
graphql_name="metrics",
default=None,
),
),
)
),
)
"""Arguments:
* `context` (`EntityGoldenContextInput!`): Context to scope the
golden metrics
* `domain_type` (`DomainTypeInput!`): Entity Domain Type to
override the golden metrics
* `metrics` (`[EntityGoldenMetricInput!]!`): The new golden
metrics by the entity domain type and the context
"""
entity_golden_metrics_reset = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenMetricsDomainTypeScopedResponse),
graphql_name="entityGoldenMetricsReset",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGoldenContextInput),
graphql_name="context",
default=None,
),
),
(
"domain_type",
sgqlc.types.Arg(
sgqlc.types.non_null(DomainTypeInput),
graphql_name="domainType",
default=None,
),
),
)
),
)
entity_golden_tags_override = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenTagsDomainTypeScopedResponse),
graphql_name="entityGoldenTagsOverride",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGoldenContextInput),
graphql_name="context",
default=None,
),
),
(
"domain_type",
sgqlc.types.Arg(
sgqlc.types.non_null(DomainTypeInput),
graphql_name="domainType",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityGoldenTagInput)
)
),
graphql_name="tags",
default=None,
),
),
)
),
)
"""Arguments:
* `context` (`EntityGoldenContextInput!`): Context to scope the
golden metrics
* `domain_type` (`DomainTypeInput!`): Entity Domain Type to
override the golden tags
* `tags` (`[EntityGoldenTagInput!]!`): The new golden tags by the
entity domain type and the tags
"""
entity_golden_tags_reset = sgqlc.types.Field(
sgqlc.types.non_null(EntityGoldenTagsDomainTypeScopedResponse),
graphql_name="entityGoldenTagsReset",
args=sgqlc.types.ArgDict(
(
(
"context",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGoldenContextInput),
graphql_name="context",
default=None,
),
),
(
"domain_type",
sgqlc.types.Arg(
sgqlc.types.non_null(DomainTypeInput),
graphql_name="domainType",
default=None,
),
),
)
),
)
entity_management_add_collection_members = sgqlc.types.Field(
sgqlc.types.list_of(ID),
graphql_name="entityManagementAddCollectionMembers",
args=sgqlc.types.ArgDict(
(
(
"collection_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="collectionId",
default=None,
),
),
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `collection_id` (`ID!`): The collection to add an entity to.
* `ids` (`[ID!]!`): The list of entities to add to the collection.
"""
entity_management_create_ai_agent = sgqlc.types.Field(
EntityManagementAiAgentEntityCreateResult,
graphql_name="entityManagementCreateAiAgent",
args=sgqlc.types.ArgDict(
(
(
"ai_agent_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementAiAgentEntityCreateInput),
graphql_name="aiAgentEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `ai_agent_entity` (`EntityManagementAiAgentEntityCreateInput!`):
The entity's data
"""
entity_management_create_ai_tool = sgqlc.types.Field(
EntityManagementAiToolEntityCreateResult,
graphql_name="entityManagementCreateAiTool",
args=sgqlc.types.ArgDict(
(
(
"ai_tool_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementAiToolEntityCreateInput),
graphql_name="aiToolEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `ai_tool_entity` (`EntityManagementAiToolEntityCreateInput!`):
The entity's data
"""
entity_management_create_collection = sgqlc.types.Field(
EntityManagementCollectionEntityCreateResult,
graphql_name="entityManagementCreateCollection",
args=sgqlc.types.ArgDict(
(
(
"collection_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementCollectionEntityCreateInput
),
graphql_name="collectionEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `collection_entity`
(`EntityManagementCollectionEntityCreateInput!`): The entity's
data
"""
entity_management_create_confluence_integration = sgqlc.types.Field(
EntityManagementConfluenceIntegrationCreateResult,
graphql_name="entityManagementCreateConfluenceIntegration",
args=sgqlc.types.ArgDict(
(
(
"confluence_integration",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementConfluenceIntegrationCreateInput
),
graphql_name="confluenceIntegration",
default=None,
),
),
)
),
)
"""Arguments:
* `confluence_integration`
(`EntityManagementConfluenceIntegrationCreateInput!`): The
entity's data
"""
entity_management_create_confluence_rag_settings = sgqlc.types.Field(
EntityManagementConfluenceRagSettingsEntityCreateResult,
graphql_name="entityManagementCreateConfluenceRagSettings",
args=sgqlc.types.ArgDict(
(
(
"confluence_rag_settings_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementConfluenceRagSettingsEntityCreateInput
),
graphql_name="confluenceRagSettingsEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `confluence_rag_settings_entity`
(`EntityManagementConfluenceRagSettingsEntityCreateInput!`): The
entity's data
"""
entity_management_create_git_repository = sgqlc.types.Field(
EntityManagementGitRepositoryEntityCreateResult,
graphql_name="entityManagementCreateGitRepository",
args=sgqlc.types.ArgDict(
(
(
"git_repository_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementGitRepositoryEntityCreateInput
),
graphql_name="gitRepositoryEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `git_repository_entity`
(`EntityManagementGitRepositoryEntityCreateInput!`): The
entity's data
"""
entity_management_create_impact_profile = sgqlc.types.Field(
EntityManagementImpactProfileEntityCreateResult,
graphql_name="entityManagementCreateImpactProfile",
args=sgqlc.types.ArgDict(
(
(
"impact_profile_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementImpactProfileEntityCreateInput
),
graphql_name="impactProfileEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `impact_profile_entity`
(`EntityManagementImpactProfileEntityCreateInput!`): The
entity's data
"""
entity_management_create_inbox_issue_category = sgqlc.types.Field(
EntityManagementInboxIssueCategoryEntityCreateResult,
graphql_name="entityManagementCreateInboxIssueCategory",
args=sgqlc.types.ArgDict(
(
(
"inbox_issue_category_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementInboxIssueCategoryEntityCreateInput
),
graphql_name="inboxIssueCategoryEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `inbox_issue_category_entity`
(`EntityManagementInboxIssueCategoryEntityCreateInput!`): The
entity's data
"""
entity_management_create_incident_link = sgqlc.types.Field(
EntityManagementIncidentLinkEntityCreateResult,
graphql_name="entityManagementCreateIncidentLink",
args=sgqlc.types.ArgDict(
(
(
"incident_link_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementIncidentLinkEntityCreateInput
),
graphql_name="incidentLinkEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `incident_link_entity`
(`EntityManagementIncidentLinkEntityCreateInput!`): The entity's
data
"""
entity_management_create_incident_timeline = sgqlc.types.Field(
EntityManagementIncidentTimelineEntityCreateResult,
graphql_name="entityManagementCreateIncidentTimeline",
args=sgqlc.types.ArgDict(
(
(
"incident_timeline_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementIncidentTimelineEntityCreateInput
),
graphql_name="incidentTimelineEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `incident_timeline_entity`
(`EntityManagementIncidentTimelineEntityCreateInput!`): The
entity's data
"""
entity_management_create_mcp_server = sgqlc.types.Field(
EntityManagementMcpServerEntityCreateResult,
graphql_name="entityManagementCreateMcpServer",
args=sgqlc.types.ArgDict(
(
(
"mcp_server_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementMcpServerEntityCreateInput
),
graphql_name="mcpServerEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `mcp_server_entity`
(`EntityManagementMcpServerEntityCreateInput!`): The entity's
data
"""
entity_management_create_pipeline_cloud_rule = sgqlc.types.Field(
EntityManagementPipelineCloudRuleEntityCreateResult,
graphql_name="entityManagementCreatePipelineCloudRule",
args=sgqlc.types.ArgDict(
(
(
"pipeline_cloud_rule_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementPipelineCloudRuleEntityCreateInput
),
graphql_name="pipelineCloudRuleEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `pipeline_cloud_rule_entity`
(`EntityManagementPipelineCloudRuleEntityCreateInput!`): The
entity's data
"""
entity_management_create_rag_tool = sgqlc.types.Field(
EntityManagementRagToolEntityCreateResult,
graphql_name="entityManagementCreateRagTool",
args=sgqlc.types.ArgDict(
(
(
"rag_tool_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementRagToolEntityCreateInput),
graphql_name="ragToolEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `rag_tool_entity` (`EntityManagementRagToolEntityCreateInput!`):
The entity's data
"""
entity_management_create_relationship = sgqlc.types.Field(
EntityManagementRelationshipCreateResult,
graphql_name="entityManagementCreateRelationship",
args=sgqlc.types.ArgDict(
(
(
"relationship",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementRelationshipCreateInput),
graphql_name="relationship",
default=None,
),
),
)
),
)
"""Arguments:
* `relationship` (`EntityManagementRelationshipCreateInput!`): The
relationship data.
"""
entity_management_create_scorecard = sgqlc.types.Field(
EntityManagementScorecardEntityCreateResult,
graphql_name="entityManagementCreateScorecard",
args=sgqlc.types.ArgDict(
(
(
"scorecard_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementScorecardEntityCreateInput
),
graphql_name="scorecardEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `scorecard_entity`
(`EntityManagementScorecardEntityCreateInput!`): The entity's
data
"""
entity_management_create_scorecard_rule = sgqlc.types.Field(
EntityManagementScorecardRuleEntityCreateResult,
graphql_name="entityManagementCreateScorecardRule",
args=sgqlc.types.ArgDict(
(
(
"scorecard_rule_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementScorecardRuleEntityCreateInput
),
graphql_name="scorecardRuleEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `scorecard_rule_entity`
(`EntityManagementScorecardRuleEntityCreateInput!`): The
entity's data
"""
entity_management_create_team = sgqlc.types.Field(
EntityManagementTeamEntityCreateResult,
graphql_name="entityManagementCreateTeam",
args=sgqlc.types.ArgDict(
(
(
"team_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementTeamEntityCreateInput),
graphql_name="teamEntity",
default=None,
),
),
)
),
)
"""Arguments:
* `team_entity` (`EntityManagementTeamEntityCreateInput!`): The
entity's data
"""
entity_management_delete = sgqlc.types.Field(
EntityManagementEntityDeleteResult,
graphql_name="entityManagementDelete",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be deleted.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_delete_relationship = sgqlc.types.Field(
EntityManagementRelationshipDeleteResult,
graphql_name="entityManagementDeleteRelationship",
args=sgqlc.types.ArgDict(
(
(
"source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="sourceId", default=None
),
),
(
"target_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="targetId", default=None
),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="type", default=None
),
),
)
),
)
"""Arguments:
* `source_id` (`ID!`): The source id of the relationship to be
deleted.
* `target_id` (`ID!`): The target id of the relationship to be
deleted.
* `type` (`String!`): The relationship type to be deleted.
"""
entity_management_remove_collection_members = sgqlc.types.Field(
sgqlc.types.list_of(ID),
graphql_name="entityManagementRemoveCollectionMembers",
args=sgqlc.types.ArgDict(
(
(
"collection_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="collectionId",
default=None,
),
),
(
"ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `collection_id` (`ID!`): The collection to remove entities from.
* `ids` (`[ID!]!`): The list of entities to remove from the
collection.
"""
entity_management_update = sgqlc.types.Field(
EntityManagementGenericEntityUpdateResult,
graphql_name="entityManagementUpdate",
args=sgqlc.types.ArgDict(
(
(
"entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementGenericEntityUpdateInput),
graphql_name="entity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `entity` (`EntityManagementGenericEntityUpdateInput!`): The
input data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_ai_agent = sgqlc.types.Field(
EntityManagementAiAgentEntityUpdateResult,
graphql_name="entityManagementUpdateAiAgent",
args=sgqlc.types.ArgDict(
(
(
"ai_agent_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementAiAgentEntityUpdateInput),
graphql_name="aiAgentEntity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `ai_agent_entity` (`EntityManagementAiAgentEntityUpdateInput!`):
The input data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_ai_tool = sgqlc.types.Field(
EntityManagementAiToolEntityUpdateResult,
graphql_name="entityManagementUpdateAiTool",
args=sgqlc.types.ArgDict(
(
(
"ai_tool_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementAiToolEntityUpdateInput),
graphql_name="aiToolEntity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `ai_tool_entity` (`EntityManagementAiToolEntityUpdateInput!`):
The input data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_collection = sgqlc.types.Field(
EntityManagementCollectionEntityUpdateResult,
graphql_name="entityManagementUpdateCollection",
args=sgqlc.types.ArgDict(
(
(
"collection_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementCollectionEntityUpdateInput
),
graphql_name="collectionEntity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `collection_entity`
(`EntityManagementCollectionEntityUpdateInput!`): The input data
to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_confluence_integration = sgqlc.types.Field(
EntityManagementConfluenceIntegrationUpdateResult,
graphql_name="entityManagementUpdateConfluenceIntegration",
args=sgqlc.types.ArgDict(
(
(
"confluence_integration",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementConfluenceIntegrationUpdateInput
),
graphql_name="confluenceIntegration",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `confluence_integration`
(`EntityManagementConfluenceIntegrationUpdateInput!`): The input
data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_confluence_rag_settings = sgqlc.types.Field(
EntityManagementConfluenceRagSettingsEntityUpdateResult,
graphql_name="entityManagementUpdateConfluenceRagSettings",
args=sgqlc.types.ArgDict(
(
(
"confluence_rag_settings_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementConfluenceRagSettingsEntityUpdateInput
),
graphql_name="confluenceRagSettingsEntity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `confluence_rag_settings_entity`
(`EntityManagementConfluenceRagSettingsEntityUpdateInput!`): The
input data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_git_repository = sgqlc.types.Field(
EntityManagementGitRepositoryEntityUpdateResult,
graphql_name="entityManagementUpdateGitRepository",
args=sgqlc.types.ArgDict(
(
(
"git_repository_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementGitRepositoryEntityUpdateInput
),
graphql_name="gitRepositoryEntity",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `git_repository_entity`
(`EntityManagementGitRepositoryEntityUpdateInput!`): The input
data to be updated.
* `id` (`ID!`): The id of the entity to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_impact_profile = sgqlc.types.Field(
EntityManagementImpactProfileEntityUpdateResult,
graphql_name="entityManagementUpdateImpactProfile",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"impact_profile_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementImpactProfileEntityUpdateInput
),
graphql_name="impactProfileEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `impact_profile_entity`
(`EntityManagementImpactProfileEntityUpdateInput!`): The input
data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_inbox_issue_category = sgqlc.types.Field(
EntityManagementInboxIssueCategoryEntityUpdateResult,
graphql_name="entityManagementUpdateInboxIssueCategory",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"inbox_issue_category_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementInboxIssueCategoryEntityUpdateInput
),
graphql_name="inboxIssueCategoryEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `inbox_issue_category_entity`
(`EntityManagementInboxIssueCategoryEntityUpdateInput!`): The
input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_incident_link = sgqlc.types.Field(
EntityManagementIncidentLinkEntityUpdateResult,
graphql_name="entityManagementUpdateIncidentLink",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"incident_link_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementIncidentLinkEntityUpdateInput
),
graphql_name="incidentLinkEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `incident_link_entity`
(`EntityManagementIncidentLinkEntityUpdateInput!`): The input
data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_incident_timeline = sgqlc.types.Field(
EntityManagementIncidentTimelineEntityUpdateResult,
graphql_name="entityManagementUpdateIncidentTimeline",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"incident_timeline_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementIncidentTimelineEntityUpdateInput
),
graphql_name="incidentTimelineEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `incident_timeline_entity`
(`EntityManagementIncidentTimelineEntityUpdateInput!`): The
input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_mcp_server = sgqlc.types.Field(
EntityManagementMcpServerEntityUpdateResult,
graphql_name="entityManagementUpdateMcpServer",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"mcp_server_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementMcpServerEntityUpdateInput
),
graphql_name="mcpServerEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `mcp_server_entity`
(`EntityManagementMcpServerEntityUpdateInput!`): The input data
to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_pipeline_cloud_rule = sgqlc.types.Field(
EntityManagementPipelineCloudRuleEntityUpdateResult,
graphql_name="entityManagementUpdatePipelineCloudRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"pipeline_cloud_rule_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementPipelineCloudRuleEntityUpdateInput
),
graphql_name="pipelineCloudRuleEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `pipeline_cloud_rule_entity`
(`EntityManagementPipelineCloudRuleEntityUpdateInput!`): The
input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_rag_tool = sgqlc.types.Field(
EntityManagementRagToolEntityUpdateResult,
graphql_name="entityManagementUpdateRagTool",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"rag_tool_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementRagToolEntityUpdateInput),
graphql_name="ragToolEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `rag_tool_entity` (`EntityManagementRagToolEntityUpdateInput!`):
The input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_relationship = sgqlc.types.Field(
EntityManagementRelationshipUpdateResult,
graphql_name="entityManagementUpdateRelationship",
args=sgqlc.types.ArgDict(
(
(
"relationship",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementRelationshipUpdateInput),
graphql_name="relationship",
default=None,
),
),
(
"source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="sourceId", default=None
),
),
(
"target_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="targetId", default=None
),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="type", default=None
),
),
)
),
)
"""Arguments:
* `relationship` (`EntityManagementRelationshipUpdateInput!`): The
relationship data to be updated
* `source_id` (`ID!`): The source entity of the relationship.
* `target_id` (`ID!`): The target entity of the relationship.
* `type` (`String!`): The type of the relationship.
"""
entity_management_update_scorecard = sgqlc.types.Field(
EntityManagementScorecardEntityUpdateResult,
graphql_name="entityManagementUpdateScorecard",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"scorecard_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementScorecardEntityUpdateInput
),
graphql_name="scorecardEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `scorecard_entity`
(`EntityManagementScorecardEntityUpdateInput!`): The input data
to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_scorecard_rule = sgqlc.types.Field(
EntityManagementScorecardRuleEntityUpdateResult,
graphql_name="entityManagementUpdateScorecardRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"scorecard_rule_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementScorecardRuleEntityUpdateInput
),
graphql_name="scorecardRuleEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `scorecard_rule_entity`
(`EntityManagementScorecardRuleEntityUpdateInput!`): The input
data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_team = sgqlc.types.Field(
EntityManagementTeamEntityUpdateResult,
graphql_name="entityManagementUpdateTeam",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"team_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityManagementTeamEntityUpdateInput),
graphql_name="teamEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `team_entity` (`EntityManagementTeamEntityUpdateInput!`): The
input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_teams_hierarchy_level = sgqlc.types.Field(
EntityManagementTeamsHierarchyLevelEntityUpdateResult,
graphql_name="entityManagementUpdateTeamsHierarchyLevel",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"teams_hierarchy_level_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementTeamsHierarchyLevelEntityUpdateInput
),
graphql_name="teamsHierarchyLevelEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `teams_hierarchy_level_entity`
(`EntityManagementTeamsHierarchyLevelEntityUpdateInput!`): The
input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_management_update_teams_organization_settings = sgqlc.types.Field(
EntityManagementTeamsOrganizationSettingsEntityUpdateResult,
graphql_name="entityManagementUpdateTeamsOrganizationSettings",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"teams_organization_settings_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(
EntityManagementTeamsOrganizationSettingsEntityUpdateInput
),
graphql_name="teamsOrganizationSettingsEntity",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the entity to be updated.
* `teams_organization_settings_entity`
(`EntityManagementTeamsOrganizationSettingsEntityUpdateInput!`):
The input data to be updated.
* `version` (`Int`): Optional entity version. When provided, its
value will be checked against the entity's current version. If
different, the operation will fail. Use it to prevent lost
updates.
"""
entity_relationship_user_defined_create_or_replace = sgqlc.types.Field(
sgqlc.types.non_null(EntityRelationshipUserDefinedCreateOrReplaceResult),
graphql_name="entityRelationshipUserDefinedCreateOrReplace",
args=sgqlc.types.ArgDict(
(
(
"source_entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="sourceEntityGuid",
default=None,
),
),
(
"target_entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="targetEntityGuid",
default=None,
),
),
(
"type",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityRelationshipEdgeType),
graphql_name="type",
default=None,
),
),
)
),
)
"""Arguments:
* `source_entity_guid` (`EntityGuid!`): The source entity guid of
the relationship.
* `target_entity_guid` (`EntityGuid!`): The target entity guid of
the relationship.
* `type` (`EntityRelationshipEdgeType!`): The type of the
relationship.
"""
entity_relationship_user_defined_delete = sgqlc.types.Field(
sgqlc.types.non_null(EntityRelationshipUserDefinedDeleteResult),
graphql_name="entityRelationshipUserDefinedDelete",
args=sgqlc.types.ArgDict(
(
(
"source_entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="sourceEntityGuid",
default=None,
),
),
(
"target_entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="targetEntityGuid",
default=None,
),
),
(
"type",
sgqlc.types.Arg(
EntityRelationshipEdgeType, graphql_name="type", default=None
),
),
)
),
)
"""Arguments:
* `source_entity_guid` (`EntityGuid!`): The source entity guid of
the relationship.
* `target_entity_guid` (`EntityGuid!`): The target entity guid of
the relationship.
* `type` (`EntityRelationshipEdgeType`): The type of the
relationship. If none provided, it will delete all relationships
between source and target.
"""
errors_inbox_assign_error_group = sgqlc.types.Field(
ErrorsInboxAssignErrorGroupResponse,
graphql_name="errorsInboxAssignErrorGroup",
args=sgqlc.types.ArgDict(
(
(
"assignment",
sgqlc.types.Arg(
sgqlc.types.non_null(ErrorsInboxAssignErrorGroupInput),
graphql_name="assignment",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `assignment` (`ErrorsInboxAssignErrorGroupInput!`): An input
object that represents the new assignment.
* `id` (`ID!`): The id of the error group.
"""
errors_inbox_delete_error_group_resource = sgqlc.types.Field(
ErrorsInboxDeleteErrorGroupResourceResponse,
graphql_name="errorsInboxDeleteErrorGroupResource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"resource_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="resourceId",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The id of the error group.
* `resource_id` (`ID!`): Id of the resource
"""
errors_inbox_update_error_group_state = sgqlc.types.Field(
ErrorsInboxUpdateErrorGroupStateResponse,
graphql_name="errorsInboxUpdateErrorGroupState",
args=sgqlc.types.ArgDict(
(
("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="ids",
default=None,
),
),
(
"resolve_in_next_version",
sgqlc.types.Arg(
Boolean, graphql_name="resolveInNextVersion", default=None
),
),
(
"state",
sgqlc.types.Arg(
sgqlc.types.non_null(ErrorsInboxErrorGroupState),
graphql_name="state",
default=None,
),
),
(
"versions",
sgqlc.types.Arg(
ErrorsInboxStateVersionInput,
graphql_name="versions",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID`): DEPRECATED. Use `ids` field instead.
* `ids` (`[ID!]`): The ids of the error groups.
* `resolve_in_next_version` (`Boolean`): Allows error group(s) to
be marked as `Resolved` prior to deployment. Configures errors
inbox to resolve an error group in the next semantically higher
version that is detected via change tracking. Cannot be used
with `versions`. For example, if an error group is occurring in
version `1.5` and marked as `resolvedInNextVersion` = `true`,
then the error group will remain in a resolved state for errors
with versions `1.5` or lower. - When the next version is
deployed (say `1.6`), the error group will be updated to reflect
as resolved in version `1.6`. - If an error occurs in a newer
version (say `1.6`) before the next detected deployment, then
the error group will be set to unresolved with regression in
`1.6`.
* `state` (`ErrorsInboxErrorGroupState!`): State that the error
groups should transition to.
* `versions` (`ErrorsInboxStateVersionInput`): Optionally specify
versions of the entity for which an error group's state applies.
Note: this is currently only applicable for `Resolved` and
cannot be used with `resolvedInNextVersion`. For example, let's
say a given error group is occurring for version `1.0.0`. A fix
was implemented and deployed in `1.0.1`. The error group may be
marked as `Resolved` in version `1.0.1`. For any errors still
occurring in `1.0.0` or lower, they will continue to appear as
occurrences but the error group will remain in a resolved state.
If there is a new occurrence in `1.0.1` or higher, then the
error group will become unresolved with regression in the
affected version(s).
"""
events_to_metrics_create_rule = sgqlc.types.Field(
EventsToMetricsCreateRuleResult,
graphql_name="eventsToMetricsCreateRule",
args=sgqlc.types.ArgDict(
(
(
"rules",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(EventsToMetricsCreateRuleInput)
),
graphql_name="rules",
default=None,
),
),
)
),
)
"""Arguments:
* `rules` (`[EventsToMetricsCreateRuleInput]!`): List of events to
metrics rules to create.
"""
events_to_metrics_delete_rule = sgqlc.types.Field(
EventsToMetricsDeleteRuleResult,
graphql_name="eventsToMetricsDeleteRule",
args=sgqlc.types.ArgDict(
(
(
"deletes",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(EventsToMetricsDeleteRuleInput)
),
graphql_name="deletes",
default=None,
),
),
)
),
)
"""Arguments:
* `deletes` (`[EventsToMetricsDeleteRuleInput]!`): List of events
to metrics rules to delete.
"""
events_to_metrics_update_rule = sgqlc.types.Field(
EventsToMetricsUpdateRuleResult,
graphql_name="eventsToMetricsUpdateRule",
args=sgqlc.types.ArgDict(
(
(
"updates",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(EventsToMetricsUpdateRuleInput)
),
graphql_name="updates",
default=None,
),
),
)
),
)
"""Arguments:
* `updates` (`[EventsToMetricsUpdateRuleInput]!`): List of events
to metrics rules to update.
"""
fleet_control_add_fleet_members = sgqlc.types.Field(
FleetControlFleetMembersResult,
graphql_name="fleetControlAddFleetMembers",
args=sgqlc.types.ArgDict(
(
(
"fleet_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="fleetId", default=None
),
),
(
"members",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(FleetControlFleetMemberRingInput)
),
graphql_name="members",
default=None,
),
),
)
),
)
"""Arguments:
* `fleet_id` (`ID!`): The fleet id
* `members` (`[FleetControlFleetMemberRingInput!]`): The list of
rings to add entities to
"""
fleet_control_create_fleet = sgqlc.types.Field(
FleetControlCreateFleetResult,
graphql_name="fleetControlCreateFleet",
args=sgqlc.types.ArgDict(
(
(
"fleet_entity",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlFleetEntityCreateInput),
graphql_name="fleetEntity",
default=None,
),
),
)
),
)
fleet_control_create_fleet_deployment = sgqlc.types.Field(
FleetControlFleetDeploymentCreateResult,
graphql_name="fleetControlCreateFleetDeployment",
args=sgqlc.types.ArgDict(
(
(
"fleet_deployment",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlFleetDeploymentCreateInput),
graphql_name="fleetDeployment",
default=None,
),
),
)
),
)
fleet_control_delete_fleet = sgqlc.types.Field(
FleetControlDeleteFleetResult,
graphql_name="fleetControlDeleteFleet",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
fleet_control_delete_fleet_deployment = sgqlc.types.Field(
FleetControlFleetDeploymentDeleteResult,
graphql_name="fleetControlDeleteFleetDeployment",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
fleet_control_deploy = sgqlc.types.Field(
FleetControlDeployResult,
graphql_name="fleetControlDeploy",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"policy",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlFleetDeploymentPolicyInput),
graphql_name="policy",
default=None,
),
),
)
),
)
fleet_control_remove_fleet_members = sgqlc.types.Field(
FleetControlFleetMembersResult,
graphql_name="fleetControlRemoveFleetMembers",
args=sgqlc.types.ArgDict(
(
(
"fleet_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="fleetId", default=None
),
),
(
"members",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(FleetControlFleetMemberRingInput)
),
graphql_name="members",
default=None,
),
),
)
),
)
"""Arguments:
* `fleet_id` (`ID!`): The fleet id
* `members` (`[FleetControlFleetMemberRingInput!]`): The list of
rings to remove entities from
"""
fleet_control_update_fleet = sgqlc.types.Field(
FleetControlUpdateFleetResult,
graphql_name="fleetControlUpdateFleet",
args=sgqlc.types.ArgDict(
(
(
"fleet_update",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlUpdateFleetEntityInput),
graphql_name="fleetUpdate",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
fleet_control_update_fleet_deployment = sgqlc.types.Field(
FleetControlFleetDeploymentUpdateResult,
graphql_name="fleetControlUpdateFleetDeployment",
args=sgqlc.types.ArgDict(
(
(
"fleet_deployment_update",
sgqlc.types.Arg(
sgqlc.types.non_null(FleetControlFleetDeploymentUpdateInput),
graphql_name="fleetDeploymentUpdate",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
historical_data_export_cancel_export = sgqlc.types.Field(
HistoricalDataExportCustomerExportResponse,
graphql_name="historicalDataExportCancelExport",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="id", default=None
),
),
)
),
)
historical_data_export_create_export = sgqlc.types.Field(
HistoricalDataExportCustomerExportResponse,
graphql_name="historicalDataExportCreateExport",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
("nrql", sgqlc.types.Arg(Nrql, graphql_name="nrql", default=None)),
)
),
)
incident_intelligence_environment_consent_accounts = sgqlc.types.Field(
IncidentIntelligenceEnvironmentConsentAccounts,
graphql_name="incidentIntelligenceEnvironmentConsentAccounts",
args=sgqlc.types.ArgDict(
(
(
"account_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(Int)),
graphql_name="accountIds",
default=None,
),
),
)
),
)
"""Arguments:
* `account_ids` (`[Int]!`): The account ids to mark with consent,
will consent the parent accounts
"""
incident_intelligence_environment_consent_authorized_accounts = sgqlc.types.Field(
IncidentIntelligenceEnvironmentConsentAuthorizedAccounts,
graphql_name="incidentIntelligenceEnvironmentConsentAuthorizedAccounts",
)
incident_intelligence_environment_delete_environment = sgqlc.types.Field(
IncidentIntelligenceEnvironmentDeleteEnvironment,
graphql_name="incidentIntelligenceEnvironmentDeleteEnvironment",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
)
),
)
incident_intelligence_environment_dissent_accounts = sgqlc.types.Field(
IncidentIntelligenceEnvironmentDissentAccounts,
graphql_name="incidentIntelligenceEnvironmentDissentAccounts",
args=sgqlc.types.ArgDict(
(
(
"account_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(Int)),
graphql_name="accountIds",
default=None,
),
),
)
),
)
"""Arguments:
* `account_ids` (`[Int]!`): The account ids to dissent, empty list
will mark all of the current user parent-accounts
"""
installation_create_install_status = sgqlc.types.Field(
sgqlc.types.non_null(InstallationInstallStatus),
graphql_name="installationCreateInstallStatus",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"install_status",
sgqlc.types.Arg(
sgqlc.types.non_null(InstallationInstallStatusInput),
graphql_name="installStatus",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The accountId associated with the install
status.
* `install_status` (`InstallationInstallStatusInput!`): The
installation status.
"""
installation_create_recipe_event = sgqlc.types.Field(
sgqlc.types.non_null(InstallationRecipeEvent),
graphql_name="installationCreateRecipeEvent",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"status",
sgqlc.types.Arg(
sgqlc.types.non_null(InstallationRecipeStatus),
graphql_name="status",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The accountId associated with the recipe
event.
* `status` (`InstallationRecipeStatus!`): The installation status
associated with the recipe event.
"""
installation_delete_install = sgqlc.types.Field(
sgqlc.types.non_null(Boolean),
graphql_name="installationDeleteInstall",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The accountId associated with the
installation.
"""
integration_services_service_now_installation = sgqlc.types.Field(
IntegrationServicesInstallationResponse,
graphql_name="integrationServicesServiceNowInstallation",
args=sgqlc.types.ArgDict(
(
(
"service_now_installation",
sgqlc.types.Arg(
sgqlc.types.non_null(IntegrationServicesInstallationInput),
graphql_name="serviceNowInstallation",
default=None,
),
),
)
),
)
"""Arguments:
* `service_now_installation`
(`IntegrationServicesInstallationInput!`): Input required for
ServiceNow installation.
"""
integration_services_service_now_update = sgqlc.types.Field(
IntegrationServicesUpdateResponse,
graphql_name="integrationServicesServiceNowUpdate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"service_now_update",
sgqlc.types.Arg(
sgqlc.types.non_null(IntegrationServicesUpdateInput),
graphql_name="serviceNowUpdate",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): Unique identifier for the ServiceNow entity to
update.
* `service_now_update` (`IntegrationServicesUpdateInput!`): Input
required for updating ServiceNow entity.
"""
key_transaction_create = sgqlc.types.Field(
KeyTransactionCreateResult,
graphql_name="keyTransactionCreate",
args=sgqlc.types.ArgDict(
(
(
"apdex_target",
sgqlc.types.Arg(
sgqlc.types.non_null(Float),
graphql_name="apdexTarget",
default=None,
),
),
(
"application_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="applicationGuid",
default=None,
),
),
(
"browser_apdex_target",
sgqlc.types.Arg(
sgqlc.types.non_null(Float),
graphql_name="browserApdexTarget",
default=None,
),
),
(
"metric_name",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="metricName",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
"""Arguments:
* `apdex_target` (`Float!`): The acceptable amount of the time
spent in the backend before customers get frustrated (Apdex
target).
* `application_guid` (`EntityGuid!`): The GUID of the application.
* `browser_apdex_target` (`Float!`): The acceptable amount of time
for rendering a page in a browser before customers get
frustrated (browser Apdex target).
* `metric_name` (`String!`): The name of the metric underlying
this key transaction.
* `name` (`String!`): The name of the key transaction.
"""
key_transaction_delete = sgqlc.types.Field(
KeyTransactionDeleteResult,
graphql_name="keyTransactionDelete",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The GUID of the key transaction to
delete.
"""
key_transaction_update = sgqlc.types.Field(
KeyTransactionUpdateResult,
graphql_name="keyTransactionUpdate",
args=sgqlc.types.ArgDict(
(
(
"apdex_target",
sgqlc.types.Arg(Float, graphql_name="apdexTarget", default=None),
),
(
"browser_apdex_target",
sgqlc.types.Arg(
Float, graphql_name="browserApdexTarget", default=None
),
),
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
)
),
)
"""Arguments:
* `apdex_target` (`Float`): The acceptable amount of time spent in
the backend before customers get frustrated (Apdex target).
* `browser_apdex_target` (`Float`): The acceptable amount of time
for rendering a page in a browser before customers get
frustrated (browser Apdex target).
* `guid` (`EntityGuid!`): The GUID for the affected key
transaction.
* `name` (`String`): The name of the key transaction.
"""
log_configurations_create_data_partition_rule = sgqlc.types.Field(
LogConfigurationsCreateDataPartitionRuleResponse,
graphql_name="logConfigurationsCreateDataPartitionRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsCreateDataPartitionRuleInput
),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the data
partition rule.
* `rule` (`LogConfigurationsCreateDataPartitionRuleInput!`): The
data partition rule to be created.
"""
log_configurations_create_obfuscation_expression = sgqlc.types.Field(
LogConfigurationsObfuscationExpression,
graphql_name="logConfigurationsCreateObfuscationExpression",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"expression",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsCreateObfuscationExpressionInput
),
graphql_name="expression",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation expression.
* `expression`
(`LogConfigurationsCreateObfuscationExpressionInput!`): The
obfuscation expression you want to create.
"""
log_configurations_create_obfuscation_rule = sgqlc.types.Field(
LogConfigurationsObfuscationRule,
graphql_name="logConfigurationsCreateObfuscationRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsCreateObfuscationRuleInput
),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation rule.
* `rule` (`LogConfigurationsCreateObfuscationRuleInput!`): The
obfuscation rule you want to create.
"""
log_configurations_create_parsing_rule = sgqlc.types.Field(
LogConfigurationsCreateParsingRuleResponse,
graphql_name="logConfigurationsCreateParsingRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(LogConfigurationsParsingRuleConfiguration),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the rule.
* `rule` (`LogConfigurationsParsingRuleConfiguration!`): The rule
to be created.
"""
log_configurations_delete_data_partition_rule = sgqlc.types.Field(
LogConfigurationsDeleteDataPartitionRuleResponse,
graphql_name="logConfigurationsDeleteDataPartitionRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the data
partition rule.
* `id` (`ID!`): The id of the data partition rule you want to mark
as deleted.
"""
log_configurations_delete_obfuscation_expression = sgqlc.types.Field(
LogConfigurationsObfuscationExpression,
graphql_name="logConfigurationsDeleteObfuscationExpression",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation expression.
* `id` (`ID!`): The id of the obfuscation expression to mark as
deleted.
"""
log_configurations_delete_obfuscation_rule = sgqlc.types.Field(
LogConfigurationsObfuscationRule,
graphql_name="logConfigurationsDeleteObfuscationRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation rule.
* `id` (`ID!`): The id of the obfuscation rule to mark as deleted.
"""
log_configurations_delete_parsing_rule = sgqlc.types.Field(
LogConfigurationsDeleteParsingRuleResponse,
graphql_name="logConfigurationsDeleteParsingRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the rule.
* `id` (`ID!`): The id of the rule you want to mark as deleted.
"""
log_configurations_update_data_partition_rule = sgqlc.types.Field(
LogConfigurationsUpdateDataPartitionRuleResponse,
graphql_name="logConfigurationsUpdateDataPartitionRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
LogConfigurationsUpdateDataPartitionRuleInput,
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the data
partition rule.
* `rule` (`LogConfigurationsUpdateDataPartitionRuleInput`): The
data partition rule to be updated. Only the rule description or
Matching criteria fields are allowed to be updated.
"""
log_configurations_update_live_archive_configuration = sgqlc.types.Field(
LogConfigurationsLiveArchiveConfiguration,
graphql_name="logConfigurationsUpdateLiveArchiveConfiguration",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"enabled",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="enabled",
default=None,
),
),
(
"event_type",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="eventType",
default=None,
),
),
(
"retention_policy",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsLiveArchiveRetentionPolicyType
),
graphql_name="retentionPolicy",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
EventType.
* `enabled` (`Boolean!`): Indicates if the Live Archive
configuration is enabled
* `event_type` (`String!`): EventType name that will be
configured.
* `retention_policy`
(`LogConfigurationsLiveArchiveRetentionPolicyType!`): Retention
policy for the EventType.
"""
log_configurations_update_obfuscation_expression = sgqlc.types.Field(
LogConfigurationsObfuscationExpression,
graphql_name="logConfigurationsUpdateObfuscationExpression",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"expression",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsUpdateObfuscationExpressionInput
),
graphql_name="expression",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation expression.
* `expression`
(`LogConfigurationsUpdateObfuscationExpressionInput!`): The
obfuscation expression to be updated.
"""
log_configurations_update_obfuscation_rule = sgqlc.types.Field(
LogConfigurationsObfuscationRule,
graphql_name="logConfigurationsUpdateObfuscationRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsUpdateObfuscationRuleInput
),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the
obfuscation rule.
* `rule` (`LogConfigurationsUpdateObfuscationRuleInput!`): The
obfuscation rule to be updated.
"""
log_configurations_update_parsing_rule = sgqlc.types.Field(
LogConfigurationsUpdateParsingRuleResponse,
graphql_name="logConfigurationsUpdateParsingRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(LogConfigurationsParsingRuleConfiguration),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the rule.
* `id` (`ID!`): The identifier of the rule to update.
* `rule` (`LogConfigurationsParsingRuleConfiguration!`): The
updated rule.
"""
log_configurations_upsert_pipeline_configuration = sgqlc.types.Field(
LogConfigurationsUpsertPipelineConfigurationResponse,
graphql_name="logConfigurationsUpsertPipelineConfiguration",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"pipeline_configuration",
sgqlc.types.Arg(
sgqlc.types.non_null(
LogConfigurationsPipelineConfigurationInput
),
graphql_name="pipelineConfiguration",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account id associated with the rule.
* `pipeline_configuration`
(`LogConfigurationsPipelineConfigurationInput!`): The updated
pipeline configuration.
"""
machine_learning_add_document_index = sgqlc.types.Field(
MachineLearningTransactionResponse,
graphql_name="machineLearningAddDocumentIndex",
args=sgqlc.types.ArgDict(
(
(
"configuration",
sgqlc.types.Arg(
MachineLearningAddDocumentIndexConfiguration,
graphql_name="configuration",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="documentId",
default=None,
),
),
(
"rag_setting_id",
sgqlc.types.Arg(ID, graphql_name="ragSettingId", default=None),
),
(
"tool_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="toolId", default=None
),
),
)
),
)
"""Arguments:
* `configuration`
(`MachineLearningAddDocumentIndexConfiguration`): Configuration
options for the document indexing process.
* `document_id` (`ID!`): Identifier of the document to be indexed.
* `rag_setting_id` (`ID`): Optional identifier for RAG (Retrieve
and Generate) setting.
* `tool_id` (`ID!`): Identifier of the tool to be used for
indexing.
"""
machine_learning_add_file_data_source = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningAddFileDataSource",
args=sgqlc.types.ArgDict(
(
(
"file_data_source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="fileDataSourceId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_add_stream_data_source = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningAddStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"stream_data_source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="streamDataSourceId",
default=None,
),
),
)
),
)
machine_learning_create_file_data_source = sgqlc.types.Field(
MachineLearningFileDataSource,
graphql_name="machineLearningCreateFileDataSource",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"blob_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="blobId", default=None
),
),
(
"description",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="description",
default=None,
),
),
(
"file_name",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="fileName",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
machine_learning_create_project = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningCreateProject",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
)
),
)
machine_learning_create_stream_data_source = sgqlc.types.Field(
MachineLearningStreamDataSource,
graphql_name="machineLearningCreateStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"description",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="description",
default=None,
),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="filter",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"sampling_rate",
sgqlc.types.Arg(
sgqlc.types.non_null(Float),
graphql_name="samplingRate",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account ID that will own the stream Data
Source
* `description` (`String!`): Description of the Stream Data Source
* `filter` (`String!`): NRQL used to filter data to the topic
* `name` (`String!`): Name of the Stream Data Source
* `sampling_rate` (`Float!`): Sampling rate - between 0 and 1.
High sampling rates will equate to higher bills
"""
machine_learning_delete_connector = sgqlc.types.Field(
MachineLearningTransactionResponse,
graphql_name="machineLearningDeleteConnector",
args=sgqlc.types.ArgDict(
(
(
"rag_setting_id",
sgqlc.types.Arg(ID, graphql_name="ragSettingId", default=None),
),
(
"tool_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="toolId", default=None
),
),
)
),
)
"""Arguments:
* `rag_setting_id` (`ID`): Identifier of the rag setting to be
used
* `tool_id` (`ID!`): Identifier of the tool to be deleted.
"""
machine_learning_delete_file_data_source = sgqlc.types.Field(
MachineLearningFileDataSource,
graphql_name="machineLearningDeleteFileDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_delete_project = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningDeleteProject",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_delete_stream_data_source = sgqlc.types.Field(
MachineLearningStreamDataSource,
graphql_name="machineLearningDeleteStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_halt_stream_data_source = sgqlc.types.Field(
MachineLearningStreamDataSource,
graphql_name="machineLearningHaltStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_index_connector = sgqlc.types.Field(
MachineLearningTransactionResponse,
graphql_name="machineLearningIndexConnector",
args=sgqlc.types.ArgDict(
(
(
"options",
sgqlc.types.Arg(
MachineLearningIndexOptions,
graphql_name="options",
default=None,
),
),
(
"rag_setting_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="ragSettingId",
default=None,
),
),
(
"tool_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="toolId", default=None
),
),
)
),
)
"""Arguments:
* `options` (`MachineLearningIndexOptions`): Optional object to
specify index options
* `rag_setting_id` (`ID!`): Identifier of the rag setting to be
used
* `tool_id` (`ID!`): Identifier of the tool to be used for
indexing.
"""
machine_learning_remove_document_index = sgqlc.types.Field(
MachineLearningTransactionResponse,
graphql_name="machineLearningRemoveDocumentIndex",
args=sgqlc.types.ArgDict(
(
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="documentId",
default=None,
),
),
(
"tool_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="toolId", default=None
),
),
)
),
)
"""Arguments:
* `document_id` (`ID!`): Identifier of the document from which the
index should be removed.
* `tool_id` (`ID!`): Identifier of the tool from which the index
should be removed.
"""
machine_learning_remove_file_data_source = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningRemoveFileDataSource",
args=sgqlc.types.ArgDict(
(
(
"file_data_source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="fileDataSourceId",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_remove_stream_data_source = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningRemoveStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"stream_data_source_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="streamDataSourceId",
default=None,
),
),
)
),
)
machine_learning_start_stream_data_source = sgqlc.types.Field(
MachineLearningStreamDataSource,
graphql_name="machineLearningStartStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
machine_learning_update_file_data_source = sgqlc.types.Field(
MachineLearningFileDataSource,
graphql_name="machineLearningUpdateFileDataSource",
args=sgqlc.types.ArgDict(
(
("blob_id", sgqlc.types.Arg(ID, graphql_name="blobId", default=None)),
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"file_name",
sgqlc.types.Arg(String, graphql_name="fileName", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"project_id",
sgqlc.types.Arg(ID, graphql_name="projectId", default=None),
),
)
),
)
machine_learning_update_project = sgqlc.types.Field(
MachineLearningProject,
graphql_name="machineLearningUpdateProject",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"status",
sgqlc.types.Arg(String, graphql_name="status", default=None),
),
)
),
)
machine_learning_update_stream_data_source = sgqlc.types.Field(
MachineLearningStreamDataSource,
graphql_name="machineLearningUpdateStreamDataSource",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="description",
default=None,
),
),
(
"filter",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="filter",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"sampling_rate",
sgqlc.types.Arg(
sgqlc.types.non_null(Float),
graphql_name="samplingRate",
default=None,
),
),
)
),
)
"""Arguments:
* `description` (`String!`): Description of the stream Data Source
* `filter` (`String!`): NRQL used to filter data to the topic
* `id` (`ID!`): ID of the Stream Data Source
* `name` (`String!`): Name of the stream Data Source
* `sampling_rate` (`Float!`): Sampling rate - between 0 and 1.
High sampling rates will equate to higher bills
"""
metric_normalization_create_rule = sgqlc.types.Field(
MetricNormalizationRuleMutationResponse,
graphql_name="metricNormalizationCreateRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(MetricNormalizationCreateRuleInput),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account Id
* `rule` (`MetricNormalizationCreateRuleInput!`): An input object
that represents the rule to be created.
"""
metric_normalization_disable_rule = sgqlc.types.Field(
MetricNormalizationRuleMutationResponse,
graphql_name="metricNormalizationDisableRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="ruleId", default=None
),
),
)
),
)
metric_normalization_edit_rule = sgqlc.types.Field(
MetricNormalizationRuleMutationResponse,
graphql_name="metricNormalizationEditRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule",
sgqlc.types.Arg(
sgqlc.types.non_null(MetricNormalizationEditRuleInput),
graphql_name="rule",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account Id
* `rule` (`MetricNormalizationEditRuleInput!`): An input object
that represents the rule to be created.
"""
metric_normalization_enable_rule = sgqlc.types.Field(
MetricNormalizationRuleMutationResponse,
graphql_name="metricNormalizationEnableRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="ruleId", default=None
),
),
)
),
)
mobile_push_notification_remove_device = sgqlc.types.Field(
sgqlc.types.non_null(MobilePushNotificationRemoveDeviceResult),
graphql_name="mobilePushNotificationRemoveDevice",
args=sgqlc.types.ArgDict(
(
(
"device_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="deviceId",
default=None,
),
),
)
),
)
"""Arguments:
* `device_id` (`String!`): The uuid of the device.
"""
mobile_push_notification_send_test_push = sgqlc.types.Field(
sgqlc.types.non_null(MobilePushNotificationSendPushResult),
graphql_name="mobilePushNotificationSendTestPush",
args=sgqlc.types.ArgDict(
(
(
"device_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="deviceId",
default=None,
),
),
)
),
)
"""Arguments:
* `device_id` (`String!`): The uuid of the device.
"""
mobile_push_notification_send_test_push_to_all = sgqlc.types.Field(
sgqlc.types.non_null(MobilePushNotificationSendPushResult),
graphql_name="mobilePushNotificationSendTestPushToAll",
)
nerd_storage_delete_collection = sgqlc.types.Field(
NerdStorageDeleteResult,
graphql_name="nerdStorageDeleteCollection",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageScopeInput),
graphql_name="scope",
default=None,
),
),
(
"scope_by_actor",
sgqlc.types.Arg(Boolean, graphql_name="scopeByActor", default=None),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The collection to be deleted.
* `scope` (`NerdStorageScopeInput!`): The data access level and ID
for the selected scope.
* `scope_by_actor` (`Boolean`)None
"""
nerd_storage_delete_document = sgqlc.types.Field(
NerdStorageDeleteResult,
graphql_name="nerdStorageDeleteDocument",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="documentId",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageScopeInput),
graphql_name="scope",
default=None,
),
),
(
"scope_by_actor",
sgqlc.types.Arg(Boolean, graphql_name="scopeByActor", default=None),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The NerdStorage collection that the
document being deleted belongs to.
* `document_id` (`String!`): The documentId of the document to be
deleted.
* `scope` (`NerdStorageScopeInput!`): The data access level and ID
for the selected scope.
* `scope_by_actor` (`Boolean`)None
"""
nerd_storage_vault_delete_secret = sgqlc.types.Field(
sgqlc.types.non_null(NerdStorageVaultDeleteSecretResult),
graphql_name="nerdStorageVaultDeleteSecret",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageVaultScope),
graphql_name="scope",
default=None,
),
),
)
),
)
"""Arguments:
* `key` (`String!`): The unique identifier of the secret.
* `scope` (`NerdStorageVaultScope!`): The NerdStorageVault data
access level of the secret.
"""
nerd_storage_vault_write_secret = sgqlc.types.Field(
sgqlc.types.non_null(NerdStorageVaultWriteSecretResult),
graphql_name="nerdStorageVaultWriteSecret",
args=sgqlc.types.ArgDict(
(
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageVaultScope),
graphql_name="scope",
default=None,
),
),
(
"secret",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageVaultWriteSecretInput),
graphql_name="secret",
default=None,
),
),
)
),
)
"""Arguments:
* `scope` (`NerdStorageVaultScope!`): The type of scope the secret
will be associated with. The mutation allows for only one scope
type at a time to add a secret.
* `secret` (`NerdStorageVaultWriteSecretInput!`): The secrets data
"""
nerd_storage_write_document = sgqlc.types.Field(
NerdStorageDocument,
graphql_name="nerdStorageWriteDocument",
args=sgqlc.types.ArgDict(
(
(
"collection",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="collection",
default=None,
),
),
(
"document",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageDocument),
graphql_name="document",
default=None,
),
),
(
"document_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="documentId",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdStorageScopeInput),
graphql_name="scope",
default=None,
),
),
(
"scope_by_actor",
sgqlc.types.Arg(Boolean, graphql_name="scopeByActor", default=None),
),
)
),
)
"""Arguments:
* `collection` (`String!`): The NerdStorage collection to which
the new document will be written.
* `document` (`NerdStorageDocument!`): The new NerdStorage
document to be written.
* `document_id` (`String!`): The documentId for the newly created
NerdStorage document.
* `scope` (`NerdStorageScopeInput!`): The data access level and ID
for the selected scope.
* `scope_by_actor` (`Boolean`)None
"""
nerdpack_add_allowed_accounts = sgqlc.types.Field(
NerdpackAllowListResult,
graphql_name="nerdpackAddAllowedAccounts",
args=sgqlc.types.ArgDict(
(
(
"allow_list",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackAllowListInput),
graphql_name="allowList",
default=None,
),
),
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
)
),
)
"""Arguments:
* `allow_list` (`NerdpackAllowListInput!`): Data of accounts to be
added to the allow list.
* `nerdpack_id` (`ID!`): Nerdpack id.
"""
nerdpack_create = sgqlc.types.Field(
NerdpackData,
graphql_name="nerdpackCreate",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_data",
sgqlc.types.Arg(
NerdpackCreationInput, graphql_name="nerdpackData", default=None
),
),
)
),
)
"""Arguments:
* `nerdpack_data` (`NerdpackCreationInput`): Nerdpack input data.
"""
nerdpack_remove_allowed_accounts = sgqlc.types.Field(
NerdpackAllowListResult,
graphql_name="nerdpackRemoveAllowedAccounts",
args=sgqlc.types.ArgDict(
(
(
"allow_list",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackAllowListInput),
graphql_name="allowList",
default=None,
),
),
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
)
),
)
"""Arguments:
* `allow_list` (`NerdpackAllowListInput!`): Data of accounts to be
removed from the allow list.
* `nerdpack_id` (`ID!`): Nerdpack id.
"""
nerdpack_remove_version_tag = sgqlc.types.Field(
NerdpackRemovedTagResponse,
graphql_name="nerdpackRemoveVersionTag",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
(
"version_tag",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackRemoveVersionTagInput),
graphql_name="versionTag",
default=None,
),
),
)
),
)
"""Arguments:
* `nerdpack_id` (`ID!`): Nerdpack id.
* `version_tag` (`NerdpackRemoveVersionTagInput!`): Input data for
nerdpack version tagging.
"""
nerdpack_subscribe_accounts = sgqlc.types.Field(
NerdpackSubscribeResult,
graphql_name="nerdpackSubscribeAccounts",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
(
"subscription",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackSubscribeAccountsInput),
graphql_name="subscription",
default=None,
),
),
)
),
)
"""Arguments:
* `nerdpack_id` (`ID!`): Nerdpack id.
* `subscription` (`NerdpackSubscribeAccountsInput!`): Subscription
data.
"""
nerdpack_tag_version = sgqlc.types.Field(
NerdpackVersion,
graphql_name="nerdpackTagVersion",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
(
"version_tag",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackTagVersionInput),
graphql_name="versionTag",
default=None,
),
),
)
),
)
"""Arguments:
* `nerdpack_id` (`ID!`): Nerdpack id.
* `version_tag` (`NerdpackTagVersionInput!`): Input data for
nerdpack version tagging.
"""
nerdpack_unsubscribe_accounts = sgqlc.types.Field(
NerdpackUnsubscribeResult,
graphql_name="nerdpackUnsubscribeAccounts",
args=sgqlc.types.ArgDict(
(
(
"nerdpack_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="nerdpackId",
default=None,
),
),
(
"subscription",
sgqlc.types.Arg(
sgqlc.types.non_null(NerdpackUnsubscribeAccountsInput),
graphql_name="subscription",
default=None,
),
),
)
),
)
"""Arguments:
* `nerdpack_id` (`ID!`): Nerdpack id.
* `subscription` (`NerdpackUnsubscribeAccountsInput!`):
Subscription data.
"""
nr1_catalog_install_alert_policy_template = sgqlc.types.Field(
Nr1CatalogInstallAlertPolicyTemplateResult,
graphql_name="nr1CatalogInstallAlertPolicyTemplate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"alert_policy_template_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="alertPolicyTemplateId",
default=None,
),
),
)
),
)
nr1_catalog_install_dashboard_template = sgqlc.types.Field(
Nr1CatalogInstallDashboardTemplateResult,
graphql_name="nr1CatalogInstallDashboardTemplate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"dashboard_template_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="dashboardTemplateId",
default=None,
),
),
)
),
)
nr1_catalog_submit_metadata = sgqlc.types.Field(
Nr1CatalogSubmitMetadataResult,
graphql_name="nr1CatalogSubmitMetadata",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"nerdpack_metadata",
sgqlc.types.Arg(
sgqlc.types.non_null(Nr1CatalogSubmitMetadataInput),
graphql_name="nerdpackMetadata",
default=None,
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The Nerdpack's ID that will be associated with the
metadata
* `nerdpack_metadata` (`Nr1CatalogSubmitMetadataInput!`): The
metadata for the Nerdpack that will be available in the New
Relic One Catalog
"""
nrql_cancel_query = sgqlc.types.Field(
NrqlCancelQueryMutationResponse,
graphql_name="nrqlCancelQuery",
args=sgqlc.types.ArgDict(
(
(
"query_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="queryId",
default=None,
),
),
)
),
)
nrql_drop_rules_create = sgqlc.types.Field(
NrqlDropRulesCreateDropRuleResult,
graphql_name="nrqlDropRulesCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rules",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(NrqlDropRulesCreateDropRuleInput)
),
graphql_name="rules",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account the targeted data report to.
* `rules` (`[NrqlDropRulesCreateDropRuleInput]!`): The list of
drop rules you want to create.
"""
nrql_drop_rules_delete = sgqlc.types.Field(
NrqlDropRulesDeleteDropRuleResult,
graphql_name="nrqlDropRulesDelete",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"rule_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(sgqlc.types.list_of(ID)),
graphql_name="ruleIds",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Account the rule was created on.
* `rule_ids` (`[ID]!`): The list of drop rules Ids you want to
delete.
"""
organization_create = sgqlc.types.Field(
OrganizationCreateOrganizationResponse,
graphql_name="organizationCreate",
args=sgqlc.types.ArgDict(
(
(
"customer_id",
sgqlc.types.Arg(ID, graphql_name="customerId", default=None),
),
(
"new_managed_account",
sgqlc.types.Arg(
OrganizationNewManagedAccountInput,
graphql_name="newManagedAccount",
default=None,
),
),
(
"organization",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationCreateOrganizationInput),
graphql_name="organization",
default=None,
),
),
(
"shared_account",
sgqlc.types.Arg(
OrganizationSharedAccountInput,
graphql_name="sharedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `customer_id` (`ID`): The customer id in which the new
organization will be created.
* `new_managed_account` (`OrganizationNewManagedAccountInput`):
The attributes of managed account to create. This is only
required if sharedAccount field is not provided.
* `organization` (`OrganizationCreateOrganizationInput!`): The
attributes of organization to create.
* `shared_account` (`OrganizationSharedAccountInput`): The
attributes of the account that will be shared with the new
organization. This is only required if newManagedAccount field
is not provided
"""
organization_create_shared_account = sgqlc.types.Field(
OrganizationCreateSharedAccountResponse,
graphql_name="organizationCreateSharedAccount",
args=sgqlc.types.ArgDict(
(
(
"shared_account",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationCreateSharedAccountInput),
graphql_name="sharedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `shared_account` (`OrganizationCreateSharedAccountInput!`): The
attributes for the account share.
"""
organization_provisioning_update_partner_subscription = sgqlc.types.Field(
sgqlc.types.non_null(OrganizationProvisioningUpdateSubscriptionResult),
graphql_name="organizationProvisioningUpdatePartnerSubscription",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"affected_account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="affectedAccountId",
default=None,
),
),
(
"products",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
OrganizationProvisioningProductInput
)
)
),
graphql_name="products",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): Partner Owner Account Id for the
Partnership that includes the affected account.
* `affected_account_id` (`Int!`): Account id to which new
entitlements will be applied
* `products` (`[OrganizationProvisioningProductInput!]!`): New
entitlement set to be applied
"""
organization_revoke_shared_account = sgqlc.types.Field(
OrganizationRevokeSharedAccountResponse,
graphql_name="organizationRevokeSharedAccount",
args=sgqlc.types.ArgDict(
(
(
"shared_account",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationRevokeSharedAccountInput),
graphql_name="sharedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `shared_account` (`OrganizationRevokeSharedAccountInput!`): The
attributes for the revoked account share.
"""
organization_update = sgqlc.types.Field(
OrganizationUpdateResponse,
graphql_name="organizationUpdate",
args=sgqlc.types.ArgDict(
(
(
"organization",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationUpdateInput),
graphql_name="organization",
default=None,
),
),
(
"organization_id",
sgqlc.types.Arg(ID, graphql_name="organizationId", default=None),
),
)
),
)
"""Arguments:
* `organization` (`OrganizationUpdateInput!`): The new attributes
for the organization.
* `organization_id` (`ID`): The id of the organization to update
"""
organization_update_shared_account = sgqlc.types.Field(
OrganizationUpdateSharedAccountResponse,
graphql_name="organizationUpdateSharedAccount",
args=sgqlc.types.ArgDict(
(
(
"shared_account",
sgqlc.types.Arg(
sgqlc.types.non_null(OrganizationUpdateSharedAccountInput),
graphql_name="sharedAccount",
default=None,
),
),
)
),
)
"""Arguments:
* `shared_account` (`OrganizationUpdateSharedAccountInput!`): The
new attributes for the account share.
"""
pixie_link_pixie_project = sgqlc.types.Field(
PixieLinkPixieProjectResult,
graphql_name="pixieLinkPixieProject",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"api_key",
sgqlc.types.Arg(SecureValue, graphql_name="apiKey", default=None),
),
)
),
)
pixie_record_pixie_tos_acceptance = sgqlc.types.Field(
PixieRecordPixieTosAcceptanceResult,
graphql_name="pixieRecordPixieTosAcceptance",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
)
),
)
pixie_unlink_pixie_project = sgqlc.types.Field(
PixieLinkPixieProjectResult,
graphql_name="pixieUnlinkPixieProject",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
)
),
)
reference_entity_create_or_update_repository = sgqlc.types.Field(
ReferenceEntityCreateRepositoryResult,
graphql_name="referenceEntityCreateOrUpdateRepository",
args=sgqlc.types.ArgDict(
(
(
"repositories",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
ReferenceEntityCreateRepositoryInput
)
)
),
graphql_name="repositories",
default=None,
),
),
("sync", sgqlc.types.Arg(Boolean, graphql_name="sync", default=None)),
)
),
)
"""Arguments:
* `repositories` (`[ReferenceEntityCreateRepositoryInput!]!`): The
list of repositories to create or update.
* `sync` (`Boolean`): Flag to force a synchronous execution of the
mutation, which means that the entity has been stored once the
mutation returns. Default is 'false', which means the entity is
queued for storage.
"""
secrets_management_create_secret = sgqlc.types.Field(
"SecretsManagementCreateSecretResponse",
graphql_name="secretsManagementCreateSecret",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(SecretsManagementTagInput)
),
graphql_name="tags",
default=None,
),
),
(
"value",
sgqlc.types.Arg(
sgqlc.types.non_null(SecureValue),
graphql_name="value",
default=None,
),
),
)
),
)
"""Arguments:
* `description` (`String`): The description of the secret
* `key` (`String!`): The `key` field of the secret to create
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `scope` (`SecretsManagementScope!`): The scope of the secret
* `tags` (`[SecretsManagementTagInput!]`): The list of tags to
associate with the secret
* `value` (`SecureValue!`): The `value` field of the secret to
create
"""
secrets_management_create_shareable_secret = sgqlc.types.Field(
"SecretsManagementCreateSecretResponse",
graphql_name="secretsManagementCreateShareableSecret",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(SecretsManagementTagInput)
),
graphql_name="tags",
default=None,
),
),
(
"value",
sgqlc.types.Arg(
sgqlc.types.non_null(SecureValue),
graphql_name="value",
default=None,
),
),
)
),
)
"""Arguments:
* `description` (`String`): The description of the secret
* `key` (`String!`): The `key` field of the secret to create
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `scope` (`SecretsManagementScope!`): The scope of the secret
* `tags` (`[SecretsManagementTagInput!]`): The list of tags to
associate with the secret
* `value` (`SecureValue!`): The `value` field of the secret to
create
"""
secrets_management_delete_secret = sgqlc.types.Field(
"SecretsManagementDeleteSecretResponse",
graphql_name="secretsManagementDeleteSecret",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"purge",
sgqlc.types.Arg(Boolean, graphql_name="purge", default=False),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
)
),
)
secrets_management_delete_secret_version = sgqlc.types.Field(
"SecretsManagementDeleteSecretVersionResponse",
graphql_name="secretsManagementDeleteSecretVersion",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"purge",
sgqlc.types.Arg(Boolean, graphql_name="purge", default=False),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `key` (`String!`): The `key` field of the secret to delete
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `purge` (`Boolean`): When purging we delete the secret from the
database (default: `false`)
* `scope` (`SecretsManagementScope!`): The scope of the secret
* `version` (`Int`): The version to be deleted. If left empty then
latest version will be deleted
"""
secrets_management_recover_secret = sgqlc.types.Field(
"SecretsManagementRecoverSecretResponse",
graphql_name="secretsManagementRecoverSecret",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
)
),
)
secrets_management_recover_secret_version = sgqlc.types.Field(
"SecretsManagementRecoverSecretVersionResponse",
graphql_name="secretsManagementRecoverSecretVersion",
args=sgqlc.types.ArgDict(
(
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
secrets_management_update_secret = sgqlc.types.Field(
"SecretsManagementUpdateSecretResponse",
graphql_name="secretsManagementUpdateSecret",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"namespace",
sgqlc.types.Arg(String, graphql_name="namespace", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(SecretsManagementScope),
graphql_name="scope",
default=None,
),
),
(
"value",
sgqlc.types.Arg(SecureValue, graphql_name="value", default=None),
),
)
),
)
"""Arguments:
* `description` (`String`): The new `description` of the secret.
Allowed characters - (a-z), (A-Z), (0-9), spaces, [,:_.;!-] or
length (1 - 4000 chars)
* `key` (`String!`): The `key` field of the secret to update
* `namespace` (`String`): The `namespace` field is a value unique
per calling service
* `scope` (`SecretsManagementScope!`): The scope of the secret
* `value` (`SecureValue`): The new `value` field secured value eg.
secret key or password
"""
service_level_create = sgqlc.types.Field(
"ServiceLevelIndicator",
graphql_name="serviceLevelCreate",
args=sgqlc.types.ArgDict(
(
(
"entity_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="entityGuid",
default=None,
),
),
(
"indicator",
sgqlc.types.Arg(
sgqlc.types.non_null(ServiceLevelIndicatorCreateInput),
graphql_name="indicator",
default=None,
),
),
)
),
)
"""Arguments:
* `entity_guid` (`EntityGuid!`): The entity GUID which the SLI
will be attached to.
* `indicator` (`ServiceLevelIndicatorCreateInput!`): The input
object that represents the SLI that will be created.
"""
service_level_delete = sgqlc.types.Field(
"ServiceLevelIndicator",
graphql_name="serviceLevelDelete",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(EntityGuid, graphql_name="guid", default=None),
),
("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),
)
),
)
"""Arguments:
* `guid` (`EntityGuid`): The unique entity identifier of the SLI.
* `id` (`ID`): [DEPRECATED] Please, use the GUID input field to
delete the SLI.
"""
service_level_update = sgqlc.types.Field(
"ServiceLevelIndicator",
graphql_name="serviceLevelUpdate",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(EntityGuid, graphql_name="guid", default=None),
),
("id", sgqlc.types.Arg(ID, graphql_name="id", default=None)),
(
"indicator",
sgqlc.types.Arg(
sgqlc.types.non_null(ServiceLevelIndicatorUpdateInput),
graphql_name="indicator",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid`): The unique entity identifier of the SLI.
* `id` (`ID`): [DEPRECATED] Please, use the GUID input field to
update the SLI.
* `indicator` (`ServiceLevelIndicatorUpdateInput!`): The input
object that represents the SLI that will be updated.
"""
sessions_revoke = sgqlc.types.Field(
"SessionsRevokeSessionResponse",
graphql_name="sessionsRevoke",
args=sgqlc.types.ArgDict(
(
(
"client_id",
sgqlc.types.Arg(ID, graphql_name="clientId", default=None),
),
(
"ids",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="ids",
default=None,
),
),
)
),
)
"""Arguments:
* `client_id` (`ID`): The client ID associated with the sessions
to revoke
* `ids` (`[ID!]`): The IDs of the sessions to revoke
"""
streaming_export_create_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingExportCreateRule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"aws_parameters",
sgqlc.types.Arg(
StreamingExportAwsInput,
graphql_name="awsParameters",
default=None,
),
),
(
"azure_parameters",
sgqlc.types.Arg(
StreamingExportAzureInput,
graphql_name="azureParameters",
default=None,
),
),
(
"gcp_parameters",
sgqlc.types.Arg(
StreamingExportGcpInput,
graphql_name="gcpParameters",
default=None,
),
),
(
"rule_parameters",
sgqlc.types.Arg(
sgqlc.types.non_null(StreamingExportRuleInput),
graphql_name="ruleParameters",
default=None,
),
),
)
),
)
streaming_export_delete_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingExportDeleteRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
streaming_export_disable_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingExportDisableRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
streaming_export_enable_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingExportEnableRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
streaming_export_update_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingExportUpdateRule",
args=sgqlc.types.ArgDict(
(
(
"aws_parameters",
sgqlc.types.Arg(
StreamingExportAwsInput,
graphql_name="awsParameters",
default=None,
),
),
(
"azure_parameters",
sgqlc.types.Arg(
StreamingExportAzureInput,
graphql_name="azureParameters",
default=None,
),
),
(
"gcp_parameters",
sgqlc.types.Arg(
StreamingExportGcpInput,
graphql_name="gcpParameters",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
(
"rule_parameters",
sgqlc.types.Arg(
sgqlc.types.non_null(StreamingExportRuleInput),
graphql_name="ruleParameters",
default=None,
),
),
)
),
)
synthetics_create_broken_links_monitor = sgqlc.types.Field(
"SyntheticsBrokenLinksMonitorCreateMutationResult",
graphql_name="syntheticsCreateBrokenLinksMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateBrokenLinksMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_cert_check_monitor = sgqlc.types.Field(
"SyntheticsCertCheckMonitorCreateMutationResult",
graphql_name="syntheticsCreateCertCheckMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateCertCheckMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_daily_monitor_downtime = sgqlc.types.Field(
"SyntheticsDailyMonitorDowntimeMutationResult",
graphql_name="syntheticsCreateDailyMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"end_repeat",
sgqlc.types.Arg(
SyntheticsDateWindowEndConfig,
graphql_name="endRepeat",
default=None,
),
),
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="endTime",
default=None,
),
),
(
"monitor_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(EntityGuid),
graphql_name="monitorGuids",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="startTime",
default=None,
),
),
(
"timezone",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="timezone",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account that will be associated with
the created monitor downtime
* `end_repeat` (`SyntheticsDateWindowEndConfig`): Configuration
options if the customer wants the monitor to end at a specific
date
* `end_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will end
* `monitor_guids` (`[EntityGuid]`): Monitor GUIDs this monitor
downtime will affect
* `name` (`String!`): The name of the monitor downtime
* `start_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will begin
* `timezone` (`String!`): The timezone the time values will be in
"""
synthetics_create_monthly_monitor_downtime = sgqlc.types.Field(
"SyntheticsMonthlyMonitorDowntimeMutationResult",
graphql_name="syntheticsCreateMonthlyMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"end_repeat",
sgqlc.types.Arg(
SyntheticsDateWindowEndConfig,
graphql_name="endRepeat",
default=None,
),
),
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="endTime",
default=None,
),
),
(
"frequency",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsMonitorDowntimeMonthlyFrequency),
graphql_name="frequency",
default=None,
),
),
(
"monitor_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(EntityGuid),
graphql_name="monitorGuids",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="startTime",
default=None,
),
),
(
"timezone",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="timezone",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account that will be associated with
the created monitor downtime
* `end_repeat` (`SyntheticsDateWindowEndConfig`): Configuration
options if the customer wants the monitor to end at a specific
date
* `end_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will end
* `frequency` (`SyntheticsMonitorDowntimeMonthlyFrequency!`):
Configuration options for which days of the month a monitor
downtime will occur
* `monitor_guids` (`[EntityGuid]`): Monitor GUIDs this monitor
downtime will affect
* `name` (`String!`): The name of the monitor downtime
* `start_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will begin
* `timezone` (`String!`): The timezone the time values will be in
"""
synthetics_create_once_monitor_downtime = sgqlc.types.Field(
"SyntheticsOnceMonitorDowntimeMutationResult",
graphql_name="syntheticsCreateOnceMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="endTime",
default=None,
),
),
(
"monitor_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(EntityGuid),
graphql_name="monitorGuids",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="startTime",
default=None,
),
),
(
"timezone",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="timezone",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account that will be associated with
the created monitor downtime
* `end_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will end
* `monitor_guids` (`[EntityGuid]`): Monitor GUIDs this monitor
downtime will affect
* `name` (`String!`): The name of the monitor downtime
* `start_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will begin
* `timezone` (`String!`): The timezone the time values will be in
"""
synthetics_create_private_location = sgqlc.types.Field(
"SyntheticsPrivateLocationMutationResult",
graphql_name="syntheticsCreatePrivateLocation",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"shared",
sgqlc.types.Arg(Boolean, graphql_name="shared", default=None),
),
(
"verified_script_execution",
sgqlc.types.Arg(
sgqlc.types.non_null(Boolean),
graphql_name="verifiedScriptExecution",
default=None,
),
),
)
),
)
synthetics_create_script_api_monitor = sgqlc.types.Field(
"SyntheticsScriptApiMonitorCreateMutationResult",
graphql_name="syntheticsCreateScriptApiMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateScriptApiMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_script_browser_monitor = sgqlc.types.Field(
"SyntheticsScriptBrowserMonitorCreateMutationResult",
graphql_name="syntheticsCreateScriptBrowserMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateScriptBrowserMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_secure_credential = sgqlc.types.Field(
"SyntheticsSecureCredentialMutationResult",
graphql_name="syntheticsCreateSecureCredential",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"value",
sgqlc.types.Arg(
sgqlc.types.non_null(SecureValue),
graphql_name="value",
default=None,
),
),
)
),
)
synthetics_create_simple_browser_monitor = sgqlc.types.Field(
"SyntheticsSimpleBrowserMonitorCreateMutationResult",
graphql_name="syntheticsCreateSimpleBrowserMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateSimpleBrowserMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_simple_monitor = sgqlc.types.Field(
"SyntheticsSimpleBrowserMonitorCreateMutationResult",
graphql_name="syntheticsCreateSimpleMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateSimpleMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_step_monitor = sgqlc.types.Field(
"SyntheticsStepMonitorCreateMutationResult",
graphql_name="syntheticsCreateStepMonitor",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsCreateStepMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_create_weekly_monitor_downtime = sgqlc.types.Field(
"SyntheticsWeeklyMonitorDowntimeMutationResult",
graphql_name="syntheticsCreateWeeklyMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"end_repeat",
sgqlc.types.Arg(
SyntheticsDateWindowEndConfig,
graphql_name="endRepeat",
default=None,
),
),
(
"end_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="endTime",
default=None,
),
),
(
"maintenance_days",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(SyntheticsMonitorDowntimeWeekDays)
),
graphql_name="maintenanceDays",
default=None,
),
),
(
"monitor_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(EntityGuid),
graphql_name="monitorGuids",
default=None,
),
),
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"start_time",
sgqlc.types.Arg(
sgqlc.types.non_null(NaiveDateTime),
graphql_name="startTime",
default=None,
),
),
(
"timezone",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="timezone",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account that will be associated with
the created monitor downtime
* `end_repeat` (`SyntheticsDateWindowEndConfig`): Configuration
options if the customer wants the monitor to end at a specific
date
* `end_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will end
* `maintenance_days` (`[SyntheticsMonitorDowntimeWeekDays]!`):
Days of the week the monitor downtime will run
* `monitor_guids` (`[EntityGuid]`): Monitor GUIDs this monitor
downtime will affect
* `name` (`String!`): The name of the monitor downtime
* `start_time` (`NaiveDateTime!`): The date and time in which the
monitor downtime will begin
* `timezone` (`String!`): The timezone the time values will be in
"""
synthetics_delete_monitor = sgqlc.types.Field(
"SyntheticsMonitorDeleteMutationResult",
graphql_name="syntheticsDeleteMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
synthetics_delete_monitor_downtime = sgqlc.types.Field(
"SyntheticsMonitorDowntimeDeleteResult",
graphql_name="syntheticsDeleteMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
synthetics_delete_private_location = sgqlc.types.Field(
"SyntheticsPrivateLocationDeleteResult",
graphql_name="syntheticsDeletePrivateLocation",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
synthetics_delete_secure_credential = sgqlc.types.Field(
"SyntheticsSecureCredentialMutationResult",
graphql_name="syntheticsDeleteSecureCredential",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
)
),
)
synthetics_edit_monitor_downtime = sgqlc.types.Field(
"SyntheticsMonitorDowntimeMutationResult",
graphql_name="syntheticsEditMonitorDowntime",
args=sgqlc.types.ArgDict(
(
(
"daily",
sgqlc.types.Arg(
SyntheticsMonitorDowntimeDailyConfig,
graphql_name="daily",
default=None,
),
),
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor_guids",
sgqlc.types.Arg(
sgqlc.types.list_of(EntityGuid),
graphql_name="monitorGuids",
default=None,
),
),
(
"monthly",
sgqlc.types.Arg(
SyntheticsMonitorDowntimeMonthlyConfig,
graphql_name="monthly",
default=None,
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"once",
sgqlc.types.Arg(
SyntheticsMonitorDowntimeOnceConfig,
graphql_name="once",
default=None,
),
),
(
"weekly",
sgqlc.types.Arg(
SyntheticsMonitorDowntimeWeeklyConfig,
graphql_name="weekly",
default=None,
),
),
)
),
)
"""Arguments:
* `daily` (`SyntheticsMonitorDowntimeDailyConfig`): Configuration
options for a monitor downtime that runs daily (only 1 of these
can be selected)
* `guid` (`EntityGuid!`): The unique identifier for the Synthetic
Monitor Downtime in New Relic
* `monitor_guids` (`[EntityGuid]`): Monitor GUIDs this monitor
downtime will affect
* `monthly` (`SyntheticsMonitorDowntimeMonthlyConfig`):
Configuration options for a monitor downtime that runs monthly
(only 1 of these can be selected)
* `name` (`String`): The name for the monitor downtime
* `once` (`SyntheticsMonitorDowntimeOnceConfig`): Configuration
options for a monitor downtime that runs once (only 1 of these
can be selected)
* `weekly` (`SyntheticsMonitorDowntimeWeeklyConfig`):
Configuration options for a monitor downtime that runs weekly
(only 1 of these can be selected)
"""
synthetics_purge_private_location_queue = sgqlc.types.Field(
"SyntheticsPrivateLocationPurgeQueueResult",
graphql_name="syntheticsPurgePrivateLocationQueue",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
synthetics_update_broken_links_monitor = sgqlc.types.Field(
"SyntheticsBrokenLinksMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateBrokenLinksMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateBrokenLinksMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_cert_check_monitor = sgqlc.types.Field(
"SyntheticsCertCheckMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateCertCheckMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateCertCheckMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_private_location = sgqlc.types.Field(
"SyntheticsPrivateLocationMutationResult",
graphql_name="syntheticsUpdatePrivateLocation",
args=sgqlc.types.ArgDict(
(
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"shared",
sgqlc.types.Arg(Boolean, graphql_name="shared", default=None),
),
(
"verified_script_execution",
sgqlc.types.Arg(
Boolean, graphql_name="verifiedScriptExecution", default=None
),
),
)
),
)
synthetics_update_script_api_monitor = sgqlc.types.Field(
"SyntheticsScriptApiMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateScriptApiMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateScriptApiMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_script_browser_monitor = sgqlc.types.Field(
"SyntheticsScriptBrowserMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateScriptBrowserMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateScriptBrowserMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_secure_credential = sgqlc.types.Field(
"SyntheticsSecureCredentialMutationResult",
graphql_name="syntheticsUpdateSecureCredential",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"description",
sgqlc.types.Arg(String, graphql_name="description", default=None),
),
(
"key",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="key", default=None
),
),
(
"value",
sgqlc.types.Arg(SecureValue, graphql_name="value", default=None),
),
)
),
)
synthetics_update_simple_browser_monitor = sgqlc.types.Field(
"SyntheticsSimpleBrowserMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateSimpleBrowserMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateSimpleBrowserMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_simple_monitor = sgqlc.types.Field(
"SyntheticsSimpleMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateSimpleMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateSimpleMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
synthetics_update_step_monitor = sgqlc.types.Field(
"SyntheticsStepMonitorUpdateMutationResult",
graphql_name="syntheticsUpdateStepMonitor",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"monitor",
sgqlc.types.Arg(
sgqlc.types.non_null(SyntheticsUpdateStepMonitorInput),
graphql_name="monitor",
default=None,
),
),
)
),
)
system_identity_add_to_groups = sgqlc.types.Field(
"SystemIdentityGroupList",
graphql_name="systemIdentityAddToGroups",
args=sgqlc.types.ArgDict(
(
(
"system_identity_group_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="systemIdentityGroupIds",
default=None,
),
),
(
"system_identity_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="systemIdentityIds",
default=None,
),
),
)
),
)
"""Arguments:
* `system_identity_group_ids` (`[ID!]!`): The list of system
identity group ids to add the system identities ids to
* `system_identity_ids` (`[ID!]!`): The list of system identities
ids to add
"""
system_identity_create = sgqlc.types.Field(
"SystemIdentityCreatedSystemIdentity",
graphql_name="systemIdentityCreate",
args=sgqlc.types.ArgDict(
(
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"organization_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="organizationId",
default=None,
),
),
(
"public_key",
sgqlc.types.Arg(String, graphql_name="publicKey", default=None),
),
)
),
)
system_identity_create_group = sgqlc.types.Field(
"SystemIdentityGroupType",
graphql_name="systemIdentityCreateGroup",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
(
"organization_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID),
graphql_name="organizationId",
default=None,
),
),
)
),
)
system_identity_delete = sgqlc.types.Field(
"SystemIdentityType",
graphql_name="systemIdentityDelete",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
system_identity_delete_group = sgqlc.types.Field(
"SystemIdentityGroupType",
graphql_name="systemIdentityDeleteGroup",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
system_identity_remove_from_groups = sgqlc.types.Field(
"SystemIdentityGroupList",
graphql_name="systemIdentityRemoveFromGroups",
args=sgqlc.types.ArgDict(
(
(
"system_identity_group_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="systemIdentityGroupIds",
default=None,
),
),
(
"system_identity_ids",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(ID))
),
graphql_name="systemIdentityIds",
default=None,
),
),
)
),
)
"""Arguments:
* `system_identity_group_ids` (`[ID!]!`): A List of System
Identity Groups on which to remove membership
* `system_identity_ids` (`[ID!]!`): A List of System Identity Ids
"""
system_identity_update = sgqlc.types.Field(
"SystemIdentityType",
graphql_name="systemIdentityUpdate",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
(
"public_key",
sgqlc.types.Arg(String, graphql_name="publicKey", default=None),
),
)
),
)
system_identity_update_group = sgqlc.types.Field(
"SystemIdentityGroupType",
graphql_name="systemIdentityUpdateGroup",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
("name", sgqlc.types.Arg(String, graphql_name="name", default=None)),
)
),
)
tagging_add_tags_to_entity = sgqlc.types.Field(
"TaggingMutationResult",
graphql_name="taggingAddTagsToEntity",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(TaggingTagInput))
),
graphql_name="tags",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The guid of the new entity.
* `tags` (`[TaggingTagInput!]!`): An array of key-values pairs to
represent a tag. For example: Team:TeamName.
"""
tagging_delete_tag_from_entity = sgqlc.types.Field(
"TaggingMutationResult",
graphql_name="taggingDeleteTagFromEntity",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"tag_keys",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(String))
),
graphql_name="tagKeys",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The guid of the existing entity.
* `tag_keys` (`[String!]!`): An array of keys that have to be
deleted. For example: ['Team'].
"""
tagging_delete_tag_values_from_entity = sgqlc.types.Field(
"TaggingMutationResult",
graphql_name="taggingDeleteTagValuesFromEntity",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"tag_values",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(TaggingTagValueInput)
)
),
graphql_name="tagValues",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The guid of the existing entity.
* `tag_values` (`[TaggingTagValueInput!]!`): An array of key-
values pairs to represent a tag. For example: Team:TeamName.
"""
tagging_replace_tags_on_entity = sgqlc.types.Field(
"TaggingMutationResult",
graphql_name="taggingReplaceTagsOnEntity",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(TaggingTagInput))
),
graphql_name="tags",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The guid of the existing entity.
* `tags` (`[TaggingTagInput!]!`): An array of key-values pairs to
represent a tag. For example: Team:TeamName.
"""
user_management_add_users_to_groups = sgqlc.types.Field(
"UserManagementAddUsersToGroupsPayload",
graphql_name="userManagementAddUsersToGroups",
args=sgqlc.types.ArgDict(
(
(
"add_users_to_groups_options",
sgqlc.types.Arg(
UserManagementUsersGroupsInput,
graphql_name="addUsersToGroupsOptions",
default=None,
),
),
)
),
)
"""Arguments:
* `add_users_to_groups_options`
(`UserManagementUsersGroupsInput`): The input object
representing the group(s) and user(s) to update.
"""
user_management_create_group = sgqlc.types.Field(
"UserManagementCreateGroupPayload",
graphql_name="userManagementCreateGroup",
args=sgqlc.types.ArgDict(
(
(
"create_group_options",
sgqlc.types.Arg(
UserManagementCreateGroup,
graphql_name="createGroupOptions",
default=None,
),
),
)
),
)
user_management_create_user = sgqlc.types.Field(
"UserManagementCreateUserPayload",
graphql_name="userManagementCreateUser",
args=sgqlc.types.ArgDict(
(
(
"create_user_options",
sgqlc.types.Arg(
sgqlc.types.non_null(UserManagementCreateUser),
graphql_name="createUserOptions",
default=None,
),
),
)
),
)
"""Arguments:
* `create_user_options` (`UserManagementCreateUser!`): The input
object representing the user to be created.
"""
user_management_delete_group = sgqlc.types.Field(
"UserManagementDeleteGroupPayload",
graphql_name="userManagementDeleteGroup",
args=sgqlc.types.ArgDict(
(
(
"group_options",
sgqlc.types.Arg(
UserManagementDeleteGroup,
graphql_name="groupOptions",
default=None,
),
),
)
),
)
user_management_delete_user = sgqlc.types.Field(
"UserManagementDeleteUserPayload",
graphql_name="userManagementDeleteUser",
args=sgqlc.types.ArgDict(
(
(
"delete_user_options",
sgqlc.types.Arg(
sgqlc.types.non_null(UserManagementDeleteUser),
graphql_name="deleteUserOptions",
default=None,
),
),
)
),
)
"""Arguments:
* `delete_user_options` (`UserManagementDeleteUser!`): The input
object containing the id of the user to be deleted.
"""
user_management_remove_users_from_groups = sgqlc.types.Field(
"UserManagementRemoveUsersFromGroupsPayload",
graphql_name="userManagementRemoveUsersFromGroups",
args=sgqlc.types.ArgDict(
(
(
"remove_users_from_groups_options",
sgqlc.types.Arg(
sgqlc.types.non_null(UserManagementUsersGroupsInput),
graphql_name="removeUsersFromGroupsOptions",
default=None,
),
),
)
),
)
"""Arguments:
* `remove_users_from_groups_options`
(`UserManagementUsersGroupsInput!`): The input object
representing the users to remove and the groups to remove them
from.
"""
user_management_update_group = sgqlc.types.Field(
"UserManagementUpdateGroupPayload",
graphql_name="userManagementUpdateGroup",
args=sgqlc.types.ArgDict(
(
(
"update_group_options",
sgqlc.types.Arg(
UserManagementUpdateGroup,
graphql_name="updateGroupOptions",
default=None,
),
),
)
),
)
user_management_update_user = sgqlc.types.Field(
"UserManagementUpdateUserPayload",
graphql_name="userManagementUpdateUser",
args=sgqlc.types.ArgDict(
(
(
"update_user_options",
sgqlc.types.Arg(
sgqlc.types.non_null(UserManagementUpdateUser),
graphql_name="updateUserOptions",
default=None,
),
),
)
),
)
"""Arguments:
* `update_user_options` (`UserManagementUpdateUser!`): The input
object representing the user to be updated.
"""
whats_new_set_last_read_date = sgqlc.types.Field(
EpochMilliseconds,
graphql_name="whatsNewSetLastReadDate",
args=sgqlc.types.ArgDict(
(
(
"date",
sgqlc.types.Arg(
sgqlc.types.non_null(EpochMilliseconds),
graphql_name="date",
default=None,
),
),
)
),
)
"""Arguments:
* `date` (`EpochMilliseconds!`): The date, represented since the
epoch in milliseconds, the current user last read the news.
"""
workflow_automation_create_schedule = sgqlc.types.Field(
"WorkflowAutomationCreateScheduleResponse",
graphql_name="workflowAutomationCreateSchedule",
args=sgqlc.types.ArgDict(
(
(
"cron_expression",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="cronExpression",
default=None,
),
),
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationCreateScheduleDefinitionInput
),
graphql_name="definition",
default=None,
),
),
(
"options",
sgqlc.types.Arg(
WorkflowAutomationWorkflowRunOptions,
graphql_name="options",
default=None,
),
),
(
"overlap_policy",
sgqlc.types.Arg(
WorkflowAutomationScheduleOverlapPolicy,
graphql_name="overlapPolicy",
default="SKIP",
),
),
(
"schedule_name",
sgqlc.types.Arg(String, graphql_name="scheduleName", default=None),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationWorkflowRunScope),
graphql_name="scope",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationTag)
),
graphql_name="tags",
default=None,
),
),
(
"timezone",
sgqlc.types.Arg(String, graphql_name="timezone", default=None),
),
(
"workflow_inputs",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationWorkflowRunInput)
),
graphql_name="workflowInputs",
default=None,
),
),
)
),
)
"""Arguments:
* `cron_expression` (`String!`): A cron expression that describes
the desired schedule
* `definition`
(`WorkflowAutomationCreateScheduleDefinitionInput!`): Scope
type, name and version of the workflow definition to create a
schedule for
* `options` (`WorkflowAutomationWorkflowRunOptions`): Options for
workflow runs
* `overlap_policy` (`WorkflowAutomationScheduleOverlapPolicy`):
Controls what happens if a scheduled run would overlap with an
existing run. Defaults to SKIP. (default: `SKIP`)
* `schedule_name` (`String`): Schedule name
* `scope` (`WorkflowAutomationWorkflowRunScope!`): Scope of the
workflow run
* `tags` (`[WorkflowAutomationTag!]`): List of tags to associate
with the workflow schedule
* `timezone` (`String`): Schedule Timezone
* `workflow_inputs` (`[WorkflowAutomationWorkflowRunInput!]`):
Workflow inputs
"""
workflow_automation_create_workflow_definition = sgqlc.types.Field(
"WorkflowAutomationCreateWorkflowDefinitionResponse",
graphql_name="workflowAutomationCreateWorkflowDefinition",
args=sgqlc.types.ArgDict(
(
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationCreateWorkflowDefinitionInput
),
graphql_name="definition",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationScopeInput),
graphql_name="scope",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationTag)
),
graphql_name="tags",
default=None,
),
),
)
),
)
"""Arguments:
* `definition`
(`WorkflowAutomationCreateWorkflowDefinitionInput!`): Input for
creating a workflow definition
* `scope` (`WorkflowAutomationScopeInput!`): The scope for the
workflow definition
* `tags` (`[WorkflowAutomationTag!]`): List of tags to associate
with the workflow definition
"""
workflow_automation_delete_schedule = sgqlc.types.Field(
"WorkflowAutomationDeleteScheduleResponse",
graphql_name="workflowAutomationDeleteSchedule",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"schedule",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationDeleteScheduleInput),
graphql_name="schedule",
default=None,
),
),
)
),
)
workflow_automation_delete_workflow_definition = sgqlc.types.Field(
"WorkflowAutomationDeleteWorkflowDefinitionResponse",
graphql_name="workflowAutomationDeleteWorkflowDefinition",
args=sgqlc.types.ArgDict(
(
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationDeleteWorkflowDefinitionInput
),
graphql_name="definition",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationScopeInput),
graphql_name="scope",
default=None,
),
),
)
),
)
workflow_automation_signal_workflow_run = sgqlc.types.Field(
"WorkflowAutomationSignalWorkflowRunResponse",
graphql_name="workflowAutomationSignalWorkflowRun",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"run_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="runId", default=None
),
),
(
"signal_inputs",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationSignalInput)
),
graphql_name="signalInputs",
default=None,
),
),
(
"signal_name",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="signalName",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The account ID this workflow run is
scoped to
* `run_id` (`ID!`): Unique identifier for the workflow run
* `signal_inputs` (`[WorkflowAutomationSignalInput!]`): Signal
inputs
* `signal_name` (`String!`): Signal name
"""
workflow_automation_start_workflow_run = sgqlc.types.Field(
"WorkflowAutomationStartWorkflowRunResponse",
graphql_name="workflowAutomationStartWorkflowRun",
args=sgqlc.types.ArgDict(
(
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationStartWorkflowRunDefinitionInput
),
graphql_name="definition",
default=None,
),
),
(
"idempotency_key",
sgqlc.types.Arg(ID, graphql_name="idempotencyKey", default=None),
),
(
"options",
sgqlc.types.Arg(
WorkflowAutomationWorkflowRunOptions,
graphql_name="options",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationWorkflowRunScope),
graphql_name="scope",
default=None,
),
),
(
"workflow_inputs",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationWorkflowRunInput)
),
graphql_name="workflowInputs",
default=None,
),
),
)
),
)
"""Arguments:
* `definition`
(`WorkflowAutomationStartWorkflowRunDefinitionInput!`): Scope
type, name and version of the workflow definition to run
* `idempotency_key` (`ID`): Unique identifier to ensure
idempotency of the request.
* `options` (`WorkflowAutomationWorkflowRunOptions`): Options for
workflow runs
* `scope` (`WorkflowAutomationWorkflowRunScope!`): Scope of the
workflow run
* `workflow_inputs` (`[WorkflowAutomationWorkflowRunInput!]`):
Workflow inputs
"""
workflow_automation_stop_workflow_run = sgqlc.types.Field(
"WorkflowAutomationStopWorkflowRunResponse",
graphql_name="workflowAutomationStopWorkflowRun",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"run_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="runId", default=None
),
),
)
),
)
workflow_automation_update_workflow_definition = sgqlc.types.Field(
"WorkflowAutomationUpdateWorkflowDefinitionResponse",
graphql_name="workflowAutomationUpdateWorkflowDefinition",
args=sgqlc.types.ArgDict(
(
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationUpdateWorkflowDefinitionInput
),
graphql_name="definition",
default=None,
),
),
(
"scope",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkflowAutomationScopeInput),
graphql_name="scope",
default=None,
),
),
(
"tags",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(WorkflowAutomationTag)
),
graphql_name="tags",
default=None,
),
),
)
),
)
"""Arguments:
* `definition`
(`WorkflowAutomationUpdateWorkflowDefinitionInput!`): Input for
updating a workflow definition
* `scope` (`WorkflowAutomationScopeInput!`): The scope for the
workflow definition
* `tags` (`[WorkflowAutomationTag!]`): List of tags to associate
with the workflow definition
"""
workload_create = sgqlc.types.Field(
"WorkloadCollection",
graphql_name="workloadCreate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"workload",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkloadCreateInput),
graphql_name="workload",
default=None,
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The New Relic account ID where you want
to create the workload.
* `workload` (`WorkloadCreateInput!`): An input object that
represents the workload to be created.
"""
workload_delete = sgqlc.types.Field(
"WorkloadCollection",
graphql_name="workloadDelete",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The GUID of the workload to delete.
"""
workload_duplicate = sgqlc.types.Field(
"WorkloadCollection",
graphql_name="workloadDuplicate",
args=sgqlc.types.ArgDict(
(
(
"account_id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="accountId",
default=None,
),
),
(
"source_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="sourceGuid",
default=None,
),
),
(
"workload",
sgqlc.types.Arg(
WorkloadDuplicateInput, graphql_name="workload", default=None
),
),
)
),
)
"""Arguments:
* `account_id` (`Int!`): The New Relic Account ID where you want
to create the new workload.
* `source_guid` (`EntityGuid!`): The GUID of the workload you want
to duplicate.
* `workload` (`WorkloadDuplicateInput`): An input object with
information about the new workload.
"""
workload_update = sgqlc.types.Field(
"WorkloadCollection",
graphql_name="workloadUpdate",
args=sgqlc.types.ArgDict(
(
(
"guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="guid",
default=None,
),
),
(
"workload",
sgqlc.types.Arg(
sgqlc.types.non_null(WorkloadUpdateInput),
graphql_name="workload",
default=None,
),
),
)
),
)
"""Arguments:
* `guid` (`EntityGuid!`): The GUID of the workload you want to
update.
* `workload` (`WorkloadUpdateInput!`): An input object with
information to identify the workload to be updated and its new
changes.
"""886. RootQueryType¶
This is the root of all GraphQL queries. The fields in this object are available at the top level of a query.
Available fields:
actor: Theactorfield is the top-level entry into all data that is scoped to the API user’s access level.customerAdministration: ThecustomerAdministrationfield is the place for managing the configuration that defines the business relationships between New Relic, partners, and customers.docs: Access to structured New Relic documentation datarequestContext: TherequestContextfield provides contextual information about the API request itself.
class RootQueryType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("actor", "customer_administration", "docs", "request_context")
actor = sgqlc.types.Field(Actor, graphql_name="actor")
customer_administration = sgqlc.types.Field(
CustomerAdministration, graphql_name="customerAdministration"
)
docs = sgqlc.types.Field(DocumentationFields, graphql_name="docs")
request_context = sgqlc.types.Field(RequestContext, graphql_name="requestContext")887. SecretsManagementCreateSecretResponse¶
An output metadata for a secret
Available fields:
description: The description of the secretid: The unique identifier of the secretkey: The key of the secret that was createdlatestVersion: the version of the secret that was createdmetadata: The metadata associated with the secretnamespace: The namespace of the secretscope: The scope of the secrettags: Tags which are linked to the secret
class SecretsManagementCreateSecretResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"id",
"key",
"latest_version",
"metadata",
"namespace",
"scope",
"tags",
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
metadata = sgqlc.types.Field(
"SecretsManagementSecretMetadataResponse", graphql_name="metadata"
)
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null("SecretsManagementScopeResponse"), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of("SecretsManagementTag"), graphql_name="tags"
)888. SecretsManagementDeleteSecretResponse¶
The output for a delete secret mutation
Available fields:
id: The unique identifier (UUID) of the secretkey: The key of the secret that was deletednamespace: The namespace of the secretscope: The scope of the secret
class SecretsManagementDeleteSecretResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "key", "namespace", "scope")
id = sgqlc.types.Field(ID, graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null("SecretsManagementScopeResponse"), graphql_name="scope"
)889. SecretsManagementDeleteSecretVersionResponse¶
The output for a delete secret version mutation
Available fields:
id: The unique identifier of the secretkey: The key of the secret that had a version deletedlatestVersion: The latest version of the secret after the deletenamespace: The namespace of the secretscope: The scope of the secret
class SecretsManagementDeleteSecretVersionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "key", "latest_version", "namespace", "scope")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null("SecretsManagementScopeResponse"), graphql_name="scope"
)890. SecretsManagementRecoverSecretResponse¶
The output for a recover secret mutation
Available fields:
id: The unique identifier (UUID) of the secretkey: The key of the secret that was recoveredlatestVersion: The latest version of the secret after the recovernamespace: The namespace of the secretscope: The scope of the secret
class SecretsManagementRecoverSecretResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "key", "latest_version", "namespace", "scope")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null("SecretsManagementScopeResponse"), graphql_name="scope"
)891. SecretsManagementRecoverSecretVersionResponse¶
The output for a recover secret version mutation
Available fields:
id: The unique identifier of the secretkey: The key of the secret that had a version recoveredlatestVersion: The latest version of the secret after the recoverynamespace: The namespace of the secretscope: The scope of the secret
class SecretsManagementRecoverSecretVersionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "key", "latest_version", "namespace", "scope")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null("SecretsManagementScopeResponse"), graphql_name="scope"
)892. SecretsManagementRetrievedValue¶
An entry for a retrieved value of a secret
Available fields:
value: The value of the secretversion: The version of the secret
class SecretsManagementRetrievedValue(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("value", "version")
value = sgqlc.types.Field(SecureValue, graphql_name="value")
version = sgqlc.types.Field(Int, graphql_name="version")893. SecretsManagementScopeResponse¶
The scope of the secret
Available fields:
id: The ID of the scopetype: The type of scope
class SecretsManagementScopeResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(SecretsManagementScopeType), graphql_name="type"
)894. SecretsManagementSecretMetadataResponse¶
An output for a secret metadata
Available fields:
createdAt: The time the secret was createdupdatedAt: The time the secret was last updated
class SecretsManagementSecretMetadataResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "updated_at")
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")895. SecretsManagementSecretQueryResponse¶
An output for a secret query
Available fields:
description: The description of the secretid: The unique identifier (UUID) of the secretisShareable: Indicates whether the secret is shareablekey: The key of the secretmetadata: The metadata associated with the secretnamespace: The namespace of the secretretrievedValue: The retrieved value and version of the secretscope: The scope of the secrettags: The list of tags associated with the secret
class SecretsManagementSecretQueryResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"id",
"is_shareable",
"key",
"metadata",
"namespace",
"retrieved_value",
"scope",
"tags",
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
is_shareable = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isShareable"
)
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
metadata = sgqlc.types.Field(
SecretsManagementSecretMetadataResponse, graphql_name="metadata"
)
namespace = sgqlc.types.Field(String, graphql_name="namespace")
retrieved_value = sgqlc.types.Field(
SecretsManagementRetrievedValue, graphql_name="retrievedValue"
)
scope = sgqlc.types.Field(
sgqlc.types.non_null(SecretsManagementScopeResponse), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of("SecretsManagementTag"), graphql_name="tags"
)896. SecretsManagementSecretVersionResponse¶
The details of the secret versions
Available fields:
createdAt: The time the secret version was createdisDeleted: Tells if the secret version is soft deletedversion: The secret version
class SecretsManagementSecretVersionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "is_deleted", "version")
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
is_deleted = sgqlc.types.Field(Boolean, graphql_name="isDeleted")
version = sgqlc.types.Field(Int, graphql_name="version")897. SecretsManagementSecretVersionsQueryResponse¶
An output for a secret versions query
Available fields:
id: The unique identifier of the secretkey: The key of the secretlatestVersion: The latest secret versionnamespace: The namespace of the secretscope: The scope of the secretsecretVersions: The details of secret versions
class SecretsManagementSecretVersionsQueryResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"id",
"key",
"latest_version",
"namespace",
"scope",
"secret_versions",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null(SecretsManagementScopeResponse), graphql_name="scope"
)
secret_versions = sgqlc.types.Field(
sgqlc.types.list_of(SecretsManagementSecretVersionResponse),
graphql_name="secretVersions",
)898. SecretsManagementSecretsCollectionItem¶
The output item in secrets collection query
Available fields:
description: The description of the secretid: The unique identifier (UUID) of the secretisDeleted: Indicates whether the secret has been marked as deletedisShareable: Indicates whether the secret is shareablekey: The key of the secretlatestVersion: The latest version of the secretmetadata: The metadata associated with the secretnamespace: The namespace of the secrettags: The list of tags associated with the secret
class SecretsManagementSecretsCollectionItem(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"id",
"is_deleted",
"is_shareable",
"key",
"latest_version",
"metadata",
"namespace",
"tags",
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
is_deleted = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isDeleted"
)
is_shareable = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isShareable"
)
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
metadata = sgqlc.types.Field(
SecretsManagementSecretMetadataResponse, graphql_name="metadata"
)
namespace = sgqlc.types.Field(String, graphql_name="namespace")
tags = sgqlc.types.Field(
sgqlc.types.list_of("SecretsManagementTag"), graphql_name="tags"
)899. SecretsManagementSecretsCollectionQueryResponse¶
The output for secrets collection query
Available fields:
nextCursor: The cursor to get the next set of secretsscope: The scope of the secretsecrets: The list of secretstotalCount: The total number of secrets
class SecretsManagementSecretsCollectionQueryResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "scope", "secrets", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
scope = sgqlc.types.Field(
sgqlc.types.non_null(SecretsManagementScopeResponse), graphql_name="scope"
)
secrets = sgqlc.types.Field(
sgqlc.types.list_of(SecretsManagementSecretsCollectionItem),
graphql_name="secrets",
)
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")900. SecretsManagementTag¶
An output tag of key value pair, used in response of create secret and to retrieve secret metadata
Available fields:
key: The key of the tagvalue: The value of the tag
class SecretsManagementTag(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")901. SecretsManagementUpdateSecretResponse¶
An output for a secret updated mutation
Available fields:
description: The description of the secretid: The unique identifier (UUID) of the secretkey: The key of the secret that was updatedlatestVersion: The version of the secret that was updatedmetadata: The metadata associated with the secretnamespace: The namespace of the secretscope: The scope of the secrettags: The list of tags associated with the secret
class SecretsManagementUpdateSecretResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"description",
"id",
"key",
"latest_version",
"metadata",
"namespace",
"scope",
"tags",
)
description = sgqlc.types.Field(String, graphql_name="description")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
latest_version = sgqlc.types.Field(Int, graphql_name="latestVersion")
metadata = sgqlc.types.Field(
SecretsManagementSecretMetadataResponse, graphql_name="metadata"
)
namespace = sgqlc.types.Field(String, graphql_name="namespace")
scope = sgqlc.types.Field(
sgqlc.types.non_null(SecretsManagementScopeResponse), graphql_name="scope"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(SecretsManagementTag), graphql_name="tags"
)902. SecureCredentialSummaryData¶
Summary statistics for the Synthetic Monitor Secure Credential.
Available fields:
class SecureCredentialSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()903. ServiceLevelDefinition¶
The service level defined for a specific entity.
Available fields:
indicators: The SLIs attached to the entity.
class ServiceLevelDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("indicators",)
indicators = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("ServiceLevelIndicator")),
graphql_name="indicators",
)904. ServiceLevelEvents¶
The events that define the SLI.
Available fields:
account: The New Relic account to fetch the events from.badEvents: The definition of bad events.goodEvents: The definition of good events.validEvents: The definition of valid events.
class ServiceLevelEvents(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account", "bad_events", "good_events", "valid_events")
account = sgqlc.types.Field(AccountReference, graphql_name="account")
bad_events = sgqlc.types.Field("ServiceLevelEventsQuery", graphql_name="badEvents")
good_events = sgqlc.types.Field(
"ServiceLevelEventsQuery", graphql_name="goodEvents"
)
valid_events = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelEventsQuery"), graphql_name="validEvents"
)905. ServiceLevelEventsQuery¶
The query that represents the events to fetch.
Available fields:
from: The NRDB event to fetch the data from.select: The NRQL SELECT clause to aggregate events.where: The NRQL condition to filter the events.
class ServiceLevelEventsQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("from_", "select", "where")
from_ = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="from")
select = sgqlc.types.Field("ServiceLevelEventsQuerySelect", graphql_name="select")
where = sgqlc.types.Field(Nrql, graphql_name="where")906. ServiceLevelEventsQuerySelect¶
The resulting NRQL SELECT clause to aggregate events.
Available fields:
attribute: The attribute used in the selected function.function: The function to use in the SELECT clause.threshold: The threshold used in the selected function.
class ServiceLevelEventsQuerySelect(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attribute", "function", "threshold")
attribute = sgqlc.types.Field(String, graphql_name="attribute")
function = sgqlc.types.Field(
sgqlc.types.non_null(ServiceLevelEventsQuerySelectFunction),
graphql_name="function",
)
threshold = sgqlc.types.Field(Float, graphql_name="threshold")907. ServiceLevelIndicator¶
The definition of the SLI.
Available fields:
createdAt: The date when the SLI was created represented in the number of milliseconds since the Unix epoch.createdBy: The user who created the SLI.description: The description of the SLI.entityGuid: The entity which the SLI is attached to.events: The events that define the SLI.guid: The unique entity identifier of the SLI.id: The unique identifier of the SLI.name: The name of the SLI.objectives: A list of objective definitions.resultQueries: The resulting NRQL queries that help consume the metrics of the SLI.updatedAt: The date when the SLI was last updated represented in the number of milliseconds since the Unix epoch.updatedBy: The user who last update the SLI.
class ServiceLevelIndicator(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"created_by",
"description",
"entity_guid",
"events",
"guid",
"id",
"name",
"objectives",
"result_queries",
"updated_at",
"updated_by",
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
created_by = sgqlc.types.Field("UserReference", graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
entity_guid = sgqlc.types.Field(
sgqlc.types.non_null(EntityGuid), graphql_name="entityGuid"
)
events = sgqlc.types.Field(
sgqlc.types.non_null(ServiceLevelEvents), graphql_name="events"
)
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
objectives = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("ServiceLevelObjective")),
graphql_name="objectives",
)
result_queries = sgqlc.types.Field(
"ServiceLevelIndicatorResultQueries", graphql_name="resultQueries"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field("UserReference", graphql_name="updatedBy")908. ServiceLevelIndicatorResultQueries¶
The resulting NRQL queries that help consume the metrics of the SLI.
Available fields:
goodEvents: The NRQL query that measures the good events.indicator: The NRQL query that measures the value of the SLI.validEvents: The NRQL query that measures the valid events.
class ServiceLevelIndicatorResultQueries(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("good_events", "indicator", "valid_events")
good_events = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelResultQuery"), graphql_name="goodEvents"
)
indicator = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelResultQuery"), graphql_name="indicator"
)
valid_events = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelResultQuery"), graphql_name="validEvents"
)909. ServiceLevelObjective¶
An objective definition.
Available fields:
description: The description of the SLO.name: The name of the SLO.resultQueries: The resulting NRQL queries that help consume the metrics of the SLO.target: The target percentage of the SLO.timeWindow: The time window configuration of the SLO.
class ServiceLevelObjective(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "name", "result_queries", "target", "time_window")
description = sgqlc.types.Field(String, graphql_name="description")
name = sgqlc.types.Field(String, graphql_name="name")
result_queries = sgqlc.types.Field(
"ServiceLevelObjectiveResultQueries", graphql_name="resultQueries"
)
target = sgqlc.types.Field(sgqlc.types.non_null(Float), graphql_name="target")
time_window = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelObjectiveTimeWindow"),
graphql_name="timeWindow",
)910. ServiceLevelObjectiveResultQueries¶
The resulting NRQL queries that help consume the metrics of the SLO.
Available fields:
attainment: The NRQL query that measures the attainment of the SLO target.
class ServiceLevelObjectiveResultQueries(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("attainment",)
attainment = sgqlc.types.Field(
sgqlc.types.non_null("ServiceLevelResultQuery"), graphql_name="attainment"
)911. ServiceLevelObjectiveRollingTimeWindow¶
The rolling time window configuration of the SLO.
Available fields:
count: The count of time units.unit: The time unit.
class ServiceLevelObjectiveRollingTimeWindow(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("count", "unit")
count = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="count")
unit = sgqlc.types.Field(
sgqlc.types.non_null(ServiceLevelObjectiveRollingTimeWindowUnit),
graphql_name="unit",
)912. ServiceLevelObjectiveTimeWindow¶
The time window configuration of the SLO.
Available fields:
rolling: The rolling time window configuration of the SLO.
class ServiceLevelObjectiveTimeWindow(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("rolling",)
rolling = sgqlc.types.Field(
ServiceLevelObjectiveRollingTimeWindow, graphql_name="rolling"
)913. ServiceLevelResultQuery¶
A resulting query.
Available fields:
nrql: A NRQL query.
class ServiceLevelResultQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("nrql",)
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")914. SessionsClient¶
Represents a client application that creates a session.
Available fields:
clientType: The type of client application.id: Unique identifier for the client.name: Name of the client application.
class SessionsClient(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("client_type", "id", "name")
client_type = sgqlc.types.Field(
sgqlc.types.non_null(SessionsClientType), graphql_name="clientType"
)
id = sgqlc.types.Field(ID, graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")915. SessionsPrincipal¶
Represents an authenticated entity, such as a user.
Available fields:
id: Unique identifier for the principal.type: The type of principal, such as a user.
class SessionsPrincipal(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(SessionsPrincipalType), graphql_name="type"
)916. SessionsRevokeSessionResponse¶
Sessions revoke response.
Available fields:
ids: The ids of sessions that were successfully revoked.
class SessionsRevokeSessionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("ids",)
ids = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)), graphql_name="ids"
)917. SessionsSessionCollection¶
A collection of sessions, including pagination information.
Available fields:
items: The list of sessions in the current page.nextCursor: The cursor for the next page of results.totalCount: The total count of sessions matching the query.
class SessionsSessionCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of("SessionsSessionResponse"), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")918. SessionsSessionResponse¶
Represents a user session.
Available fields:
client: The client that created the session.createdAt: The date and time when the session was created.expiresAt: The expiration date and time of the session.principal: The principal associated with the session, such as a user.sessionId: Unique identifier for the session.
class SessionsSessionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("client", "created_at", "expires_at", "principal", "session_id")
client = sgqlc.types.Field(
sgqlc.types.non_null(SessionsClient), graphql_name="client"
)
created_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="createdAt"
)
expires_at = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="expiresAt"
)
principal = sgqlc.types.Field(
sgqlc.types.non_null(SessionsPrincipal), graphql_name="principal"
)
session_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="sessionId")919. StackTraceApmException¶
A structured representation of an exception for an APM application.
Available fields:
message: The top level message associated with the exception.stackTrace: The stack trace associated with the exception.
class StackTraceApmException(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "stack_trace")
message = sgqlc.types.Field(String, graphql_name="message")
stack_trace = sgqlc.types.Field(
"StackTraceApmStackTrace", graphql_name="stackTrace"
)920. StackTraceApmStackTrace¶
A structured representation of a stack trace for an APM application.
Available fields:
frames: Stack trace frames.
class StackTraceApmStackTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("frames",)
frames = sgqlc.types.Field(
sgqlc.types.list_of("StackTraceApmStackTraceFrame"), graphql_name="frames"
)921. StackTraceBrowserException¶
A structured representation of an exception for a Browser application.
Available fields:
message: The top level message associated to the stack trace.stackTrace: The stack trace associated with the exception.
class StackTraceBrowserException(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "stack_trace")
message = sgqlc.types.Field(String, graphql_name="message")
stack_trace = sgqlc.types.Field(
"StackTraceBrowserStackTrace", graphql_name="stackTrace"
)922. StackTraceBrowserStackTrace¶
A structured representation of a stack trace for a Browser application.
Available fields:
frames: Stack trace frames.
class StackTraceBrowserStackTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("frames",)
frames = sgqlc.types.Field(
sgqlc.types.list_of("StackTraceBrowserStackTraceFrame"), graphql_name="frames"
)923. StackTraceBrowserStackTraceFrame¶
An object representing a stack trace segment
Available fields:
column: Frame column numberformatted: Formatted frameline: Frame line numbername: Frame name
class StackTraceBrowserStackTraceFrame(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("column", "formatted", "line", "name")
column = sgqlc.types.Field(Int, graphql_name="column")
formatted = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="formatted"
)
line = sgqlc.types.Field(Int, graphql_name="line")
name = sgqlc.types.Field(String, graphql_name="name")924. StackTraceMobileCrash¶
A structured representation of a crash occurring in a mobile application.
Available fields:
stackTrace: A structured representation of a stack trace for a crash that occurs on a mobile application.
class StackTraceMobileCrash(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("stack_trace",)
stack_trace = sgqlc.types.Field(
"StackTraceMobileCrashStackTrace", graphql_name="stackTrace"
)925. StackTraceMobileCrashStackTrace¶
A structured representation of a stack trace of a crash in a mobile application.
Available fields:
frames: Stack trace frames.
class StackTraceMobileCrashStackTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("frames",)
frames = sgqlc.types.Field(
sgqlc.types.list_of("StackTraceMobileCrashStackTraceFrame"),
graphql_name="frames",
)926. StackTraceMobileException¶
A structured representation of a handled exception occurring in a mobile application.
Available fields:
stackTrace: A structured representation of a handled exception in a mobile application.
class StackTraceMobileException(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("stack_trace",)
stack_trace = sgqlc.types.Field(
"StackTraceMobileExceptionStackTrace", graphql_name="stackTrace"
)927. StackTraceMobileExceptionStackTrace¶
A structured representation of a handled exception in a mobile application.
Available fields:
frames: Stack trace frames.
class StackTraceMobileExceptionStackTrace(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("frames",)
frames = sgqlc.types.Field(
sgqlc.types.list_of("StackTraceMobileExceptionStackTraceFrame"),
graphql_name="frames",
)928. StreamingExportAccountStitchedFields¶
Available fields:
streamingRule: Get the information for a specific streaming rulestreamingRules: List the streaming rules for the given account
class StreamingExportAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("streaming_rule", "streaming_rules")
streaming_rule = sgqlc.types.Field(
"StreamingExportRule",
graphql_name="streamingRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
streaming_rules = sgqlc.types.Field(
sgqlc.types.list_of("StreamingExportRule"), graphql_name="streamingRules"
)929. StreamingExportAwsDetails¶
AWS details about a streaming rule
Available fields:
awsAccountId: The AWS account to which the target firehose belongsdeliveryStreamName: The name of the delivery stream to write events toregion: The AWS region the delivery stream is located inrole: The role configured for New Relic to assume
class StreamingExportAwsDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("aws_account_id", "delivery_stream_name", "region", "role")
aws_account_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="awsAccountId"
)
delivery_stream_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="deliveryStreamName"
)
region = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="region")
role = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="role")930. StreamingExportAzureDetails¶
Azure details about a streaming rule
Available fields:
eventHubConnectionString: Connection string that has access to the specific Event HubeventHubName: The name of Event Hub to write events to
class StreamingExportAzureDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("event_hub_connection_string", "event_hub_name")
event_hub_connection_string = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="eventHubConnectionString"
)
event_hub_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="eventHubName"
)931. StreamingExportGcpDetails¶
GCP details parameters for a new streaming rule
Available fields:
gcpProjectId: gcp project idpubsubTopicId: pub sub topic id
class StreamingExportGcpDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("gcp_project_id", "pubsub_topic_id")
gcp_project_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="gcpProjectId"
)
pubsub_topic_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="pubsubTopicId"
)932. StreamingExportRule¶
Details about a streaming rule
Available fields:
account: The account associated to this streaming ruleaws: The AWS information configured for the streaming ruleazure: The Azure information configured for the streaming rulecreatedAt: The time at which the process of creating the streaming rule begandescription: Additional information about the streaming rulegcp: The GCP information configured for the streaming ruleid: The rule ID for this streaming rulemessage: A message returned by the latest API callname: The name of this streaming rulenrql: NRQL used to select data to be exportedpayloadCompression: Whether or not to compress payloads before exporting them, and what compression format to use if sostatus: The state of this streaming ruleupdatedAt: The last time the status of the streaming rule was updated
class StreamingExportRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"aws",
"azure",
"created_at",
"description",
"gcp",
"id",
"message",
"name",
"nrql",
"payload_compression",
"status",
"updated_at",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
aws = sgqlc.types.Field(StreamingExportAwsDetails, graphql_name="aws")
azure = sgqlc.types.Field(StreamingExportAzureDetails, graphql_name="azure")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
description = sgqlc.types.Field(String, graphql_name="description")
gcp = sgqlc.types.Field(StreamingExportGcpDetails, graphql_name="gcp")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
message = sgqlc.types.Field(String, graphql_name="message")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
nrql = sgqlc.types.Field(Nrql, graphql_name="nrql")
payload_compression = sgqlc.types.Field(
StreamingExportPayloadCompression, graphql_name="payloadCompression"
)
status = sgqlc.types.Field(
sgqlc.types.non_null(StreamingExportStatus), graphql_name="status"
)
updated_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="updatedAt"
)933. SuggestedNrqlQueryAnomaly¶
Information about the anomaly upon which this analysis was based.
Available fields:
timeWindow: The approximate time window of the anomalous region
class SuggestedNrqlQueryAnomaly(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("time_window",)
time_window = sgqlc.types.Field(
sgqlc.types.non_null("TimeWindow"), graphql_name="timeWindow"
)934. SuggestedNrqlQueryResponse¶
A result type encapsulating suggested queries
Available fields:
suggestions: List of suggested queries.
class SuggestedNrqlQueryResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("suggestions",)
suggestions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(SuggestedNrqlQuery)),
graphql_name="suggestions",
)935. SyntheticMonitorSummaryData¶
Summary statistics for the Synthetic Monitor.
Available fields:
locationsFailing: The number of locations that are currently failing.locationsRunning: The number of locations that are currently running.statussuccessRate: The percentage of successful synthetic monitor checks in the last 24 hours.
class SyntheticMonitorSummaryData(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"locations_failing",
"locations_running",
"status",
"success_rate",
)
locations_failing = sgqlc.types.Field(Int, graphql_name="locationsFailing")
locations_running = sgqlc.types.Field(Int, graphql_name="locationsRunning")
status = sgqlc.types.Field(SyntheticMonitorStatus, graphql_name="status")
success_rate = sgqlc.types.Field(Float, graphql_name="successRate")936. SyntheticsAccountStitchedFields¶
Nerdgraph account field
Available fields:
script: Query that fetches the script of a specific scripted monitorsteps: visiblity(flag:Synthetics/setGraphqlCustomerVisible) Query that fetches the steps used by the specified Step Monitor
class SyntheticsAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("script", "steps")
script = sgqlc.types.Field(
"SyntheticsMonitorScriptQueryResponse",
graphql_name="script",
args=sgqlc.types.ArgDict(
(
(
"monitor_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="monitorGuid",
default=None,
),
),
)
),
)
steps = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("SyntheticsStep")),
graphql_name="steps",
args=sgqlc.types.ArgDict(
(
(
"monitor_guid",
sgqlc.types.Arg(
sgqlc.types.non_null(EntityGuid),
graphql_name="monitorGuid",
default=None,
),
),
)
),
)
"""Arguments:
* `monitor_guid` (`EntityGuid!`): Unique identifier for monitor
that holds the script steps that are to be fetched
"""937. SyntheticsBrokenLinksMonitor¶
A Broken Links monitor resulting from a Broken Links monitor mutation
Available fields:
createdAt: The creation time of the monitor in millisguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitoruri: The uri the monitor runs against
class SyntheticsBrokenLinksMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"runtime",
"status",
"uri",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field("SyntheticsLocations", graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(
"SyntheticsExtendedTypeMonitorRuntime", graphql_name="runtime"
)
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")
uri = sgqlc.types.Field(String, graphql_name="uri")938. SyntheticsBrokenLinksMonitorCreateMutationResult¶
The result of a Broken Links monitor create mutation
Available fields:
errors: Errors that occurred during Broken Links monitor create mutationmonitor: The resulting Broken Links monitor
class SyntheticsBrokenLinksMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("SyntheticsMonitorCreateError")),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsBrokenLinksMonitor, graphql_name="monitor")939. SyntheticsBrokenLinksMonitorUpdateMutationResult¶
The result of a Broken Links monitor update mutation
Available fields:
errors: Errors that occurred during Broken Links monitor update mutationmonitor: The resulting Broken Links monitor
class SyntheticsBrokenLinksMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("SyntheticsMonitorUpdateError")),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsBrokenLinksMonitor, graphql_name="monitor")940. SyntheticsCertCheckMonitor¶
A Cert Check monitor resulting from a Cert Check monitor mutation
Available fields:
createdAt: The creation time of the monitor in millisdomain: The domain of the host that will have its certificate checkedguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitornumberDaysToFailBeforeCertExpires: The desired number of remaining days until the certificate expires to trigger a monitor failureperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitor
class SyntheticsCertCheckMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"domain",
"guid",
"id",
"locations",
"modified_at",
"name",
"number_days_to_fail_before_cert_expires",
"period",
"runtime",
"status",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
domain = sgqlc.types.Field(String, graphql_name="domain")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field("SyntheticsLocations", graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
number_days_to_fail_before_cert_expires = sgqlc.types.Field(
Int, graphql_name="numberDaysToFailBeforeCertExpires"
)
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(
"SyntheticsExtendedTypeMonitorRuntime", graphql_name="runtime"
)
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")941. SyntheticsCertCheckMonitorCreateMutationResult¶
The result of a Cert Check monitor create mutation
Available fields:
errors: Errors that occurred during Cert Check monitor create mutationmonitor: The resulting Cert Check monitor
class SyntheticsCertCheckMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("SyntheticsMonitorCreateError")),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsCertCheckMonitor, graphql_name="monitor")942. SyntheticsCertCheckMonitorUpdateMutationResult¶
The result of a Cert Check monitor update mutation
Available fields:
errors: Errors that occurred during Cert Check monitor update mutationmonitor: The resulting Cert Check monitor
class SyntheticsCertCheckMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of("SyntheticsMonitorUpdateError")),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsCertCheckMonitor, graphql_name="monitor")943. SyntheticsCustomHeader¶
Custom header for monitor jobs
Available fields:
name: Header namevalue: Header value
class SyntheticsCustomHeader(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "value")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
value = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="value")944. SyntheticsDailyMonitorDowntimeMutationResult¶
Monitor downtime object returned to the customer for a downtime run daily
Available fields:
accountId: The account ID associated with the monitor downtimeendRepeat: Configuration options if the customer wants the monitor to end at a specific dateendTime: The date and time in which the monitor downtime will endguid: The entity GUID associated with the monitor downtimemonitorGuids: The monitor GUIDs associated with the monitor downtimename: The name of the monitor downtimestartTime: The date and time in which the monitor downtime will begintimezone: The timezone the time values will be in
class SyntheticsDailyMonitorDowntimeMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"end_repeat",
"end_time",
"guid",
"monitor_guids",
"name",
"start_time",
"timezone",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
end_repeat = sgqlc.types.Field(
"SyntheticsDateWindowEndOutput", graphql_name="endRepeat"
)
end_time = sgqlc.types.Field(NaiveDateTime, graphql_name="endTime")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
monitor_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="monitorGuids"
)
name = sgqlc.types.Field(String, graphql_name="name")
start_time = sgqlc.types.Field(NaiveDateTime, graphql_name="startTime")
timezone = sgqlc.types.Field(String, graphql_name="timezone")945. SyntheticsDateWindowEndOutput¶
Configuration options for when a monitor downtime should end
Available fields:
onDate: End the monitor downtime on a particular dateonRepeat: End the monitor downtime after a set number of occurrences
class SyntheticsDateWindowEndOutput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("on_date", "on_repeat")
on_date = sgqlc.types.Field(Date, graphql_name="onDate")
on_repeat = sgqlc.types.Field(Int, graphql_name="onRepeat")946. SyntheticsDaysOfWeekOutput¶
Configuration options for a monthly monitor downtime that runs on days of the week
Available fields:
ordinalDayOfMonth: Which occurrence of the day selected within the monthweekDay: Which day of the week the monitor downtime runs
class SyntheticsDaysOfWeekOutput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("ordinal_day_of_month", "week_day")
ordinal_day_of_month = sgqlc.types.Field(
SyntheticsMonitorDowntimeDayOfMonthOrdinal, graphql_name="ordinalDayOfMonth"
)
week_day = sgqlc.types.Field(
SyntheticsMonitorDowntimeWeekDays, graphql_name="weekDay"
)947. SyntheticsDeviceEmulation¶
Information related to device emulation - will be deprecated soon
Available fields:
deviceOrientation: The device orientation the user would like to representdeviceType: The device type that a user can select
class SyntheticsDeviceEmulation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("device_orientation", "device_type")
device_orientation = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsDeviceOrientation),
graphql_name="deviceOrientation",
)
device_type = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsDeviceType), graphql_name="deviceType"
)948. SyntheticsError¶
Error object for Synthetics mutations
Available fields:
description: Description explaining the cause of the error
class SyntheticsError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(String, graphql_name="description")949. SyntheticsExtendedTypeMonitorRuntime¶
The runtime that a step monitor runs
Available fields:
runtimeType: The runtime type that the monitor will runruntimeTypeVersion: The specific version of the runtime type selected
class SyntheticsExtendedTypeMonitorRuntime(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("runtime_type", "runtime_type_version")
runtime_type = sgqlc.types.Field(String, graphql_name="runtimeType")
runtime_type_version = sgqlc.types.Field(SemVer, graphql_name="runtimeTypeVersion")950. SyntheticsLocations¶
The location(s) from which the monitor runs
Available fields:
private: Existing private location(s) in which the monitor will runpublic: Publicly available location(s) in which the monitor will run. For formatting tips, see this link
class SyntheticsLocations(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("private", "public")
private = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="private")
public = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="public")951. SyntheticsMonitorCreateError¶
Error object for Synthetics monitor creation request
Available fields:
description: String description of errortype: Enum of error that was returned during monitor creation
class SyntheticsMonitorCreateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsMonitorCreateErrorType), graphql_name="type"
)952. SyntheticsMonitorDeleteMutationResult¶
The result of a monitor delete mutation
Available fields:
deletedGuid: The unique identifier of the deleted monitor
class SyntheticsMonitorDeleteMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deleted_guid",)
deleted_guid = sgqlc.types.Field(EntityGuid, graphql_name="deletedGuid")953. SyntheticsMonitorDowntimeDeleteResult¶
Monitor downtime object returned to the customer once a monitor downtime is deleted
Available fields:
guid: The entity guid of the deleted MonitorDowntime
class SyntheticsMonitorDowntimeDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid",)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")954. SyntheticsMonitorDowntimeMonthlyFrequencyOutput¶
Configuration options for when a monthly monitor downtime should run
Available fields:
daysOfMonth: Which dates a monitor downtime is run (only 1 of these can be selected)daysOfWeek: Which weekdays in the month the monitor downtime will run (only 1 of these can be selected)
class SyntheticsMonitorDowntimeMonthlyFrequencyOutput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("days_of_month", "days_of_week")
days_of_month = sgqlc.types.Field(
sgqlc.types.list_of(Int), graphql_name="daysOfMonth"
)
days_of_week = sgqlc.types.Field(
SyntheticsDaysOfWeekOutput, graphql_name="daysOfWeek"
)955. SyntheticsMonitorDowntimeMutationResult¶
Monitor downtime object returned to the customer for an edit mutation
Available fields:
accountId: The account ID associated with the monitor downtimeendRepeat: Configuration options if the customer wants the monitor to end at a specific dateendTime: The date and time in which the monitor downtime will endfrequency: Configuration options for which days of the month a monitor downtime will occurguid: The entity GUID associated with the monitor downtimemaintenanceDays: Days of the week the monitor downtime will runmonitorGuids: The monitor GUIDs associated with the monitor downtimename: The name of the monitor downtimestartTime: The date and time in which the monitor downtime will begintimezone: The timezone the time values will be in
class SyntheticsMonitorDowntimeMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"end_repeat",
"end_time",
"frequency",
"guid",
"maintenance_days",
"monitor_guids",
"name",
"start_time",
"timezone",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
end_repeat = sgqlc.types.Field(
SyntheticsDateWindowEndOutput, graphql_name="endRepeat"
)
end_time = sgqlc.types.Field(NaiveDateTime, graphql_name="endTime")
frequency = sgqlc.types.Field(
SyntheticsMonitorDowntimeMonthlyFrequencyOutput, graphql_name="frequency"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
maintenance_days = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsMonitorDowntimeWeekDays),
graphql_name="maintenanceDays",
)
monitor_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="monitorGuids"
)
name = sgqlc.types.Field(String, graphql_name="name")
start_time = sgqlc.types.Field(NaiveDateTime, graphql_name="startTime")
timezone = sgqlc.types.Field(String, graphql_name="timezone")956. SyntheticsMonitorScriptQueryResponse¶
The script that a monitor runs
Available fields:
text: The script associated with the specified monitor
class SyntheticsMonitorScriptQueryResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("text",)
text = sgqlc.types.Field(String, graphql_name="text")957. SyntheticsMonitorUpdateError¶
Error object for Synthetics monitor update request
Available fields:
description: String description of errortype: Enum of error that was returned during monitor update
class SyntheticsMonitorUpdateError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsMonitorUpdateErrorType), graphql_name="type"
)958. SyntheticsMonthlyMonitorDowntimeMutationResult¶
Monitor downtime object returned to the customer for a downtime run monthly
Available fields:
accountId: The account ID associated with the monitor downtimeendRepeat: Configuration options if the customer wants the monitor to end at a specific dateendTime: The date and time in which the monitor downtime will endfrequency: Configuration options for which days of the month a monitor downtime will occurguid: The entity GUID associated with the monitor downtimemonitorGuids: The monitor GUIDs associated with the monitor downtimename: The name of the monitor downtimestartTime: The date and time in which the monitor downtime will begintimezone: The timezone the time values will be in
class SyntheticsMonthlyMonitorDowntimeMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"end_repeat",
"end_time",
"frequency",
"guid",
"monitor_guids",
"name",
"start_time",
"timezone",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
end_repeat = sgqlc.types.Field(
SyntheticsDateWindowEndOutput, graphql_name="endRepeat"
)
end_time = sgqlc.types.Field(NaiveDateTime, graphql_name="endTime")
frequency = sgqlc.types.Field(
SyntheticsMonitorDowntimeMonthlyFrequencyOutput, graphql_name="frequency"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
monitor_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="monitorGuids"
)
name = sgqlc.types.Field(String, graphql_name="name")
start_time = sgqlc.types.Field(NaiveDateTime, graphql_name="startTime")
timezone = sgqlc.types.Field(String, graphql_name="timezone")959. SyntheticsOnceMonitorDowntimeMutationResult¶
Monitor downtime object returned to the customer for a downtime run once
Available fields:
accountId: The account ID associated with the monitor downtimeendTime: The date and time in which the monitor downtime will endguid: The entity GUID associated with the monitor downtimemonitorGuids: The monitor GUIDs associated with the monitor downtimename: The name of the monitor downtimestartTime: The date and time in which the monitor downtime will begintimezone: The timezone the time values will be in
class SyntheticsOnceMonitorDowntimeMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"end_time",
"guid",
"monitor_guids",
"name",
"start_time",
"timezone",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
end_time = sgqlc.types.Field(NaiveDateTime, graphql_name="endTime")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
monitor_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="monitorGuids"
)
name = sgqlc.types.Field(String, graphql_name="name")
start_time = sgqlc.types.Field(NaiveDateTime, graphql_name="startTime")
timezone = sgqlc.types.Field(String, graphql_name="timezone")960. SyntheticsPrivateLocationDeleteResult¶
An array containing errors from the deletion of a private location, if any
Available fields:
errors: An array container errors resulting from the mutation, if any
class SyntheticsPrivateLocationDeleteResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of("SyntheticsPrivateLocationMutationError"),
graphql_name="errors",
)961. SyntheticsPrivateLocationMutationError¶
Error object for Synthetic Private Location mutation request
Available fields:
description: String description of errortype: Enum type of error response
class SyntheticsPrivateLocationMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "type")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsPrivateLocationMutationErrorType),
graphql_name="type",
)962. SyntheticsPrivateLocationMutationResult¶
Result of a private location mutation
Available fields:
accountId: The account associated to the private locationdescription: A description of the private locationdomainId: The private location globally unique identifiererrors: An array container errors resulting from the mutation, if anyguid: The unique client identifier for the Synthetics private location in New Relickey: The private locations keylocationId: An alternate identifier based on namename: The name of the private locationshared: Specifies whether the private location is shared across the organizationverifiedScriptExecution: Specifies whether the private location requires a password for scripted monitors
class SyntheticsPrivateLocationMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"description",
"domain_id",
"errors",
"guid",
"key",
"location_id",
"name",
"shared",
"verified_script_execution",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
description = sgqlc.types.Field(String, graphql_name="description")
domain_id = sgqlc.types.Field(String, graphql_name="domainId")
errors = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsPrivateLocationMutationError),
graphql_name="errors",
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
key = sgqlc.types.Field(String, graphql_name="key")
location_id = sgqlc.types.Field(String, graphql_name="locationId")
name = sgqlc.types.Field(String, graphql_name="name")
shared = sgqlc.types.Field(Boolean, graphql_name="shared")
verified_script_execution = sgqlc.types.Field(
Boolean, graphql_name="verifiedScriptExecution"
)963. SyntheticsPrivateLocationPurgeQueueResult¶
Result of a Synthetics purge private location queue mutation
Available fields:
errors: An array containing errors resulting from the mutation, if any
class SyntheticsPrivateLocationPurgeQueueResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsPrivateLocationMutationError),
graphql_name="errors",
)964. SyntheticsRuntime¶
The runtime that a monitor runs
Available fields:
runtimeType: The runtime type that the monitor will runruntimeTypeVersion: The specific version of the runtime type selectedscriptLanguage: The programing language that should execute the script
class SyntheticsRuntime(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("runtime_type", "runtime_type_version", "script_language")
runtime_type = sgqlc.types.Field(String, graphql_name="runtimeType")
runtime_type_version = sgqlc.types.Field(
sgqlc.types.non_null(SemVer), graphql_name="runtimeTypeVersion"
)
script_language = sgqlc.types.Field(String, graphql_name="scriptLanguage")965. SyntheticsScriptApiMonitor¶
A Script Api monitor resulting from a Script Api mutation
Available fields:
createdAt: The creation time of the monitor in millisguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitor
class SyntheticsScriptApiMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"runtime",
"status",
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field(SyntheticsLocations, graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(SyntheticsRuntime, graphql_name="runtime")
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")966. SyntheticsScriptApiMonitorCreateMutationResult¶
The result of a Script Api monitor create mutation
Available fields:
errors: Errors that occurred during Script Api monitor create mutationmonitor: The resulting Script Api monitor
class SyntheticsScriptApiMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorCreateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsScriptApiMonitor, graphql_name="monitor")967. SyntheticsScriptApiMonitorUpdateMutationResult¶
The result of a Script Api monitor update mutation
Available fields:
errors: Errors that occurred during Script Api monitor update mutationmonitor: The resulting Script Api monitor
class SyntheticsScriptApiMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorUpdateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsScriptApiMonitor, graphql_name="monitor")968. SyntheticsScriptBrowserMonitor¶
A Script Browser monitor resulting from a Script Browser mutation
Available fields:
advancedOptions: The monitor advanced optionsbrowsers: The browser(s) that the monitor will use to run jobscreatedAt: The creation time of the monitor in millisdevices: The devices that the monitor will use to run jobsguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitor
class SyntheticsScriptBrowserMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"advanced_options",
"browsers",
"created_at",
"devices",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"runtime",
"status",
)
advanced_options = sgqlc.types.Field(
"SyntheticsScriptBrowserMonitorAdvancedOptions", graphql_name="advancedOptions"
)
browsers = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsBrowser), graphql_name="browsers"
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
devices = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsDevice), graphql_name="devices"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field(SyntheticsLocations, graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(SyntheticsRuntime, graphql_name="runtime")
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")969. SyntheticsScriptBrowserMonitorAdvancedOptions¶
The advanced options available for a Script Browser monitor
Available fields:
deviceEmulation: Emulate a deviceenableScreenshotOnFailureAndScript: Capture a screenshot during job execution
class SyntheticsScriptBrowserMonitorAdvancedOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("device_emulation", "enable_screenshot_on_failure_and_script")
device_emulation = sgqlc.types.Field(
SyntheticsDeviceEmulation, graphql_name="deviceEmulation"
)
enable_screenshot_on_failure_and_script = sgqlc.types.Field(
Boolean, graphql_name="enableScreenshotOnFailureAndScript"
)970. SyntheticsScriptBrowserMonitorCreateMutationResult¶
The result of a Script Browser monitor create mutation
Available fields:
errors: Errors that occurred during Script Browser monitor create mutationmonitor: The resulting script browser monitor
class SyntheticsScriptBrowserMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorCreateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsScriptBrowserMonitor, graphql_name="monitor")971. SyntheticsScriptBrowserMonitorUpdateMutationResult¶
The result of a Script Browser monitor update mutation
Available fields:
errors: Errors that occurred during Script Browser monitor update mutationmonitor: The resulting script browser monitor
class SyntheticsScriptBrowserMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorUpdateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsScriptBrowserMonitor, graphql_name="monitor")972. SyntheticsSecureCredentialMutationResult¶
The result of a secure credential mutation
Available fields:
createdAt: The moment when the secure credential was created, represented in milliseconds since the Unix epoch.description: Description of the secure credential, if availableerrors: An array containing errors, if anykey: The unique identifier of the secure credential, if availablelastUpdate: The moment when the secure credential was last updated, represented in milliseconds since the Unix epoch.
class SyntheticsSecureCredentialMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "description", "errors", "key", "last_update")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
description = sgqlc.types.Field(String, graphql_name="description")
errors = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsError), graphql_name="errors"
)
key = sgqlc.types.Field(String, graphql_name="key")
last_update = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastUpdate")973. SyntheticsSimpleBrowserMonitor¶
A Simple Browser monitor resulting from a Simple Browser monitor mutation
Available fields:
advancedOptions: The monitor advanced optionsbrowsers: The browser(s) that the monitor will use to run jobscreatedAt: The creation time of the monitor in millisdevices: The devices that the monitor will use to run jobsguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitoruri: The uri the monitor runs against
class SyntheticsSimpleBrowserMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"advanced_options",
"browsers",
"created_at",
"devices",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"runtime",
"status",
"uri",
)
advanced_options = sgqlc.types.Field(
"SyntheticsSimpleBrowserMonitorAdvancedOptions", graphql_name="advancedOptions"
)
browsers = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsBrowser), graphql_name="browsers"
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
devices = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsDevice), graphql_name="devices"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field(SyntheticsLocations, graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(SyntheticsRuntime, graphql_name="runtime")
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")
uri = sgqlc.types.Field(String, graphql_name="uri")974. SyntheticsSimpleBrowserMonitorAdvancedOptions¶
The advanced options available for a Simple Browser monitor
Available fields:
customHeaders: Custom headers to use in monitor jobdeviceEmulation: Emulate a deviceenableScreenshotOnFailureAndScript: Capture a screenshot during job executionresponseValidationText: Validation text for monitor to search for at given URIuseTlsValidation: Monitor should validate SSL certificate chain
class SyntheticsSimpleBrowserMonitorAdvancedOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"custom_headers",
"device_emulation",
"enable_screenshot_on_failure_and_script",
"response_validation_text",
"use_tls_validation",
)
custom_headers = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsCustomHeader), graphql_name="customHeaders"
)
device_emulation = sgqlc.types.Field(
SyntheticsDeviceEmulation, graphql_name="deviceEmulation"
)
enable_screenshot_on_failure_and_script = sgqlc.types.Field(
Boolean, graphql_name="enableScreenshotOnFailureAndScript"
)
response_validation_text = sgqlc.types.Field(
String, graphql_name="responseValidationText"
)
use_tls_validation = sgqlc.types.Field(Boolean, graphql_name="useTlsValidation")975. SyntheticsSimpleBrowserMonitorCreateMutationResult¶
The result of a Simple Browser monitor create mutation
Available fields:
errors: Errors that occurred during Simple Browser monitor create mutationmonitor: The resulting Simple Browser monitor
class SyntheticsSimpleBrowserMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorCreateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsSimpleBrowserMonitor, graphql_name="monitor")976. SyntheticsSimpleBrowserMonitorUpdateMutationResult¶
The result of a Simple Browser monitor update mutation
Available fields:
errors: Errors that occurred during Simple Browser monitor update mutationmonitor: The resulting Simple Browser monitor
class SyntheticsSimpleBrowserMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorUpdateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsSimpleBrowserMonitor, graphql_name="monitor")977. SyntheticsSimpleMonitor¶
A Simple (ping) monitor resulting from a Simple monitor mutation
Available fields:
advancedOptions: The monitor advanced optionscreatedAt: The creation time of the monitor in millisguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesstatus: The run state of the monitoruri: The uri the monitor runs against
class SyntheticsSimpleMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"advanced_options",
"created_at",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"status",
"uri",
)
advanced_options = sgqlc.types.Field(
"SyntheticsSimpleMonitorAdvancedOptions", graphql_name="advancedOptions"
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field(SyntheticsLocations, graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")
uri = sgqlc.types.Field(String, graphql_name="uri")978. SyntheticsSimpleMonitorAdvancedOptions¶
The advanced options available for a Simple (ping) monitor
Available fields:
customHeaders: Custom headers to use in monitor jobredirectIsFailure: Categorize redirects during a monitor job as a failureresponseValidationText: Validation text for monitor to search for at given URIshouldBypassHeadRequest: Monitor should skip default HEAD request and instead use GET verb in checkuseTlsValidation: Monitor should validate SSL certificate chain
class SyntheticsSimpleMonitorAdvancedOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"custom_headers",
"redirect_is_failure",
"response_validation_text",
"should_bypass_head_request",
"use_tls_validation",
)
custom_headers = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsCustomHeader), graphql_name="customHeaders"
)
redirect_is_failure = sgqlc.types.Field(Boolean, graphql_name="redirectIsFailure")
response_validation_text = sgqlc.types.Field(
String, graphql_name="responseValidationText"
)
should_bypass_head_request = sgqlc.types.Field(
Boolean, graphql_name="shouldBypassHeadRequest"
)
use_tls_validation = sgqlc.types.Field(Boolean, graphql_name="useTlsValidation")979. SyntheticsSimpleMonitorUpdateMutationResult¶
The result of a Simple (ping) monitor update mutation
Available fields:
errors: Errors that occurred during Simple (ping) monitor update mutationmonitor: The resulting Simple (ping) monitor
class SyntheticsSimpleMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorUpdateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsSimpleMonitor, graphql_name="monitor")980. SyntheticsStep¶
A step that will be added to the monitor script
Available fields:
ordinal: The position of the step within the script ranging from 1-100.type: The type of step to be added to the scriptvalues: The metadata values related to the step
class SyntheticsStep(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("ordinal", "type", "values")
ordinal = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="ordinal")
type = sgqlc.types.Field(
sgqlc.types.non_null(SyntheticsStepType), graphql_name="type"
)
values = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="values"
)981. SyntheticsStepMonitor¶
A Step monitor resulting from a Step monitor mutation
Available fields:
advancedOptions: The monitor advanced optionsbrowsers: The browser(s) that the monitor will use to run jobscreatedAt: The creation time of the monitor in millisdevices: The devices that the monitor will use to run jobsguid: The unique client identifier for the Synthetics Monitor in New Relicid: The unique identifier of the monitor within the Synthetics domainlocations: The locations the monitor runs frommodifiedAt: The last modification time of the monitor in millisname: The human readable identifier for the monitorperiod: The interval at which the monitor runs in minutesruntime: The runtime that the monitor will use to run jobsstatus: The run state of the monitorsteps: The steps that make up the script the monitor will run
class SyntheticsStepMonitor(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"advanced_options",
"browsers",
"created_at",
"devices",
"guid",
"id",
"locations",
"modified_at",
"name",
"period",
"runtime",
"status",
"steps",
)
advanced_options = sgqlc.types.Field(
"SyntheticsStepMonitorAdvancedOptions", graphql_name="advancedOptions"
)
browsers = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsBrowser), graphql_name="browsers"
)
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
devices = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsDevice), graphql_name="devices"
)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
id = sgqlc.types.Field(ID, graphql_name="id")
locations = sgqlc.types.Field(SyntheticsLocations, graphql_name="locations")
modified_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="modifiedAt")
name = sgqlc.types.Field(String, graphql_name="name")
period = sgqlc.types.Field(SyntheticsMonitorPeriod, graphql_name="period")
runtime = sgqlc.types.Field(
SyntheticsExtendedTypeMonitorRuntime, graphql_name="runtime"
)
status = sgqlc.types.Field(SyntheticsMonitorStatus, graphql_name="status")
steps = sgqlc.types.Field(sgqlc.types.list_of(SyntheticsStep), graphql_name="steps")982. SyntheticsStepMonitorAdvancedOptions¶
The advanced options available for a Step monitor
Available fields:
enableScreenshotOnFailureAndScript: Capture a screenshot during job execution
class SyntheticsStepMonitorAdvancedOptions(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enable_screenshot_on_failure_and_script",)
enable_screenshot_on_failure_and_script = sgqlc.types.Field(
Boolean, graphql_name="enableScreenshotOnFailureAndScript"
)983. SyntheticsStepMonitorCreateMutationResult¶
The result of a Step monitor create mutation
Available fields:
errors: Errors that occurred during Step monitor create mutationmonitor: The resulting Step monitor
class SyntheticsStepMonitorCreateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorCreateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsStepMonitor, graphql_name="monitor")984. SyntheticsStepMonitorUpdateMutationResult¶
The result of a Step monitor update mutation
Available fields:
errors: Errors that occurred during Step monitor update mutationmonitor: The resulting Step monitor
class SyntheticsStepMonitorUpdateMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "monitor")
errors = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(SyntheticsMonitorUpdateError)),
graphql_name="errors",
)
monitor = sgqlc.types.Field(SyntheticsStepMonitor, graphql_name="monitor")985. SyntheticsSyntheticMonitorAsset¶
Asset produced during the execution of the check
Available fields:
type: MIME type of asseturl: Temporary url at which the asset is available for download
class SyntheticsSyntheticMonitorAsset(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("type", "url")
type = sgqlc.types.Field(String, graphql_name="type")
url = sgqlc.types.Field(String, graphql_name="url")986. SyntheticsWeeklyMonitorDowntimeMutationResult¶
Monitor downtime object returned to the customer for a downtime run weekly
Available fields:
accountId: The account ID associated with the monitor downtimeendRepeat: Configuration options if the customer wants the monitor to end at a specific dateendTime: The date and time in which the monitor downtime will endguid: The entity GUID associated with the monitor downtimemaintenanceDays: Days of the week the monitor downtime will runmonitorGuids: The monitor GUIDs associated with the monitor downtimename: The name of the monitor downtimestartTime: The date and time in which the monitor downtime will begintimezone: The timezone the time values will be in
class SyntheticsWeeklyMonitorDowntimeMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"end_repeat",
"end_time",
"guid",
"maintenance_days",
"monitor_guids",
"name",
"start_time",
"timezone",
)
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
end_repeat = sgqlc.types.Field(
SyntheticsDateWindowEndOutput, graphql_name="endRepeat"
)
end_time = sgqlc.types.Field(NaiveDateTime, graphql_name="endTime")
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")
maintenance_days = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsMonitorDowntimeWeekDays),
graphql_name="maintenanceDays",
)
monitor_guids = sgqlc.types.Field(
sgqlc.types.list_of(EntityGuid), graphql_name="monitorGuids"
)
name = sgqlc.types.Field(String, graphql_name="name")
start_time = sgqlc.types.Field(NaiveDateTime, graphql_name="startTime")
timezone = sgqlc.types.Field(String, graphql_name="timezone")987. SystemIdentityCreatedSystemIdentity¶
A non user system identity
Available fields:
clientId: The client id of the system identityclientSecret: The client secretcredentialExpiration: The client secret expiration in ISO-8601 formatid: The id of the system identityname: The name of the system identityorganizationId: The id of the organization the system identity belongs topublicKey: The public key of the system identitytype: The type of system identity
class SystemIdentityCreatedSystemIdentity(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"client_id",
"client_secret",
"credential_expiration",
"id",
"name",
"organization_id",
"public_key",
"type",
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="clientId")
client_secret = sgqlc.types.Field(SecureValue, graphql_name="clientSecret")
credential_expiration = sgqlc.types.Field(
String, graphql_name="credentialExpiration"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
public_key = sgqlc.types.Field(String, graphql_name="publicKey")
type = sgqlc.types.Field(SystemIdentityIdentityType, graphql_name="type")988. SystemIdentityGroupCollection¶
A collection of System Identity Groups
Available fields:
items: System Identity GroupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of results
class SystemIdentityGroupCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of("SystemIdentityGroupResponseType"), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")989. SystemIdentityGroupList¶
A list of system identity groups
Available fields:
systemIdentityGroups: A list of system identity groups
class SystemIdentityGroupList(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("system_identity_groups",)
system_identity_groups = sgqlc.types.Field(
sgqlc.types.list_of("SystemIdentityGroupType"),
graphql_name="systemIdentityGroups",
)990. SystemIdentityGroupResponseType¶
A non user system identity group
Available fields:
id: The id of the system identity groupname: The name of the system identity grouporganizationId: The id of the organization the system identity group belongs tosystemIdentities: The members of this system identity group
class SystemIdentityGroupResponseType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name", "organization_id", "system_identities")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
system_identities = sgqlc.types.Field(
"SystemIdentityNestedIdentityCollection", graphql_name="systemIdentities"
)991. SystemIdentityGroupType¶
A System Identity Group
Available fields:
id: The id of the system identity groupname: The name of the system identity grouporganizationId: The id of the organization the system identity group belongs to
class SystemIdentityGroupType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "name", "organization_id")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)992. SystemIdentityIdentityCollection¶
A Collection of System Identities
Available fields:
items: System IdentitiesnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of results
class SystemIdentityIdentityCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of("SystemIdentityResponseType"), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")993. SystemIdentityNestedGroupCollection¶
A collection of System Identity Groups
Available fields:
items: System Identity GroupsnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of results
class SystemIdentityNestedGroupCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of(SystemIdentityGroupType), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")994. SystemIdentityNestedIdentityCollection¶
A collection of System Identities
Available fields:
items: System IdentitiesnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: The total number of results
class SystemIdentityNestedIdentityCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("items", "next_cursor", "total_count")
items = sgqlc.types.Field(
sgqlc.types.list_of("SystemIdentityType"), graphql_name="items"
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(Int, graphql_name="totalCount")995. SystemIdentityResponseType¶
A non user system identity
Available fields:
clientId: The client id of the system identityid: The id of the system identityname: The name of the system identityorganizationId: The id of the organization the system identity belongs tosystemIdentityGroups: The groups to which this identity is a membertype: The type of system identity
class SystemIdentityResponseType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"client_id",
"id",
"name",
"organization_id",
"system_identity_groups",
"type",
)
client_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="clientId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)
system_identity_groups = sgqlc.types.Field(
SystemIdentityNestedGroupCollection, graphql_name="systemIdentityGroups"
)
type = sgqlc.types.Field(SystemIdentityIdentityType, graphql_name="type")996. SystemIdentityType¶
A non user system identity
Available fields:
clientId: The client id of the system identityid: The id of the system identityname: The name of the system identityorganizationId: The id of the organization the system identity belongs to
class SystemIdentityType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("client_id", "id", "name", "organization_id")
client_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="clientId")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
organization_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="organizationId"
)997. TaggingMutationError¶
An error object for tag mutations.
Available fields:
message: A message explaining what the errors is about.type: The type of error.
class TaggingMutationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message", "type")
message = sgqlc.types.Field(String, graphql_name="message")
type = sgqlc.types.Field(TaggingMutationErrorType, graphql_name="type")998. TaggingMutationResult¶
The result of a tag mutation
Available fields:
errors: An array containing errors, if any. These are expected errors listed in TagMutationErrorType which a request should be capable of handling appropriately.
class TaggingMutationResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors",)
errors = sgqlc.types.Field(
sgqlc.types.list_of(TaggingMutationError), graphql_name="errors"
)999. TimeWindow¶
Represents a time window.
Available fields:
endTime: The end time of the time window the number of milliseconds since the Unix epoch.startTime: The start time of the time window the number of milliseconds since the Unix epoch.
class TimeWindow(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("end_time", "start_time")
end_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="endTime")
start_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="startTime")1000. TimeZoneInfo¶
Information about a Time Zone
Available fields:
name: The name of the Time Zoneoffset: The offset in seconds from UTC
class TimeZoneInfo(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name", "offset")
name = sgqlc.types.Field(String, graphql_name="name")
offset = sgqlc.types.Field(Seconds, graphql_name="offset")1001. User¶
The User object provides general data about the user.
Available fields:
createdAtemailidnametimeZoneName
class User(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "email", "id", "name", "time_zone_name")
created_at = sgqlc.types.Field(Int, graphql_name="createdAt")
email = sgqlc.types.Field(String, graphql_name="email")
id = sgqlc.types.Field(Int, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")
time_zone_name = sgqlc.types.Field(String, graphql_name="timeZoneName")1002. UserManagementAddUsersToGroupsPayload¶
Autogenerated return type of AddUsersToGroups.
Available fields:
groups: The group(s) updated.
class UserManagementAddUsersToGroupsPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups",)
groups = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("UserManagementGroup")),
graphql_name="groups",
)1003. UserManagementAuthenticationDomain¶
An “authentication domain” is a grouping of New Relic users governed by the same user management settings, like how they’re provisioned (added and updated), how they’re authenticated (logged in), session settings, and how user upgrades are managed.
Available fields:
groups: container for groups enabling cursor based paginationid: a value that uniquely identifies this objectname: the name of the objectprovisioningType: the method used to provision users in this authentication domainusers: container for users enabling cursor based pagination
class UserManagementAuthenticationDomain(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups", "id", "name", "provisioning_type", "users")
groups = sgqlc.types.Field(
"UserManagementGroups",
graphql_name="groups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
UserManagementGroupFilterInput,
graphql_name="filter",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
(
"sort",
sgqlc.types.Arg(
sgqlc.types.list_of(
sgqlc.types.non_null(UserManagementGroupSortInput)
),
graphql_name="sort",
default=(),
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`UserManagementGroupFilterInput`): Filter groups
* `id` (`[ID!]`): a list of ids to filter returned objects by
(NOTICE: setting both this argument and the filter argument to
filter by ID is not allowed) (NOTICE: this argument will be
deprecated at a later date, so please use the filter argument to
return users by ID)
* `sort` (`[UserManagementGroupSortInput!]`): Sort groups
(default: `[]`)
"""
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
provisioning_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="provisioningType"
)
users = sgqlc.types.Field(
"UserManagementUsers",
graphql_name="users",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"filter",
sgqlc.types.Arg(
UserManagementUserFilterInput,
graphql_name="filter",
default=None,
),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `filter` (`UserManagementUserFilterInput`): Filter users
* `id` (`[ID!]`): a list of ids to filter returned objects by
(NOTICE: setting both this argument and the filter argument to
filter by ID is not allowed) (NOTICE: this argument will be
deprecated at a later date, so please use the filter argument to
return users by ID)
"""1004. UserManagementAuthenticationDomains¶
container for authentication domains enabling cursor based pagination
Available fields:
authenticationDomains: container for authentication_domains enabling cursor based paginationnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class UserManagementAuthenticationDomains(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domains", "next_cursor", "total_count")
authentication_domains = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(UserManagementAuthenticationDomain)
)
),
graphql_name="authenticationDomains",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)1005. UserManagementCreateGroupPayload¶
Autogenerated return type of CreateGroup.
Available fields:
group: The group that was created
class UserManagementCreateGroupPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("group",)
group = sgqlc.types.Field("UserManagementGroup", graphql_name="group")1006. UserManagementCreateUserPayload¶
Autogenerated return type of CreateUser.
Available fields:
createdUser: The user that was created
class UserManagementCreateUserPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_user",)
created_user = sgqlc.types.Field(
"UserManagementCreatedUser", graphql_name="createdUser"
)1007. UserManagementCreatedUser¶
A newly created user of New Relic scoped to an authentication domain.
Available fields:
authenticationDomainId: Authentication domain of the created user.email: Email address of the created user.id: The ID of the created user.name: The full name of the created user.type: A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
class UserManagementCreatedUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domain_id", "email", "id", "name", "type")
authentication_domain_id = sgqlc.types.Field(
ID, graphql_name="authenticationDomainId"
)
email = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="email")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
type = sgqlc.types.Field(
sgqlc.types.non_null("UserManagementUserType"), graphql_name="type"
)1008. UserManagementDeleteGroupPayload¶
Autogenerated return type of DeleteGroup.
Available fields:
group: The group that was deleted
class UserManagementDeleteGroupPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("group",)
group = sgqlc.types.Field("UserManagementGroup", graphql_name="group")1009. UserManagementDeleteUserPayload¶
Autogenerated return type of DeleteUser.
Available fields:
deletedUser: The user that was deleted
class UserManagementDeleteUserPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("deleted_user",)
deleted_user = sgqlc.types.Field(
"UserManagementDeletedUser", graphql_name="deletedUser"
)1010. UserManagementDeletedUser¶
A user of New Relic to be deleted.
Available fields:
id: The id of the deleted user
class UserManagementDeletedUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1011. UserManagementGroup¶
For users on our New Relic One user model, a “group” represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this objectusers: container for users enabling cursor based pagination
class UserManagementGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id", "users")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
users = sgqlc.types.Field(
"UserManagementGroupUsers",
graphql_name="users",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): a list of ids to filter returned objects by
"""1012. UserManagementGroupUser¶
User information returned within Groups
Available fields:
email: The email of the user.id: a value that uniquely identifies this objectname: The full name of the user.timeZone: The configured time zone of the user.
class UserManagementGroupUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "id", "name", "time_zone")
email = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="email")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
time_zone = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="timeZone")1013. UserManagementGroupUsers¶
container for users enabling cursor based pagination
Available fields:
nextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of resultsusers: container for users enabling cursor based pagination
class UserManagementGroupUsers(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "total_count", "users")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)
users = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(UserManagementGroupUser))
),
graphql_name="users",
)1014. UserManagementGroups¶
container for groups enabling cursor based pagination
Available fields:
groups: container for groups enabling cursor based paginationnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class UserManagementGroups(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups", "next_cursor", "total_count")
groups = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(UserManagementGroup))
),
graphql_name="groups",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)1015. UserManagementOrganizationStitchedFields¶
Available fields:
authenticationDomains: An “authentication domain” is a grouping of New Relic users governed by the same user management settings, like how they’re provisioned (added and updated), how they’re authenticated (logged in), session settings, and how user upgrades are managed.types: User Types available for this organization
class UserManagementOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("authentication_domains", "types")
authentication_domains = sgqlc.types.Field(
UserManagementAuthenticationDomains,
graphql_name="authenticationDomains",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): a list of ids to filter returned objects by
"""
types = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("UserManagementOrganizationUserType")),
graphql_name="types",
)1016. UserManagementOrganizationUserType¶
A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this object
class UserManagementOrganizationUserType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1017. UserManagementPendingUpgradeRequest¶
Exists only if a user has a pending upgrade request.
Available fields:
id: a value that uniquely identifies this objectmessage: Requester message, why the user believes they require the upgrade.requestedUserType: Requested user type for the user.
class UserManagementPendingUpgradeRequest(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "message", "requested_user_type")
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
message = sgqlc.types.Field(String, graphql_name="message")
requested_user_type = sgqlc.types.Field(
"UserManagementUserType", graphql_name="requestedUserType"
)1018. UserManagementRemoveUsersFromGroupsPayload¶
Autogenerated return type of RemoveUsersFromGroups.
Available fields:
groups: The group(s) updated.
class UserManagementRemoveUsersFromGroupsPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups",)
groups = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(UserManagementGroup)),
graphql_name="groups",
)1019. UserManagementUpdateGroupPayload¶
Autogenerated return type of UpdateGroup.
Available fields:
group: The group that was updated
class UserManagementUpdateGroupPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("group",)
group = sgqlc.types.Field(UserManagementGroup, graphql_name="group")1020. UserManagementUpdateUserPayload¶
Autogenerated return type of UpdateUser.
Available fields:
user: The user that was updated
class UserManagementUpdateUserPayload(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("user",)
user = sgqlc.types.Field("UserManagementUser", graphql_name="user")1021. UserManagementUser¶
A user of New Relic scoped to an authentication domain.
Available fields:
email: Email address of the user.emailVerificationState: One of: “Not Verifiable”, “Verified”, and “Pending”.
Not Verifiable: the user’s email does not require verification.
Verified: the user’s email requires verification and has been.
Pending: the user’s email requires verification and has not been.
groups: container for groups enabling cursor based paginationid: a value that uniquely identifies this objectlastActive: The last active date of the user.name: The full name of the user.pendingUpgradeRequest: The pending upgrade request for the user (if any).timeZone: Time zone of the user in IANA Time Zone database format, also known as the “Olson” time zone database format (for exmaple, “America/Los_Angeles”).type: A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
class UserManagementUser(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"email",
"email_verification_state",
"groups",
"id",
"last_active",
"name",
"pending_upgrade_request",
"time_zone",
"type",
)
email = sgqlc.types.Field(String, graphql_name="email")
email_verification_state = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="emailVerificationState"
)
groups = sgqlc.types.Field(
"UserManagementUserGroups",
graphql_name="groups",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"id",
sgqlc.types.Arg(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="id",
default=None,
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): the cursor from the previous request, to
get the next page
* `id` (`[ID!]`): a list of ids to filter returned objects by
"""
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
last_active = sgqlc.types.Field(DateTime, graphql_name="lastActive")
name = sgqlc.types.Field(String, graphql_name="name")
pending_upgrade_request = sgqlc.types.Field(
UserManagementPendingUpgradeRequest, graphql_name="pendingUpgradeRequest"
)
time_zone = sgqlc.types.Field(String, graphql_name="timeZone")
type = sgqlc.types.Field(
sgqlc.types.non_null("UserManagementUserType"), graphql_name="type"
)1022. UserManagementUserGroup¶
For users on our New Relic One user model, a “group” represents a group of users. Putting users in a group allows the managing of permissions for multiple users at the same time.
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this object
class UserManagementUserGroup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1023. UserManagementUserGroups¶
container for groups enabling cursor based pagination
Available fields:
groups: container for groups enabling cursor based paginationnextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of results
class UserManagementUserGroups(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("groups", "next_cursor", "total_count")
groups = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(UserManagementUserGroup))
),
graphql_name="groups",
)
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)1024. UserManagementUserType¶
A “user type” is what determines the set of New Relic capabilities a user can theoretically access.
Available fields:
displayName: the name of the objectid: a value that uniquely identifies this object
class UserManagementUserType(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("display_name", "id")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1025. UserManagementUsers¶
container for users enabling cursor based pagination
Available fields:
nextCursor: an opaque cursor to supply with subsequent requests to get the next page of results, null if there are no more pagestotalCount: the total number of resultsusers: container for users enabling cursor based pagination
class UserManagementUsers(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "total_count", "users")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)
users = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(UserManagementUser))
),
graphql_name="users",
)1026. UserReference¶
The UserReference object provides basic identifying information about the user.
Available fields:
emailgravataridname
class UserReference(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "gravatar", "id", "name")
email = sgqlc.types.Field(String, graphql_name="email")
gravatar = sgqlc.types.Field(String, graphql_name="gravatar")
id = sgqlc.types.Field(Int, graphql_name="id")
name = sgqlc.types.Field(String, graphql_name="name")1027. UsersActorStitchedFields¶
Available fields:
userSearch: Search for users using a custom query. If no query is provided, returns all visible users. NOTE: this API only supports users in the New Relic One user model.
class UsersActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("user_search",)
user_search = sgqlc.types.Field(
"UsersUserSearchResult",
graphql_name="userSearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"query",
sgqlc.types.Arg(
UsersUserSearchQuery, graphql_name="query", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): The cursor to fetch paginated user search
results.
* `query` (`UsersUserSearchQuery`): The user search query takes 1
argument `scope` that takes in various arguments. `userIds` is
only an exact match while the rest of the arguments can search
for an exact or fuzzy match.
"""1028. UsersUserSearch¶
User information returned for UserSearch
Available fields:
email: The email of the user.name: The full name of the user.title: The job title of the user.userId: The unique identifier of the user.
class UsersUserSearch(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("email", "name", "title", "user_id")
email = sgqlc.types.Field(String, graphql_name="email")
name = sgqlc.types.Field(String, graphql_name="name")
title = sgqlc.types.Field(String, graphql_name="title")
user_id = sgqlc.types.Field(ID, graphql_name="userId")1029. UsersUserSearchResult¶
The result object for UserSearch.
Available fields:
nextCursor: The cursor for the next page.totalCount: The total number of users found. Note: Not necessarily the same as number of users returned, due to pagination.users: Set of all users returned from the query.
class UsersUserSearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "total_count", "users")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)
users = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(UsersUserSearch))
),
graphql_name="users",
)1030. WhatsNewDocsStitchedFields¶
Available fields:
announcement: Fetches an announcement by ID.eolAnnouncement: Fetches an EOL announcement by ID.newsSearch: Provides a paginated search to fetch news.
class WhatsNewDocsStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("announcement", "eol_announcement", "news_search")
announcement = sgqlc.types.Field(
"WhatsNewAnnouncementContent",
graphql_name="announcement",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The ID of the announcement.
"""
eol_announcement = sgqlc.types.Field(
"WhatsNewEolAnnouncementContent",
graphql_name="eolAnnouncement",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
"""Arguments:
* `id` (`ID!`): The ID of the EOL announcement.
"""
news_search = sgqlc.types.Field(
"WhatsNewSearchResult",
graphql_name="newsSearch",
args=sgqlc.types.ArgDict(
(
(
"cursor",
sgqlc.types.Arg(String, graphql_name="cursor", default=None),
),
(
"query",
sgqlc.types.Arg(
WhatsNewContentSearchQuery, graphql_name="query", default=None
),
),
)
),
)
"""Arguments:
* `cursor` (`String`): A cursor.
* `query` (`WhatsNewContentSearchQuery`): A criteria for searching
news.
"""1031. WhatsNewSearchResult¶
Represents the resulting details from a search of news.
Available fields:
nextCursor: The next cursor, used for pagination. If a cursor is present, it means more content can be fetched.results: A list of news.totalCount: The total amount of news available that satisfies the search criteria.
class WhatsNewSearchResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results", "total_count")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WhatsNewContent)),
graphql_name="results",
)
total_count = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="totalCount"
)1032. WorkflowAutomationAccountStitchedFields¶
Available fields:
actionDefinitions: Retrieves all existing action definitionsschedule: Retrieves an existing scheduleschedules: Retrieves schedulesworkflow: Retrieves an existing workflow definitionworkflowDefinitionValidation: Validate a workflow definitionworkflowRunInfo: Retrieve detailed information of a workflow runworkflows: Retrieves existing workflow definitions for a given scope
class WorkflowAutomationAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"action_definitions",
"schedule",
"schedules",
"workflow",
"workflow_definition_validation",
"workflow_run_info",
"workflows",
)
action_definitions = sgqlc.types.Field(
"WorkflowAutomationActionDefinitionsResponse", graphql_name="actionDefinitions"
)
schedule = sgqlc.types.Field(
"WorkflowAutomationScheduleResponse",
graphql_name="schedule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="id", default=None
),
),
)
),
)
schedules = sgqlc.types.Field(
"WorkflowAutomationSchedulesResponse", graphql_name="schedules"
)
workflow = sgqlc.types.Field(
"WorkflowAutomationWorkflowResponse",
graphql_name="workflow",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
workflow_definition_validation = sgqlc.types.Field(
"WorkflowAutomationWorkflowDefinitionValidationResponse",
graphql_name="workflowDefinitionValidation",
args=sgqlc.types.ArgDict(
(
(
"definition",
sgqlc.types.Arg(
sgqlc.types.non_null(
WorkflowAutomationWorkflowDefinitionValidationInput
),
graphql_name="definition",
default=None,
),
),
)
),
)
workflow_run_info = sgqlc.types.Field(
"WorkflowAutomationWorkflowRunInfoResponse",
graphql_name="workflowRunInfo",
args=sgqlc.types.ArgDict(
(
(
"run_id",
sgqlc.types.Arg(
sgqlc.types.non_null(ID), graphql_name="runId", default=None
),
),
)
),
)
workflows = sgqlc.types.Field(
"WorkflowAutomationWorkflowsResponse",
graphql_name="workflows",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
"""Arguments:
* `cursor` (`String`): Cursor
"""1033. WorkflowAutomationActionDefinition¶
Action definition
Available fields:
description: Description of the action definitioninputs: Inputs of the action definitionname: Name of the action definitionoutputs: Outputs of the action definitiontimeout: Timeouts of the action definitionversion: Version of the action definition
class WorkflowAutomationActionDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "inputs", "name", "outputs", "timeout", "version")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
inputs = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("WorkflowAutomationActionDefinitionInput")
)
),
graphql_name="inputs",
)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
outputs = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("WorkflowAutomationActionDefinitionOutput")
)
),
graphql_name="outputs",
)
timeout = sgqlc.types.Field(
sgqlc.types.non_null("WorkflowAutomationActionDefinitionTimeout"),
graphql_name="timeout",
)
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")1034. WorkflowAutomationActionDefinitionInput¶
Action definition inputs
Available fields:
example: Example of the action definition inputname: Name of the action definition inputrequired: If the action definition input is required or notsecretAllowed: If this input can be a secret or nottype: Type of the action definition inputvalidations: Validation details of action definition input
class WorkflowAutomationActionDefinitionInput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"example",
"name",
"required",
"secret_allowed",
"type",
"validations",
)
example = sgqlc.types.Field(String, graphql_name="example")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
required = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="required")
secret_allowed = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="secretAllowed"
)
type = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationActionDefinitionInputType),
graphql_name="type",
)
validations = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkflowAutomationValidationType")),
graphql_name="validations",
)1035. WorkflowAutomationActionDefinitionOutput¶
Action definition outputs
Available fields:
name: Name of the action definition output
class WorkflowAutomationActionDefinitionOutput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("name",)
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")1036. WorkflowAutomationActionDefinitionTimeout¶
Action definition timeouts
Available fields:
action: The timeout for the action in seconds
class WorkflowAutomationActionDefinitionTimeout(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("action",)
action = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="action")1037. WorkflowAutomationActionDefinitionsResponse¶
Response for retrieving action definitions
Available fields:
results: List of action definition results
class WorkflowAutomationActionDefinitionsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("results",)
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WorkflowAutomationActionDefinition)),
graphql_name="results",
)1038. WorkflowAutomationActorStitchedFields¶
Available fields:
workflow: Retrieves an existing global workflow definitionworkflows: Retrieves existing global workflow definitions
class WorkflowAutomationActorStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("workflow", "workflows")
workflow = sgqlc.types.Field(
"WorkflowAutomationWorkflowResponse",
graphql_name="workflow",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
workflows = sgqlc.types.Field(
"WorkflowAutomationWorkflowsResponse",
graphql_name="workflows",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
"""Arguments:
* `cursor` (`String`): Cursor
"""1039. WorkflowAutomationAllowedStringValuesValidation¶
Action definition input allowed values validation
Available fields:
allowedStringValuesConstraint: list of allowed valueserrorMessage: error message when the validation fails
class WorkflowAutomationAllowedStringValuesValidation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("allowed_string_values_constraint", "error_message")
allowed_string_values_constraint = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="allowedStringValuesConstraint",
)
error_message = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="errorMessage"
)1040. WorkflowAutomationCreateScheduleResponse¶
Response for scheduling a workflow run
Available fields:
scheduleId: Unique identifier for the schedule
class WorkflowAutomationCreateScheduleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("schedule_id",)
schedule_id = sgqlc.types.Field(ID, graphql_name="scheduleId")1041. WorkflowAutomationCreateWorkflowDefinitionResponse¶
Response of creating a workflow definition
Available fields:
definition: The workflow definition
class WorkflowAutomationCreateWorkflowDefinitionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition",)
definition = sgqlc.types.Field(
"WorkflowAutomationWorkflowDefinition", graphql_name="definition"
)1042. WorkflowAutomationDeleteScheduleResponse¶
Response for terminating a schedule
Available fields:
scheduleId: Unique identifier for the schedule
class WorkflowAutomationDeleteScheduleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("schedule_id",)
schedule_id = sgqlc.types.Field(ID, graphql_name="scheduleId")1043. WorkflowAutomationDeleteWorkflowDefinitionResponse¶
Response of deleting a workflow definition
Available fields:
definition: The workflow definition
class WorkflowAutomationDeleteWorkflowDefinitionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition",)
definition = sgqlc.types.Field(
"WorkflowAutomationWorkflowDefinitionOutline", graphql_name="definition"
)1044. WorkflowAutomationMaxIntegerValueValidation¶
Action definition input max value validation
Available fields:
errorMessage: error message when the validation failsmaxIntegerValueConstraint: max value constraint value
class WorkflowAutomationMaxIntegerValueValidation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_message", "max_integer_value_constraint")
error_message = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="errorMessage"
)
max_integer_value_constraint = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="maxIntegerValueConstraint"
)1045. WorkflowAutomationMaxLengthValidation¶
Action definition input max length validation
Available fields:
errorMessage: error message when the validation failsmaxLengthConstraint: max length constraint value
class WorkflowAutomationMaxLengthValidation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_message", "max_length_constraint")
error_message = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="errorMessage"
)
max_length_constraint = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="maxLengthConstraint"
)1046. WorkflowAutomationMinIntegerValueValidation¶
Action definition input min value validation
Available fields:
errorMessage: error message when the validation failsminIntegerValueConstraint: min value constraint value
class WorkflowAutomationMinIntegerValueValidation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_message", "min_integer_value_constraint")
error_message = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="errorMessage"
)
min_integer_value_constraint = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="minIntegerValueConstraint"
)1047. WorkflowAutomationOrganizationStitchedFields¶
Available fields:
workflow: Retrieves an existing workflow definition
class WorkflowAutomationOrganizationStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("workflow",)
workflow = sgqlc.types.Field(
"WorkflowAutomationWorkflowResponse",
graphql_name="workflow",
args=sgqlc.types.ArgDict(
(
(
"name",
sgqlc.types.Arg(
sgqlc.types.non_null(String), graphql_name="name", default=None
),
),
("version", sgqlc.types.Arg(Int, graphql_name="version", default=None)),
)
),
)
"""Arguments:
* `name` (`String!`): Name of the workflow definition to retrieve
* `version` (`Int`): Version of the workflow definition to
retrieve
"""1048. WorkflowAutomationRegexValidation¶
Action definition input regex validation
Available fields:
errorMessage: error message when the validation failsregexConstraint: regex constraint value
class WorkflowAutomationRegexValidation(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("error_message", "regex_constraint")
error_message = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="errorMessage"
)
regex_constraint = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="regexConstraint"
)1049. WorkflowAutomationScheduleOutline¶
Schedule info required to identify a schedule
Available fields:
id: Unique identifier for the schedule
class WorkflowAutomationScheduleOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1050. WorkflowAutomationScheduleResponse¶
Schedule
Available fields:
cronExpression: Cron expression defining the scheduledefinition: Workflow definition detailsid: Unique identifier for the scheduleoverlapPolicy: Overlap policy for the schedulescheduleName: Name of the scheduletags: Tags associated with the scheduletimezone: Timezone for the scheduleworkflowInputs: Workflow inputs for the schedule
class WorkflowAutomationScheduleResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"cron_expression",
"definition",
"id",
"overlap_policy",
"schedule_name",
"tags",
"timezone",
"workflow_inputs",
)
cron_expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="cronExpression"
)
definition = sgqlc.types.Field(
sgqlc.types.non_null("WorkflowAutomationWorkflowDefinitionOutline"),
graphql_name="definition",
)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")
overlap_policy = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationScheduleOverlapPolicy),
graphql_name="overlapPolicy",
)
schedule_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="scheduleName"
)
tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkflowAutomationTagOutput")),
graphql_name="tags",
)
timezone = sgqlc.types.Field(String, graphql_name="timezone")
workflow_inputs = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null("WorkflowAutomationScheduleWorkflowInput")
)
),
graphql_name="workflowInputs",
)1051. WorkflowAutomationScheduleWorkflowInput¶
Output type for schedule workflow inputs
Available fields:
key: Input keyvalue: Input value
class WorkflowAutomationScheduleWorkflowInput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "value")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
value = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationRawWorkflowInputValue),
graphql_name="value",
)1052. WorkflowAutomationSchedulesResponse¶
Response for retrieving schedules
Available fields:
results: List of schedule outline details
class WorkflowAutomationSchedulesResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("results",)
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkflowAutomationSchedulesResult")),
graphql_name="results",
)1053. WorkflowAutomationSchedulesResult¶
The outlines corresponding to a schedule and its workflow definition
Available fields:
definition: Workflow definition outlineschedule: Schedule outline
class WorkflowAutomationSchedulesResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition", "schedule")
definition = sgqlc.types.Field(
sgqlc.types.non_null("WorkflowAutomationWorkflowDefinitionOutline"),
graphql_name="definition",
)
schedule = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationScheduleOutline), graphql_name="schedule"
)1054. WorkflowAutomationScope¶
The scope for workflow definitions
Available fields:
id: The ID of the scopetype: The type of the scope
class WorkflowAutomationScope(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("id", "type")
id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="id")
type = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationScopeType), graphql_name="type"
)1055. WorkflowAutomationSignalWorkflowRunResponse¶
Response for signaling a workflow run
Available fields:
runId: Unique identifier for the workflow run
class WorkflowAutomationSignalWorkflowRunResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("run_id",)
run_id = sgqlc.types.Field(ID, graphql_name="runId")1056. WorkflowAutomationStartWorkflowRunResponse¶
Response of starting a workflow run
Available fields:
runId: Unique identifier for the workflow run
class WorkflowAutomationStartWorkflowRunResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("run_id",)
run_id = sgqlc.types.Field(ID, graphql_name="runId")1057. WorkflowAutomationStopWorkflowRunResponse¶
Response for stopping a workflow run
Available fields:
runId: Unique identifier for the workflow run
class WorkflowAutomationStopWorkflowRunResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("run_id",)
run_id = sgqlc.types.Field(ID, graphql_name="runId")1058. WorkflowAutomationTagOutput¶
Tag output type
Available fields:
key: The key or name of the tag.values: The list of values of the tag.
class WorkflowAutomationTagOutput(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("key", "values")
key = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="key")
values = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(String))),
graphql_name="values",
)1059. WorkflowAutomationUpdateWorkflowDefinitionResponse¶
Response of updating a workflow definition
Available fields:
definition: The workflow definition
class WorkflowAutomationUpdateWorkflowDefinitionResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition",)
definition = sgqlc.types.Field(
"WorkflowAutomationWorkflowDefinition", graphql_name="definition"
)1060. WorkflowAutomationWorkflowDefinition¶
Workflow definition
Available fields:
definitionId: Entity ID of the workflow definitiondescription: Description of the workflow definitionname: Name of the workflow definitionversion: Version of the workflow definitionyaml: The YAML string for the workflow definition
class WorkflowAutomationWorkflowDefinition(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition_id", "description", "name", "version", "yaml")
definition_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="definitionId"
)
description = sgqlc.types.Field(String, graphql_name="description")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")
yaml = sgqlc.types.Field(sgqlc.types.non_null(SecureValue), graphql_name="yaml")1061. WorkflowAutomationWorkflowDefinitionOutline¶
Workflow definition info required to identify a definition
Available fields:
description: Description of the workflowname: Name of the workflowscope: Scope of the workflowversion: Version of the workflow
class WorkflowAutomationWorkflowDefinitionOutline(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "name", "scope", "version")
description = sgqlc.types.Field(String, graphql_name="description")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
scope = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationScope), graphql_name="scope"
)
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")1062. WorkflowAutomationWorkflowDefinitionValidationError¶
Workflow definition validation error
Available fields:
message: Workflow definition validation error message
class WorkflowAutomationWorkflowDefinitionValidationError(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("message",)
message = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="message")1063. WorkflowAutomationWorkflowDefinitionValidationResponse¶
Response for validating a workflow definition
Available fields:
errors: List of workflow definition validation errorsvalid: If the workflow definition is valid or not
class WorkflowAutomationWorkflowDefinitionValidationResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("errors", "valid")
errors = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(
WorkflowAutomationWorkflowDefinitionValidationError
)
)
),
graphql_name="errors",
)
valid = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="valid")1064. WorkflowAutomationWorkflowResponse¶
Response for retrieving a workflow definition
Available fields:
definition: Workflow definition
class WorkflowAutomationWorkflowResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition",)
definition = sgqlc.types.Field(
WorkflowAutomationWorkflowDefinition, graphql_name="definition"
)1065. WorkflowAutomationWorkflowRunInfoResponse¶
Response for retrieving detailed information of a workflow run
Available fields:
logUrl: URL to access logs related to the workflow runstatus: Status of the workflow run
class WorkflowAutomationWorkflowRunInfoResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("log_url", "status")
log_url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="logUrl")
status = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationWorkflowRunStatus), graphql_name="status"
)1066. WorkflowAutomationWorkflowsResponse¶
Response for retrieving workflow definitions
Available fields:
nextCursor: Next cursorresults: List of workflow definition outline details
class WorkflowAutomationWorkflowsResponse(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("next_cursor", "results")
next_cursor = sgqlc.types.Field(String, graphql_name="nextCursor")
results = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkflowAutomationWorkflowsResult")),
graphql_name="results",
)1067. WorkflowAutomationWorkflowsResult¶
The outline corresponding to a workflow definition
Available fields:
definition: Workflow definition outline
class WorkflowAutomationWorkflowsResult(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("definition",)
definition = sgqlc.types.Field(
sgqlc.types.non_null(WorkflowAutomationWorkflowDefinitionOutline),
graphql_name="definition",
)1068. WorkloadAccountStitchedFields¶
Available fields:
class WorkloadAccountStitchedFields(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ()1069. WorkloadAutomaticStatus¶
The automatic status configuration.
Available fields:
enabled: Whether the automatic status configuration is enabled or not.remainingEntitiesRule: An additional meta-rule that can consider all entities that haven’t been evaluated by any other rule.rules: A list of rules.
class WorkloadAutomaticStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("enabled", "remaining_entities_rule", "rules")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
remaining_entities_rule = sgqlc.types.Field(
"WorkloadRemainingEntitiesRule", graphql_name="remainingEntitiesRule"
)
rules = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null("WorkloadRegularRule"))
),
graphql_name="rules",
)1070. WorkloadCollection¶
A user defined group of entities.
Available fields:
account: The account the workload belongs to.createdAt: The moment when the object was created, represented in milliseconds since the Unix epoch.createdBy: The user who created the workload.description: Relevant information about the workload.entities: A list of entity GUIDs. These entities will belong to the collection as long as their accounts are included in the scope accounts of the collection.entitySearchQueries: A list of entity search queries. The resulting entities will be limited to the scope accounts of the collection.entitySearchQuery: The entity search query that returns the full collection of entities.guid: The unique entity identifier of the workload in New Relic.id: The unique identifier of the workload.name: The workload’s name.permalink: The URL of the workload.scopeAccounts: Accounts that will be used to get entities from.status: Status of the workload.statusConfig: The configuration that defines how the status of the workload is calculated.updatedAt: The moment when the object was last updated, represented in milliseconds since the Unix epoch.updatedBy: The user who last updated the workload.
class WorkloadCollection(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"created_at",
"created_by",
"description",
"entities",
"entity_search_queries",
"entity_search_query",
"guid",
"id",
"name",
"permalink",
"scope_accounts",
"status",
"status_config",
"updated_at",
"updated_by",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
created_by = sgqlc.types.Field(UserReference, graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
entities = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkloadEntityRef")),
graphql_name="entities",
)
entity_search_queries = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkloadEntitySearchQuery")),
graphql_name="entitySearchQueries",
)
entity_search_query = sgqlc.types.Field(String, graphql_name="entitySearchQuery")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
permalink = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="permalink"
)
scope_accounts = sgqlc.types.Field(
sgqlc.types.non_null("WorkloadScopeAccounts"), graphql_name="scopeAccounts"
)
status = sgqlc.types.Field(
sgqlc.types.non_null("WorkloadWorkloadStatus"), graphql_name="status"
)
status_config = sgqlc.types.Field(
"WorkloadStatusConfig", graphql_name="statusConfig"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field(UserReference, graphql_name="updatedBy")1071. WorkloadCollectionWithoutStatus¶
A user defined group of entities without Status
Available fields:
account: The account the workload belongs to.createdAt: The moment when the object was created, represented in milliseconds since the Unix epoch.createdBy: The user who created the workload.description: Relevant information about the workload.entities: A list of entity GUIDs. These entities will belong to the collection as long as their accounts are included in the scope accounts of the collection.entitySearchQueries: A list of entity search queries. The resulting entities will be limited to the scope accounts of the collection.entitySearchQuery: The entity search query that returns the full collection of entities.guid: The unique entity identifier of the workload in New Relic.id: The unique identifier of the workload.name: The workload’s name.permalink: The URL of the workload.scopeAccounts: Accounts that will be used to get entities from.statusConfig: The configuration that defines how the status of the workload is calculated.updatedAt: The moment when the object was last updated, represented in milliseconds since the Unix epoch.updatedBy: The user who last updated the workload.
class WorkloadCollectionWithoutStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"account",
"created_at",
"created_by",
"description",
"entities",
"entity_search_queries",
"entity_search_query",
"guid",
"id",
"name",
"permalink",
"scope_accounts",
"status_config",
"updated_at",
"updated_by",
)
account = sgqlc.types.Field(AccountReference, graphql_name="account")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
created_by = sgqlc.types.Field(UserReference, graphql_name="createdBy")
description = sgqlc.types.Field(String, graphql_name="description")
entities = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkloadEntityRef")),
graphql_name="entities",
)
entity_search_queries = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("WorkloadEntitySearchQuery")),
graphql_name="entitySearchQueries",
)
entity_search_query = sgqlc.types.Field(String, graphql_name="entitySearchQuery")
guid = sgqlc.types.Field(sgqlc.types.non_null(EntityGuid), graphql_name="guid")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
name = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="name")
permalink = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="permalink"
)
scope_accounts = sgqlc.types.Field(
sgqlc.types.non_null("WorkloadScopeAccounts"), graphql_name="scopeAccounts"
)
status_config = sgqlc.types.Field(
"WorkloadStatusConfig", graphql_name="statusConfig"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
updated_by = sgqlc.types.Field(UserReference, graphql_name="updatedBy")1072. WorkloadEntityRef¶
A reference to a New Relic entity.
Available fields:
guid: The unique entity identifier in New Relic.
class WorkloadEntityRef(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("guid",)
guid = sgqlc.types.Field(EntityGuid, graphql_name="guid")1073. WorkloadEntitySearchQuery¶
An entity search query used to dynamically retrieve a group of entities.
Available fields:
createdAt: The moment when the object was created, represented in milliseconds since the Unix epoch.createdBy: The user who created the entity search query.id: The unique identifier of the entity search query.query: The entity search query that is used to perform the search of a group of entities.updatedAt: The moment when the object was last updated, represented in milliseconds since the Unix epoch.
class WorkloadEntitySearchQuery(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("created_at", "created_by", "id", "query", "updated_at")
created_at = sgqlc.types.Field(
sgqlc.types.non_null(EpochMilliseconds), graphql_name="createdAt"
)
created_by = sgqlc.types.Field(UserReference, graphql_name="createdBy")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")1074. WorkloadRegularRule¶
The definition of a rule, which consists of a group of entities and a rollup strategy.
Available fields:
entities: A list of entity GUIDs. These entities will belong to the collection as long as their accounts are included in the scope accounts of the collection.entitySearchQueries: A list of entity search queries. These queries are constrained to the workload contents.id: The unique identifier of the rule.rollup: The rollup strategy.
class WorkloadRegularRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("entities", "entity_search_queries", "id", "rollup")
entities = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WorkloadEntityRef)),
graphql_name="entities",
)
entity_search_queries = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WorkloadEntitySearchQuery)),
graphql_name="entitySearchQueries",
)
id = sgqlc.types.Field(Int, graphql_name="id")
rollup = sgqlc.types.Field(
sgqlc.types.non_null("WorkloadRollup"), graphql_name="rollup"
)1075. WorkloadRemainingEntitiesRule¶
The definition of a remaining entities rule.
Available fields:
rollup: The rollup strategy.
class WorkloadRemainingEntitiesRule(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("rollup",)
rollup = sgqlc.types.Field(
sgqlc.types.non_null("WorkloadRemainingEntitiesRuleRollup"),
graphql_name="rollup",
)1076. WorkloadRemainingEntitiesRuleRollup¶
The rollup strategy.
Available fields:
groupBy: The grouping to be applied to the remaining entities.strategy: The rollup strategy that is applied to a group of entities.thresholdType: Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.thresholdValue: Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
class WorkloadRemainingEntitiesRuleRollup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("group_by", "strategy", "threshold_type", "threshold_value")
group_by = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadGroupRemainingEntitiesRuleBy),
graphql_name="groupBy",
)
strategy = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadRollupStrategy), graphql_name="strategy"
)
threshold_type = sgqlc.types.Field(
WorkloadRuleThresholdType, graphql_name="thresholdType"
)
threshold_value = sgqlc.types.Field(Int, graphql_name="thresholdValue")1077. WorkloadRollup¶
The rollup strategy.
Available fields:
strategy: The rollup strategy that is applied to the group of entities.thresholdType: Type of threshold defined for the rule. This is an optional field that only applies when strategy is WORST_STATUS_WINS. Use a threshold to roll up the worst status only after a certain amount of entities are not operational.thresholdValue: Threshold value defined for the rule. This optional field is used in combination with thresholdType. If the threshold type is null, the threshold value will be ignored.
class WorkloadRollup(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("strategy", "threshold_type", "threshold_value")
strategy = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadRollupStrategy), graphql_name="strategy"
)
threshold_type = sgqlc.types.Field(
WorkloadRuleThresholdType, graphql_name="thresholdType"
)
threshold_value = sgqlc.types.Field(Int, graphql_name="thresholdValue")1078. WorkloadRollupRuleDetails¶
Represents the details of a rollup rule.
Available fields:
entitySearchQueries: A list of entity search queries defined in the rule.hasIndividualEntities: Indicates if the rule has individual entities.notOperationalEntities: The amount of not operational entities after evaluating the rule.operationalEntities: The amount of operational entities after evaluating the rule.resultingGroupType: The resulting type of the rollup rule.thresholdType: Type of threshold defined for the rule.unknownStatusEntities: The amount of entities the status of which is unknown.
class WorkloadRollupRuleDetails(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = (
"entity_search_queries",
"has_individual_entities",
"not_operational_entities",
"operational_entities",
"resulting_group_type",
"threshold_type",
"unknown_status_entities",
)
entity_search_queries = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="entitySearchQueries",
)
has_individual_entities = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="hasIndividualEntities"
)
not_operational_entities = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="notOperationalEntities"
)
operational_entities = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="operationalEntities"
)
resulting_group_type = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadResultingGroupType),
graphql_name="resultingGroupType",
)
threshold_type = sgqlc.types.Field(
WorkloadRuleThresholdType, graphql_name="thresholdType"
)
unknown_status_entities = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="unknownStatusEntities"
)1079. WorkloadScopeAccounts¶
Accounts that will be used to get entities from.
Available fields:
accountIds: A list of accounts that will be used to get entities from.
class WorkloadScopeAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("account_ids",)
account_ids = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(Int))),
graphql_name="accountIds",
)1080. WorkloadStaticStatus¶
The static status configuration.
Available fields:
description: A description that provides additional details about the status of the workload.enabled: Whether the static status configuration is enabled or not. Note that only one static status can be enabled at a given time.id: The unique identifier of the static status.status: The status of the workload.summary: A short description of the status of the workload.
class WorkloadStaticStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "enabled", "id", "status", "summary")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="id")
status = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadStatusValue), graphql_name="status"
)
summary = sgqlc.types.Field(String, graphql_name="summary")1081. WorkloadStatus¶
Detailed information about the status of a workload.
Available fields:
description: A description that provides additional details about the status of the workload.statusSource: Indicates where the status value derives from.statusValue: The status of the workload.summary: A short description of the status of the workload.
class WorkloadStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "status_source", "status_value", "summary")
description = sgqlc.types.Field(String, graphql_name="description")
status_source = sgqlc.types.Field(WorkloadStatusSource, graphql_name="statusSource")
status_value = sgqlc.types.Field(WorkloadStatusValue, graphql_name="statusValue")
summary = sgqlc.types.Field(String, graphql_name="summary")1082. WorkloadStatusConfig¶
The configuration that defines how the status of the workload is calculated.
Available fields:
automatic: An automatic status configuration.static: A list of static status configurations.
class WorkloadStatusConfig(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("automatic", "static")
automatic = sgqlc.types.Field(WorkloadAutomaticStatus, graphql_name="automatic")
static = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WorkloadStaticStatus)),
graphql_name="static",
)1083. WorkloadValidAccounts¶
All the accounts that user has access to, from the same organization.
Available fields:
accounts: List of accounts from the same organization.
class WorkloadValidAccounts(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("accounts",)
accounts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AccountReference)),
graphql_name="accounts",
)1084. WorkloadWorkloadStatus¶
Status of the workload.
Available fields:
description: A description that provides additional details about the status of the workload.source: Indicates where the status value derives from.statusDetails: The details of the statuses that were involved in the calculation of the workload status.summary: A short description of the status of the workload.value: The status of the workload.
class WorkloadWorkloadStatus(sgqlc.types.Type):
__schema__ = nerdgraph
__field_names__ = ("description", "source", "status_details", "summary", "value")
description = sgqlc.types.Field(String, graphql_name="description")
source = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadStatusSource), graphql_name="source"
)
status_details = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(WorkloadStatusResult)),
graphql_name="statusDetails",
)
summary = sgqlc.types.Field(String, graphql_name="summary")
value = sgqlc.types.Field(
sgqlc.types.non_null(WorkloadStatusValue), graphql_name="value"
)1085. AiIssuesAnomalyIncident¶
Anomaly incident
Available fields:
account: accountaccountIds: An account id this incident is stored inanomalyId: The anomaly idclosedAt: The time the incident was closedcreatedAt: The time the incident was createddescription: The description provided through APIentityGuids: A list of unique entity identifiersentityNames: A list of entity namesentityTypes: A list of entity typesincidentId: Incident identifierpriority: Incident prioritystate: Incident statetimestamp: Incident event timestamptitle: The description the user gave the condition if provided. Otherwise the incident descriptionupdatedAt: The time the incident was last updated
class AiIssuesAnomalyIncident(sgqlc.types.Type, AiIssuesIIncident):
__schema__ = nerdgraph
__field_names__ = ("anomaly_id",)
anomaly_id = sgqlc.types.Field(String, graphql_name="anomalyId")1086. AiIssuesNewRelicIncident¶
Newrelic incident
Available fields:
account: accountaccountIds: An account id this incident is stored inclosedAt: The time the incident was closedconditionFamilyId: The condition idcreatedAt: The time the incident was createddescription: The description is generated from the policy name and the condition nameentityGuids: A list of unique entity identifiersentityNames: A list of entity namesentityTypes: A list of entity typesincidentId: Incident identifierpolicyIds: The policy idpriority: Incident prioritystate: Incident statetimestamp: Incident event timestamptitle: The description the user gave the condition if provided. Otherwise the incident descriptionupdatedAt: The time the incident was last updated
class AiIssuesNewRelicIncident(sgqlc.types.Type, AiIssuesIIncident):
__schema__ = nerdgraph
__field_names__ = ("condition_family_id", "policy_ids")
condition_family_id = sgqlc.types.Field(String, graphql_name="conditionFamilyId")
policy_ids = sgqlc.types.Field(String, graphql_name="policyIds")1087. AiIssuesRestIncident¶
Rest incident
Available fields:
account: accountaccountIds: An account id this incident is stored inaggregationTags: Aggregation of tags related to this incidentclosedAt: The time the incident was closedcreatedAt: The time the incident was createddescription: The description provided through APIentityGuids: A list of unique entity identifiersentityNames: A list of entity namesentityTypes: A list of entity typesincidentId: Incident identifierpriority: Incident prioritystate: Incident statetimestamp: Incident event timestamptitle: The description the user gave the condition if provided. Otherwise the incident descriptionupdatedAt: The time the incident was last updated
class AiIssuesRestIncident(sgqlc.types.Type, AiIssuesIIncident):
__schema__ = nerdgraph
__field_names__ = ("aggregation_tags",)
aggregation_tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AiIssuesKeyValue)),
graphql_name="aggregationTags",
)1088. AiWorkflowsBatchCreateMigratedWorkflowsResponseError¶
Batch create migrated workflows error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsBatchCreateMigratedWorkflowsResponseError(
sgqlc.types.Type, AiWorkflowsResponseError
):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsBatchCreateMigratedWorkflowsErrorType),
graphql_name="type",
)1089. AiWorkflowsBatchDeleteMigratedWorkflowsResponseError¶
Batch delete migrated workflows error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsBatchDeleteMigratedWorkflowsResponseError(
sgqlc.types.Type, AiWorkflowsResponseError
):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsBatchDeleteMigratedWorkflowsErrorType),
graphql_name="type",
)1090. AiWorkflowsCreateResponseError¶
Create error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsCreateResponseError(sgqlc.types.Type, AiWorkflowsResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsCreateErrorType), graphql_name="type"
)1091. AiWorkflowsDeleteResponseError¶
Delete error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsDeleteResponseError(sgqlc.types.Type, AiWorkflowsResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsDeleteErrorType), graphql_name="type"
)1092. AiWorkflowsFetchWorkflowsByIssuesFilterResponseError¶
Fetch workflows by issues filter error
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsFetchWorkflowsByIssuesFilterResponseError(
sgqlc.types.Type, AiWorkflowsResponseError
):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsFetchWorkflowsByIssuesFilterErrorType),
graphql_name="type",
)1093. AiWorkflowsSaveTeamWorkflowConfigurationError¶
Save team workflow configuration error
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsSaveTeamWorkflowConfigurationError(
sgqlc.types.Type, AiWorkflowsResponseError
):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsSaveTeamWorkflowConfigurationErrorType),
graphql_name="type",
)1094. AiWorkflowsTestResponseError¶
Test error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsTestResponseError(sgqlc.types.Type, AiWorkflowsResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsTestErrorType), graphql_name="type"
)1095. AiWorkflowsUpdateResponseError¶
Update error description
Available fields:
description: The error descriptiontype: The error type
class AiWorkflowsUpdateResponseError(sgqlc.types.Type, AiWorkflowsResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(AiWorkflowsUpdateErrorType), graphql_name="type"
)1096. AlertsAsNrqlBaselineCondition¶
A baseline NRQL condition is a self-adjusting condition based on the past behavior of a monitored NRQL query.
Available fields:
baselineDirection: Direction in which the baseline is set on condition.createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedsignalSeasonality: Seasonality under which the condition’s signal(s) are evaluated. If set toNEW_RELIC_CALCULATIONornull, seasonality defaults to being calculated by New Relic. If set toNONE, no seasonality is taken into consideration.sourceProduct: A type of Product that the asNrql condition was converted from.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsAsNrqlBaselineCondition(sgqlc.types.Type, AlertsAsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ("baseline_direction", "signal_seasonality")
baseline_direction = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlBaselineDirection),
graphql_name="baselineDirection",
)
signal_seasonality = sgqlc.types.Field(
AlertsNrqlSignalSeasonality, graphql_name="signalSeasonality"
)1097. AlertsAsNrqlOutlierCondition¶
An outlier NRQL condition looks for group behavior and values that are outliers from those groups. Similar to a static NRQL condition, but requires a FACET clause.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpectedGroups: Number of groups expected in the returned values for the condition.expiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.openViolationOnGroupOverlap: Whether overlapping groups should produce a violation.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedsourceProduct: A type of Product that the asNrql condition was converted from.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsAsNrqlOutlierCondition(sgqlc.types.Type, AlertsAsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ("expected_groups", "open_violation_on_group_overlap")
expected_groups = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="expectedGroups"
)
open_violation_on_group_overlap = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="openViolationOnGroupOverlap"
)1098. AlertsAsNrqlStaticCondition¶
A static NRQL condition is the simplest type of NRQL threshold. It allows you to create a condition based on a NRQL query that returns a numeric value.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedsourceProduct: A type of Product that the asNrql condition was converted from.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsAsNrqlStaticCondition(sgqlc.types.Type, AlertsAsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ()1099. AlertsCampfireNotificationChannel¶
Campfire notification channel.
Available fields:
class AlertsCampfireNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ()1100. AlertsEmailNotificationChannel¶
Email notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: Email channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsEmailNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsEmailNotificationChannelConfig),
graphql_name="config",
)1101. AlertsHipChatNotificationChannel¶
HipChat notification channel.
Available fields:
class AlertsHipChatNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ()1102. AlertsNrqlBaselineCondition¶
A baseline NRQL condition is a self-adjusting condition based on the past behavior of a monitored NRQL query.
Available fields:
baselineDirection: Direction in which the baseline is set on condition.createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedsignalSeasonality: Seasonality under which the condition’s signal(s) are evaluated. If set toNEW_RELIC_CALCULATIONornull, seasonality defaults to being calculated by New Relic. If set toNONE, no seasonality is taken into consideration.targetEntity: BETA PREVIEW: ThetargetEntityfield is in limited release. The entity explicitly targeted by the condition.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsNrqlBaselineCondition(sgqlc.types.Type, AlertsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ("baseline_direction", "signal_seasonality")
baseline_direction = sgqlc.types.Field(
sgqlc.types.non_null(AlertsNrqlBaselineDirection),
graphql_name="baselineDirection",
)
signal_seasonality = sgqlc.types.Field(
AlertsNrqlSignalSeasonality, graphql_name="signalSeasonality"
)1103. AlertsNrqlConditionTerms¶
NRQL condition terms determine when a violation will be opened.
Available fields:
disableHealthStatusReporting: Violations will not change system health status for this term.operator: Operator used to compare against the threshold.priority: Priority determines how much attention your incidents need. Your workflow settings then tell us when and where to send notifications for different priorities.threshold: Value that triggers a violation.thresholdDuration: Duration, in seconds, that the condition must violate the threshold before creating a violation.thresholdOccurrences: How many data points must be in violation for the specified threshold duration.
class AlertsNrqlConditionTerms(sgqlc.types.Type, AlertsNrqlTerms):
__schema__ = nerdgraph
__field_names__ = ()1104. AlertsNrqlConditionTermsWithPrediction¶
NRQL condition terms expanded to include prediction.
Available fields:
disableHealthStatusReporting: Violations will not change system health status for this term.operator: Operator used to compare against the threshold.prediction: Thepredictionfield is used to open alerts when your static threshold is predicted to be reached in the future.
Note that the predictive alerts feature are available only to Advanced Compute customers.
priority: Priority determines how much attention your incidents need. Your workflow settings then tell us when and where to send notifications for different priorities.threshold: Value that triggers a violation.thresholdDuration: Duration, in seconds, that the condition must violate the threshold before creating a violation.thresholdOccurrences: How many data points must be in violation for the specified threshold duration.
class AlertsNrqlConditionTermsWithPrediction(sgqlc.types.Type, AlertsNrqlTerms):
__schema__ = nerdgraph
__field_names__ = ("prediction",)
prediction = sgqlc.types.Field(
AlertsNrqlConditionPrediction, graphql_name="prediction"
)1105. AlertsNrqlOutlierCondition¶
An outlier NRQL condition looks for group behavior and values that are outliers from those groups. Similar to a static NRQL condition, but requires a FACET clause.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.outlierConfiguration: Configuration that defines the outlier detection settings for the NRQL condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedtargetEntity: BETA PREVIEW: ThetargetEntityfield is in limited release. The entity explicitly targeted by the condition.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsNrqlOutlierCondition(sgqlc.types.Type, AlertsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ("outlier_configuration",)
outlier_configuration = sgqlc.types.Field(
sgqlc.types.non_null(AlertsOutlierConfiguration),
graphql_name="outlierConfiguration",
)1106. AlertsNrqlStaticCondition¶
A static NRQL condition is the simplest type of NRQL threshold. It allows you to create a condition based on a NRQL query that returns a numeric value.
Available fields:
createdAt: The timestamp for when the condition was createdcreatedBy: The actor who created the conditiondescription: The custom violation description.enabled: Whether the condition is enabled.entity: The Entity associated with the NRQL ConditionentityGuid: The condition’s entity GUIDexpiration: Also known as loss of signal, these are settings for how violations are opened or closed when a signal expires.id: Condition ID.name: Name of the condition.nrql: The NRQL query that defines the signal for the condition.policyId: Alerts policy ID.runbookUrl: Runbook URL.signal: Settings that determine how the NRQL results are evaluatedtargetEntity: BETA PREVIEW: ThetargetEntityfield is in limited preview. The entity explicitly targeted by the condition.terms: List of critical and warning terms for the condition.titleTemplate: This field allows you to create a custom title to be used when incidents are opened by the condition. Setting this field will override the default title. Must be Handlebars format.type: Type of NRQL condition.updatedAt: The timestamp of the most recent update to the conditionupdatedBy: The actor for the most recent condition updateviolationTimeLimitSeconds: Duration after which a violation automatically closes in seconds.
class AlertsNrqlStaticCondition(sgqlc.types.Type, AlertsNrqlCondition):
__schema__ = nerdgraph
__field_names__ = ()1107. AlertsOpsGenieNotificationChannel¶
OpsGenie notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: OpsGenie channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsOpsGenieNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsOpsGenieNotificationChannelConfig),
graphql_name="config",
)1108. AlertsOutlierDbScanConfiguration¶
Represents the complete configuration for an outlier detection condition using the DBSCAN algorithm. It includes both the common fields and algorithm-specific parameters.
Available fields:
algorithm: The name of the algorithm. For this type, it will always be ‘DBSCAN’.epsilon: The maximum distance between two samples for one to be considered as in the neighborhood of the other.evaluationGroupFacet: The facet name to pre-group data by before applying the outlier detection algorithm. If not specified, the algorithm is applied to all returned data.minimumPoints: The number of samples in a neighborhood for a point to be considered a core point.
class AlertsOutlierDbScanConfiguration(sgqlc.types.Type, AlertsOutlierConfiguration):
__schema__ = nerdgraph
__field_names__ = ("epsilon", "minimum_points")
epsilon = sgqlc.types.Field(Float, graphql_name="epsilon")
minimum_points = sgqlc.types.Field(Int, graphql_name="minimumPoints")1109. AlertsPagerDutyNotificationChannel¶
PagerDuty notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: PagerDuty channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsPagerDutyNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsPagerDutyNotificationChannelConfig),
graphql_name="config",
)1110. AlertsSlackNotificationChannel¶
Slack notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: Slack channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsSlackNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsSlackNotificationChannelConfig),
graphql_name="config",
)1111. AlertsUserNotificationChannel¶
User notification channel.
Available fields:
class AlertsUserNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ()1112. AlertsVictorOpsNotificationChannel¶
VictorOps notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: VictorOps channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsVictorOpsNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsVictorOpsNotificationChannelConfig),
graphql_name="config",
)1113. AlertsWebhookNotificationChannel¶
Webhook notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: Webhook channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsWebhookNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsWebhookNotificationChannelConfig),
graphql_name="config",
)1114. AlertsXMattersNotificationChannel¶
xMatters notification channel.
Available fields:
associatedPolicies: Policies associated with the channel.config: xMatters channel specific configuration.id: Channel ID.name: Channel name.type: Channel type.
class AlertsXMattersNotificationChannel(sgqlc.types.Type, AlertsNotificationChannel):
__schema__ = nerdgraph
__field_names__ = ("config",)
config = sgqlc.types.Field(
sgqlc.types.non_null(AlertsXMattersNotificationChannelConfig),
graphql_name="config",
)1115. ApiAccessIngestKey¶
An ingest key.
Available fields:
account: The account this key is in.accountId: The account attached to the ingest key. Agents using this key will report to the account the key belongs to.createdAt: The UNIX epoch when the key was created, in seconds.id: The ID of the ingest key. This can be used to identify a key without revealing the key itself (used to update and delete).ingestType: The type of ingest key, which dictates what types of agents can use it to report.key: The keystring of the key.name: The name of the key. Limited to 120 characters.notes: Any notes can be attached to an key. Limited to 120 characters.obfuscatedKey: The obfuscated key.type: The type of key, indicating what New Relic APIs it can be used to access.
class ApiAccessIngestKey(sgqlc.types.Type, ApiAccessKey):
__schema__ = nerdgraph
__field_names__ = ("account", "account_id", "ingest_type")
account = sgqlc.types.Field(AccountReference, graphql_name="account")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
ingest_type = sgqlc.types.Field(ApiAccessIngestKeyType, graphql_name="ingestType")1116. ApiAccessIngestKeyError¶
An ingest key error. Each error maps to a single key input.
Available fields:
accountId: The account ID of the key.errorType: The error type of the error.id: Theidof the key being updated.ingestType: The ingest type of the key.message: A message about why the key creation failed.type: The type of the key.
class ApiAccessIngestKeyError(sgqlc.types.Type, ApiAccessKeyError):
__schema__ = nerdgraph
__field_names__ = ("account_id", "error_type", "id", "ingest_type")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
error_type = sgqlc.types.Field(
ApiAccessIngestKeyErrorType, graphql_name="errorType"
)
id = sgqlc.types.Field(String, graphql_name="id")
ingest_type = sgqlc.types.Field(ApiAccessIngestKeyType, graphql_name="ingestType")1117. ApiAccessUserKey¶
A user key.
Available fields:
account: The account this key is in.accountId: The account ID of the key.createdAt: The UNIX epoch when the key was created, in seconds.id: The ID of the user key. This can be used to identify a key without revealing the key itself (used to update and delete).key: The keystring of the key.name: The name of the key. Limited to 120 characters.notes: Any notes can be attached to a key. Limited to 120 characters.obfuscatedKey: The obfuscated key.type: The type of key, indicating what New Relic APIs it can be used to access.user: The user this key belongs to.userId: The user ID of the key.
class ApiAccessUserKey(sgqlc.types.Type, ApiAccessKey):
__schema__ = nerdgraph
__field_names__ = ("account", "account_id", "user", "user_id")
account = sgqlc.types.Field(AccountReference, graphql_name="account")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
user = sgqlc.types.Field(UserReference, graphql_name="user")
user_id = sgqlc.types.Field(Int, graphql_name="userId")1118. ApiAccessUserKeyError¶
A user key error. Each error maps to a single key input.
Available fields:
accountId: The account ID of the key.errorType: The error type of the error.id: Theidof the key being updated.message: A message about why the key creation failed.type: The type of the key.userId: The user ID of the key.
class ApiAccessUserKeyError(sgqlc.types.Type, ApiAccessKeyError):
__schema__ = nerdgraph
__field_names__ = ("account_id", "error_type", "id", "user_id")
account_id = sgqlc.types.Field(Int, graphql_name="accountId")
error_type = sgqlc.types.Field(ApiAccessUserKeyErrorType, graphql_name="errorType")
id = sgqlc.types.Field(String, graphql_name="id")
user_id = sgqlc.types.Field(Int, graphql_name="userId")1119. ApmApplicationEntity¶
An APM Application entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.apmBrowserSummary: Summary statistics about the Browser App injected by an APM Application.apmSettings: Settings that are common across APM applications.apmSummary: Summary statistics about the APM App.applicationId: The ID of the APM Application.applicationInstances: List of APM application instances.applicationInstancesV2: Paginated list of APM application instances.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.exception: An Exception that occurred in your Application.firstIndexedAt: The date of last time the entity has updated any of its fields.flamegraph: Retrieves a flamegraph for the specific entity over the time period specified.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.language: The programming language of the APM Application.lastReportingChangeAt: The last time the entity’s reporting status changed.metricGroupingIssues: Retrieves the entity metric grouping issues.metricNormalizationRule: Retrieves a rule.metricNormalizationRules: Retrieves the rules for the application.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runningAgentVersions: The running versions of the language agent in the APM Application.serviceLevel: The service level defined for the entity.settings: Configuration settings for the APM Applicationtags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class ApmApplicationEntity(
sgqlc.types.Type, AlertableEntity, ApmBrowserApplicationEntity, Entity
):
__schema__ = nerdgraph
__field_names__ = (
"apm_settings",
"apm_summary",
"application_id",
"application_instances",
"application_instances_v2",
"exception",
"flamegraph",
"language",
"metric_grouping_issues",
"metric_normalization_rule",
"metric_normalization_rules",
"running_agent_versions",
"settings",
)
apm_settings = sgqlc.types.Field(
AgentApplicationSettingsApmBase, graphql_name="apmSettings"
)
apm_summary = sgqlc.types.Field(
ApmApplicationSummaryData, graphql_name="apmSummary"
)
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
application_instances = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(AgentEnvironmentApplicationInstance)),
graphql_name="applicationInstances",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="endTime", default=None
),
),
("host", sgqlc.types.Arg(String, graphql_name="host", default=None)),
(
"start_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="startTime", default=None
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds`): Time window start time in
milliseconds since the unix epoch on which the agent reported
data. Defaults to current time.
* `host` (`String`): Use this field to filter application
instances by host name.
* `start_time` (`EpochMilliseconds`): Time window start time in
milliseconds since the unix epoch on which the agent reported
data. Defaults to 10 minutes before the current time.
"""
application_instances_v2 = sgqlc.types.Field(
sgqlc.types.non_null(AgentEnvironmentApplicationInstancesResult),
graphql_name="applicationInstancesV2",
args=sgqlc.types.ArgDict(
(("cursor", sgqlc.types.Arg(String, graphql_name="cursor", default=None)),)
),
)
exception = sgqlc.types.Field(
StackTraceApmException,
graphql_name="exception",
args=sgqlc.types.ArgDict(
(
(
"occurrence_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="occurrenceId",
default=None,
),
),
)
),
)
"""Arguments:
* `occurrence_id` (`String!`): A unique exception identifier.
"""
flamegraph = sgqlc.types.Field(
JavaFlightRecorderFlamegraph,
graphql_name="flamegraph",
args=sgqlc.types.ArgDict(
(
(
"host_name",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="hostName",
default=None,
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `host_name` (`String!`): The JVM host to get flamegraph stack
trace events for
* `time_window` (`TimeWindowInput`): The start and end of the
flamegraph events. Defaults to last 30 minutes
"""
language = sgqlc.types.Field(String, graphql_name="language")
metric_grouping_issues = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(MetricNormalizationRuleMetricGroupingIssue)
),
graphql_name="metricGroupingIssues",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="endTime", default=None
),
),
(
"metric_normalization_rule_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(Int),
graphql_name="metricNormalizationRuleIds",
default=None,
),
),
(
"start_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="startTime", default=None
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds`): End time.
* `metric_normalization_rule_ids` (`[Int]`): Metric normalization
rule ids
* `start_time` (`EpochMilliseconds`): Start time.
"""
metric_normalization_rule = sgqlc.types.Field(
MetricNormalizationRule,
graphql_name="metricNormalizationRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
metric_normalization_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(MetricNormalizationRule)),
graphql_name="metricNormalizationRules",
args=sgqlc.types.ArgDict(
(
(
"enabled",
sgqlc.types.Arg(Boolean, graphql_name="enabled", default=None),
),
)
),
)
running_agent_versions = sgqlc.types.Field(
ApmApplicationRunningAgentVersions, graphql_name="runningAgentVersions"
)
settings = sgqlc.types.Field(ApmApplicationSettings, graphql_name="settings")1120. ApmApplicationEntityOutline¶
An APM Application entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.apmBrowserSummary: Summary statistics about the Browser App injected by an APM Application.apmSummary: Summary statistics about the APM App.applicationId: The ID of the APM Application.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.language: The programming language of the APM Application.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runningAgentVersions: The running versions of the language agent in the APM Application.serviceLevel: The service level defined for the entity.settings: Configuration settings for the APM Applicationtags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class ApmApplicationEntityOutline(
sgqlc.types.Type,
AlertableEntityOutline,
ApmBrowserApplicationEntityOutline,
EntityOutline,
):
__schema__ = nerdgraph
__field_names__ = (
"apm_summary",
"application_id",
"language",
"running_agent_versions",
"settings",
)
apm_summary = sgqlc.types.Field(
ApmApplicationSummaryData, graphql_name="apmSummary"
)
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
language = sgqlc.types.Field(String, graphql_name="language")
running_agent_versions = sgqlc.types.Field(
ApmApplicationRunningAgentVersions, graphql_name="runningAgentVersions"
)
settings = sgqlc.types.Field(ApmApplicationSettings, graphql_name="settings")1121. ApmDatabaseInstanceEntity¶
A database instance seen by an APM Application
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.host: The host the database instance is running on.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.portOrPath: The port or path the database instance is running on. ex:3306|/tmp/mysql.sockrecentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s typevendor: The type of database. ex:Postgres|Redis
class ApmDatabaseInstanceEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ("host", "port_or_path", "vendor")
host = sgqlc.types.Field(String, graphql_name="host")
port_or_path = sgqlc.types.Field(String, graphql_name="portOrPath")
vendor = sgqlc.types.Field(String, graphql_name="vendor")1122. ApmDatabaseInstanceEntityOutline¶
A database instance seen by an APM Application
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.host: The host the database instance is running on.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.portOrPath: The port or path the database instance is running on. ex:3306|/tmp/mysql.sockreporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s typevendor: The type of database. ex:Postgres|Redis
class ApmDatabaseInstanceEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ("host", "port_or_path", "vendor")
host = sgqlc.types.Field(String, graphql_name="host")
port_or_path = sgqlc.types.Field(String, graphql_name="portOrPath")
vendor = sgqlc.types.Field(String, graphql_name="vendor")1123. ApmExternalServiceEntity¶
An external service seen by an APM Application.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.host: The host of the external service.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class ApmExternalServiceEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ("host",)
host = sgqlc.types.Field(String, graphql_name="host")1124. ApmExternalServiceEntityOutline¶
An external service seen by an APM Application.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.host: The host of the external service.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class ApmExternalServiceEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ("host",)
host = sgqlc.types.Field(String, graphql_name="host")1125. BrowserApplicationEntity¶
A Browser Application entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.agentInstallType: The type of Browser agent installed for this application.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.applicationId: The ID of the Browser App.browserProperties: Access general properties for the application.browserSettings: Settings that are common across browser applications.browserSummary: Summary statistics about the Browser App.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.exception: An Exception that occurred in your Browser Application.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.metricGroupingIssues: Retrieves the entity metric grouping issues.metricNormalizationRule: Retrieves a rulemetricNormalizationRules: Retrieves the rules for the application.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runningAgentVersions: The running versions of the agent in the Browser App.segmentAllowListAggregate: The allow list for browser applications that contains a set of allowed url segments that will appear in groupings on the Page views and AJAX pages.serviceLevel: The service level defined for the entity.servingApmApplicationId: The ID of the APM Application that serves this Browser App.settings: Configuration settings for the Browser Apptags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class BrowserApplicationEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"agent_install_type",
"application_id",
"browser_properties",
"browser_settings",
"browser_summary",
"exception",
"metric_grouping_issues",
"metric_normalization_rule",
"metric_normalization_rules",
"running_agent_versions",
"segment_allow_list_aggregate",
"serving_apm_application_id",
"settings",
)
agent_install_type = sgqlc.types.Field(
BrowserAgentInstallType, graphql_name="agentInstallType"
)
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
browser_properties = sgqlc.types.Field(
AgentApplicationSettingsBrowserProperties, graphql_name="browserProperties"
)
browser_settings = sgqlc.types.Field(
AgentApplicationSettingsBrowserBase, graphql_name="browserSettings"
)
browser_summary = sgqlc.types.Field(
BrowserApplicationSummaryData, graphql_name="browserSummary"
)
exception = sgqlc.types.Field(
StackTraceBrowserException,
graphql_name="exception",
args=sgqlc.types.ArgDict(
(
(
"fingerprint",
sgqlc.types.Arg(
sgqlc.types.non_null(Int),
graphql_name="fingerprint",
default=None,
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `fingerprint` (`Int!`): A unique exception identifier.
* `time_window` (`TimeWindowInput`): The time window (60 minutes
maximum) in which to search for the browser exception. Defaults
to standard NRQL query window.
"""
metric_grouping_issues = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(MetricNormalizationRuleMetricGroupingIssue)
),
graphql_name="metricGroupingIssues",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="endTime", default=None
),
),
(
"metric_normalization_rule_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(Int),
graphql_name="metricNormalizationRuleIds",
default=None,
),
),
(
"start_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="startTime", default=None
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds`): End time.
* `metric_normalization_rule_ids` (`[Int]`): Metric normalization
rule ids
* `start_time` (`EpochMilliseconds`): Start time.
"""
metric_normalization_rule = sgqlc.types.Field(
MetricNormalizationRule,
graphql_name="metricNormalizationRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
metric_normalization_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(MetricNormalizationRule)),
graphql_name="metricNormalizationRules",
args=sgqlc.types.ArgDict(
(
(
"enabled",
sgqlc.types.Arg(Boolean, graphql_name="enabled", default=None),
),
)
),
)
running_agent_versions = sgqlc.types.Field(
BrowserApplicationRunningAgentVersions, graphql_name="runningAgentVersions"
)
segment_allow_list_aggregate = sgqlc.types.Field(
AgentApplicationSegmentsBrowserSegmentAllowList,
graphql_name="segmentAllowListAggregate",
args=sgqlc.types.ArgDict(
(
(
"filters",
sgqlc.types.Arg(
AgentApplicationSegmentsSegmentAllowListFilters,
graphql_name="filters",
default=None,
),
),
)
),
)
serving_apm_application_id = sgqlc.types.Field(
Int, graphql_name="servingApmApplicationId"
)
settings = sgqlc.types.Field(BrowserApplicationSettings, graphql_name="settings")1126. BrowserApplicationEntityOutline¶
A Browser Application entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.agentInstallType: The type of Browser agent installed for this application.alertSeverity: The current alerting severity of the entity.applicationId: The ID of the Browser App.browserSummary: Summary statistics about the Browser App.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runningAgentVersions: The running versions of the agent in the Browser App.serviceLevel: The service level defined for the entity.servingApmApplicationId: The ID of the APM Application that serves this Browser App.settings: Configuration settings for the Browser Apptags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class BrowserApplicationEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = (
"agent_install_type",
"application_id",
"browser_summary",
"running_agent_versions",
"serving_apm_application_id",
"settings",
)
agent_install_type = sgqlc.types.Field(
BrowserAgentInstallType, graphql_name="agentInstallType"
)
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
browser_summary = sgqlc.types.Field(
BrowserApplicationSummaryData, graphql_name="browserSummary"
)
running_agent_versions = sgqlc.types.Field(
BrowserApplicationRunningAgentVersions, graphql_name="runningAgentVersions"
)
serving_apm_application_id = sgqlc.types.Field(
Int, graphql_name="servingApmApplicationId"
)
settings = sgqlc.types.Field(BrowserApplicationSettings, graphql_name="settings")1127. ChangeTrackingDeploymentEvent¶
A change tracking event with a category of “Deployment”.
Available fields:
category: The category of change eventcategoryAndType: The categoryType of change eventchangeTrackingId: A unique change tracking identifier.changelog: A URL to the changelog or, if not linkable, a list of changes.commit: The commit identifier, for example, a Git commit SHA.customAttributes: Represents key-value pairs of custom attributes in JSON format.deepLink: A link to the system that generated the deployment.description: A description of the event.entity: The NR entity associated with the event.groupId: An identifier used to correlate account-wide changes across entities. These changes are shown together in theChanges in groupsection of the change event details UI.shortDescription: This field allows you to add your own context to help you quickly identify the change events sent to our system. This field should contain a concise description of the change suitable for showing in various parts of New Relic One:
In the marker flag, shown when hovering over the pinhead of a “Changes” marker on a chart.
In the “Activity stream” panels.
If this field is left blank sensible defaults will be shown instead.
To see an example of how the shortDescription appears in change markers, see the optional attributes section of our docs.
timestamp: The start time of the change tracking event as the number of milliseconds since the Unix epoch. Defaults to now.type: The type of the change eventuser: The name or identifier of the person responsible for the change.version: The version of the deployed software, for example, something like v1.1.
class ChangeTrackingDeploymentEvent(sgqlc.types.Type, ChangeTrackingEvent):
__schema__ = nerdgraph
__field_names__ = ("changelog", "commit", "deep_link", "version")
changelog = sgqlc.types.Field(String, graphql_name="changelog")
commit = sgqlc.types.Field(String, graphql_name="commit")
deep_link = sgqlc.types.Field(String, graphql_name="deepLink")
version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="version")1128. ChangeTrackingFeatureFlagEvent¶
A change tracking event with a category of “Feature Flag”.
Available fields:
category: The category of change eventcategoryAndType: The categoryType of change eventchangeTrackingId: A unique change tracking identifier.customAttributes: Represents key-value pairs of custom attributes in JSON format.description: A description of the event.entity: The NR entity associated with the event.featureFlagId: The name of the feature flag.groupId: An identifier used to correlate account-wide changes across entities. These changes are shown together in theChanges in groupsection of the change event details UI.shortDescription: This field allows you to add your own context to help you quickly identify the change events sent to our system. This field should contain a concise description of the change suitable for showing in various parts of New Relic One:
In the marker flag, shown when hovering over the pinhead of a “Changes” marker on a chart.
In the “Activity stream” panels.
If this field is left blank sensible defaults will be shown instead.
To see an example of how the shortDescription appears in change markers, see the optional attributes section of our docs.
timestamp: The start time of the change tracking event as the number of milliseconds since the Unix epoch. Defaults to now.type: The type of the change eventuser: The name or identifier of the person responsible for the change.
class ChangeTrackingFeatureFlagEvent(sgqlc.types.Type, ChangeTrackingEvent):
__schema__ = nerdgraph
__field_names__ = ("feature_flag_id",)
feature_flag_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="featureFlagId"
)1129. ChangeTrackingGenericEvent¶
A generic change tracking event.
Available fields:
category: The category of change eventcategoryAndType: The categoryType of change eventchangeTrackingId: A unique change tracking identifier.customAttributes: Represents key-value pairs of custom attributes in JSON format.description: A description of the event.entity: The NR entity associated with the event.groupId: An identifier used to correlate account-wide changes across entities. These changes are shown together in theChanges in groupsection of the change event details UI.shortDescription: This field allows you to add your own context to help you quickly identify the change events sent to our system. This field should contain a concise description of the change suitable for showing in various parts of New Relic One:
In the marker flag, shown when hovering over the pinhead of a “Changes” marker on a chart.
In the “Activity stream” panels.
If this field is left blank sensible defaults will be shown instead.
To see an example of how the shortDescription appears in change markers, see the optional attributes section of our docs.
timestamp: The start time of the change tracking event as the number of milliseconds since the Unix epoch. Defaults to now.type: The type of the change eventuser: The name or identifier of the person responsible for the change.
class ChangeTrackingGenericEvent(sgqlc.types.Type, ChangeTrackingEvent):
__schema__ = nerdgraph
__field_names__ = ()1130. CloudAlbIntegration¶
ALB/NLB Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.loadBalancerPrefixes: Specify each name or prefix for the LBs that you want to monitor. Filter values are case-sensitive.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudAlbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"fetch_tags",
"load_balancer_prefixes",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
load_balancer_prefixes = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="loadBalancerPrefixes"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1131. CloudApigatewayIntegration¶
API Gateway Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.stagePrefixes: Specify each name or prefix for the Stages that you want to monitor. Filter values are case-sensitive.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudApigatewayIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"metrics_polling_interval",
"stage_prefixes",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
stage_prefixes = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="stagePrefixes"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1132. CloudAutoscalingIntegration¶
AutoScaling Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAutoscalingIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1133. CloudAwsAppsyncIntegration¶
AppSync Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsAppsyncIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1134. CloudAwsAthenaIntegration¶
Athena Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsAthenaIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1135. CloudAwsAutoDiscoveryIntegration¶
AwsAutoDiscovery Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsAutoDiscoveryIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1136. CloudAwsCognitoIntegration¶
Cognito Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsCognitoIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1137. CloudAwsConnectIntegration¶
Connect Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsConnectIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1138. CloudAwsDirectconnectIntegration¶
Direct Connect Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsDirectconnectIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1139. CloudAwsDocdbIntegration¶
DocumentDB Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsDocdbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1140. CloudAwsEuSovereignProvider¶
The Amazon Web Services cloud provider (EU Sovereign Cloud)
Available fields:
awsAccountId: The AWS Account IDcreatedAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.service: Get details of one cloud provider service.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsEuSovereignProvider(sgqlc.types.Type, CloudProvider):
__schema__ = nerdgraph
__field_names__ = ("aws_account_id",)
aws_account_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="awsAccountId"
)1141. CloudAwsFsxIntegration¶
FSx Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsFsxIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1142. CloudAwsGlueIntegration¶
Glue Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsGlueIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1143. CloudAwsGovCloudProvider¶
The Amazon Web Services cloud provider (GovCloud)
Available fields:
awsAccountId: The AWS Account IDcreatedAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.service: Get details of one cloud provider service.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsGovCloudProvider(sgqlc.types.Type, CloudProvider):
__schema__ = nerdgraph
__field_names__ = ("aws_account_id",)
aws_account_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="awsAccountId"
)1144. CloudAwsKinesisanalyticsIntegration¶
Kinesis Data Analytics Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsKinesisanalyticsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1145. CloudAwsMediaconvertIntegration¶
Elemental MediaConvert Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMediaconvertIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1146. CloudAwsMediapackagevodIntegration¶
MediaPackage VOD Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMediapackagevodIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1147. CloudAwsMetadataEuSovereignIntegration¶
Fetch Metadata for AWS EU Sovereign integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMetadataEuSovereignIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1148. CloudAwsMetadataGovIntegration¶
Fetch Metadata for AWS integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMetadataGovIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1149. CloudAwsMetadataIntegration¶
Fetch Metadata for AWS integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMetadataIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1150. CloudAwsMqIntegration¶
MQ Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMqIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1151. CloudAwsMsElasticacheEuSovereignIntegration¶
Fetch ElastiCache EU Sovereign entities Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMsElasticacheEuSovereignIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1152. CloudAwsMsElasticacheGovIntegration¶
Fetch ElastiCache entities Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMsElasticacheGovIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1153. CloudAwsMsElasticacheIntegration¶
Fetch ElastiCache Gov entities Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMsElasticacheIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1154. CloudAwsMskIntegration¶
Managed Kafka Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsMskIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1155. CloudAwsNeptuneIntegration¶
Neptune Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsNeptuneIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1156. CloudAwsProvider¶
The Amazon Web Services cloud provider
Available fields:
createdAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.roleAccountId: The New Relic AWS Account ID that will use the Role.roleExternalId: The external ID required to assume the Role by the New Relic Account.service: Get details of one cloud provider service.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsProvider(sgqlc.types.Type, CloudProvider):
__schema__ = nerdgraph
__field_names__ = ("role_account_id", "role_external_id")
role_account_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="roleAccountId"
)
role_external_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="roleExternalId"
)1157. CloudAwsQldbIntegration¶
QLDB Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsQldbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1158. CloudAwsRoute53resolverIntegration¶
Route53 Resolver Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsRoute53resolverIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1159. CloudAwsStatesIntegration¶
Step Functions Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsStatesIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1160. CloudAwsTagsGlobalEuSovereignIntegration¶
Fetch tags for all AWS EU Sovereign integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsTagsGlobalEuSovereignIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1161. CloudAwsTagsGlobalGovIntegration¶
Fetch tags Gov for all integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsTagsGlobalGovIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1162. CloudAwsTagsGlobalIntegration¶
Fetch tags for all integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsTagsGlobalIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1163. CloudAwsTransitgatewayIntegration¶
Transit Gateway Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsTransitgatewayIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1164. CloudAwsWafIntegration¶
WAF Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsWafIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1165. CloudAwsWafv2Integration¶
WAFV2 Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsWafv2Integration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1166. CloudAwsXrayIntegration¶
X-Ray Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAwsXrayIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1167. CloudAzureApimanagementIntegration¶
Api Management Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureApimanagementIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1168. CloudAzureAppgatewayIntegration¶
App Gateway Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureAppgatewayIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1169. CloudAzureAppserviceIntegration¶
App Service Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureAppserviceIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1170. CloudAzureAutoDiscoveryIntegration¶
Azure Auto Discover Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeenabled: Specify if integration is activeid: The cloud service integration identifier.inventoryPollingInterval: The polling interval for metadata and tags, in seconds.linkedAccount: The parent linked account identifier.metricsPollingInterval: The polling interval for metrics, in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureAutoDiscoveryIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"enabled",
"inventory_polling_interval",
"metrics_polling_interval",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
inventory_polling_interval = sgqlc.types.Field(
Int, graphql_name="inventoryPollingInterval"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1171. CloudAzureContainersIntegration¶
Containers Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureContainersIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1172. CloudAzureCosmosdbIntegration¶
Cosmos DB Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureCosmosdbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1173. CloudAzureCostmanagementIntegration¶
Cost Management Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKeys: Specify if additional cost data per tag should be collected. This field is case sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureCostmanagementIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "tag_keys")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_keys = sgqlc.types.Field(sgqlc.types.list_of(String), graphql_name="tagKeys")1174. CloudAzureDatafactoryIntegration¶
Data Factory Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureDatafactoryIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1175. CloudAzureEventhubIntegration¶
Event Hub Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureEventhubIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1176. CloudAzureExpressrouteIntegration¶
Express Route Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureExpressrouteIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1177. CloudAzureFirewallsIntegration¶
Firewalls Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureFirewallsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1178. CloudAzureFrontdoorIntegration¶
Front Door Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureFrontdoorIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1179. CloudAzureFunctionsIntegration¶
Functions Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureFunctionsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1180. CloudAzureKeyvaultIntegration¶
Key Vault Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureKeyvaultIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1181. CloudAzureLoadbalancerIntegration¶
Load Balancer Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureLoadbalancerIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1182. CloudAzureLogicappsIntegration¶
Logic Apps Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureLogicappsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1183. CloudAzureMachinelearningIntegration¶
Machine Learning Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureMachinelearningIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1184. CloudAzureMariadbIntegration¶
Database for MariaDB Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureMariadbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1185. CloudAzureMonitorIntegration¶
Azure Monitor metrics Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeenabled: Specify if integration is activeexcludeResourceTypes: Specify each Azure resource type that you don’t want to monitor.excludeTags: Specify resource tags (in ‘key:value’ form) associated with the resources that you want to exclude from monitoring. Exclusion takes precedence over inclusion.id: The cloud service integration identifier.includeTags: Specify resource tags (in ‘key:value’ form) associated with the resources that you want to monitor. If empty, all resources will be monitored.inventoryPollingInterval: The polling interval for metadata and tags, in seconds.linkedAccount: The parent linked account identifier.metricsPollingInterval: The polling interval for metrics, in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.resourceTypes: Specify each Azure resource type that you want to monitor.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureMonitorIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"enabled",
"exclude_resource_types",
"exclude_tags",
"include_tags",
"inventory_polling_interval",
"metrics_polling_interval",
"resource_groups",
"resource_types",
)
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
exclude_resource_types = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="excludeResourceTypes"
)
exclude_tags = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="excludeTags"
)
include_tags = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="includeTags"
)
inventory_polling_interval = sgqlc.types.Field(
Int, graphql_name="inventoryPollingInterval"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)
resource_types = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceTypes"
)1186. CloudAzureMysqlIntegration¶
Database for MySQL Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureMysqlIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1187. CloudAzureMysqlflexibleIntegration¶
MySQL Flexible Server Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureMysqlflexibleIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1188. CloudAzurePostgresqlIntegration¶
Database for PostgreSQL Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzurePostgresqlIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1189. CloudAzurePostgresqlflexibleIntegration¶
PostgreSQL Flexible Server Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzurePostgresqlflexibleIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1190. CloudAzurePowerbidedicatedIntegration¶
Power BI Dedicated Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzurePowerbidedicatedIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1191. CloudAzureRediscacheIntegration¶
Redis Cache Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureRediscacheIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1192. CloudAzureServicebusIntegration¶
Service Bus Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureServicebusIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1193. CloudAzureSqlIntegration¶
SQL Database Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureSqlIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1194. CloudAzureSqlmanagedIntegration¶
SQL Managed Instances Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureSqlmanagedIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1195. CloudAzureStorageIntegration¶
Storage Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureStorageIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1196. CloudAzureVirtualmachineIntegration¶
Virtual machine scale sets Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureVirtualmachineIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1197. CloudAzureVirtualnetworksIntegration¶
Virtual Network Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureVirtualnetworksIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1198. CloudAzureVmsIntegration¶
Virtual Machines Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureVmsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1199. CloudAzureVpngatewaysIntegration¶
VPN Gateways Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.resourceGroups: Specify each Resource group associated with the resources that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudAzureVpngatewaysIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "resource_groups")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
resource_groups = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="resourceGroups"
)1200. CloudBaseIntegration¶
Base Integration Object
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudBaseIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ()1201. CloudBaseProvider¶
Base Provider Object
Available fields:
createdAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.service: Get details of one cloud provider service.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudBaseProvider(sgqlc.types.Type, CloudProvider):
__schema__ = nerdgraph
__field_names__ = ()1202. CloudBillingIntegration¶
Billing Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudBillingIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1203. CloudCciAwsS3Integration¶
CCI AWS S3 Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.s3BucketName: The name of the S3 bucket to collect data from.s3BucketPath: The path within the S3 bucket to collect data from.s3BucketRegion: The region of the S3 bucket to collect data from.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudCciAwsS3Integration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"metrics_polling_interval",
"s3_bucket_name",
"s3_bucket_path",
"s3_bucket_region",
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
s3_bucket_name = sgqlc.types.Field(String, graphql_name="s3BucketName")
s3_bucket_path = sgqlc.types.Field(String, graphql_name="s3BucketPath")
s3_bucket_region = sgqlc.types.Field(String, graphql_name="s3BucketRegion")1204. CloudCloudfrontIntegration¶
CloudFront Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchLambdasAtEdge: Specify if Lambdas@Edge should be monitored. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudCloudfrontIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"fetch_lambdas_at_edge",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
fetch_lambdas_at_edge = sgqlc.types.Field(
Boolean, graphql_name="fetchLambdasAtEdge"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1205. CloudCloudtrailIntegration¶
CloudTrail Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudCloudtrailIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1206. CloudConfluentKafkaConnectorResourceIntegration¶
Confluent Kafka Connector Resource Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudConfluentKafkaConnectorResourceIntegration(
sgqlc.types.Type, CloudIntegration
):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1207. CloudConfluentKafkaFlinkResourceIntegration¶
Confluent Kafka flink Resource Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudConfluentKafkaFlinkResourceIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1208. CloudConfluentKafkaKsqlResourceIntegration¶
Confluent Kafka Ksql Resource Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudConfluentKafkaKsqlResourceIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1209. CloudConfluentKafkaResourceIntegration¶
Confluent Kafka Resource Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudConfluentKafkaResourceIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1210. CloudDynamodbIntegration¶
DynamoDB Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudDynamodbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1211. CloudEbsIntegration¶
EBS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudEbsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1212. CloudEc2Integration¶
EC2 Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeduplicateEc2Tags: Specify if the old legacy metadata and tag names have to be kept, it will consume more ingest data sizefetchIpAddresses: Specify if IP addresses of ec2 instance should be collectedid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudEc2Integration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"duplicate_ec2_tags",
"fetch_ip_addresses",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
duplicate_ec2_tags = sgqlc.types.Field(Boolean, graphql_name="duplicateEc2Tags")
fetch_ip_addresses = sgqlc.types.Field(Boolean, graphql_name="fetchIpAddresses")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1213. CloudEcsIntegration¶
ECS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudEcsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1214. CloudEfsIntegration¶
EFS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudEfsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1215. CloudElasticacheIntegration¶
ElastiCache Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudElasticacheIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1216. CloudElasticbeanstalkIntegration¶
Elastic Beanstalk Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudElasticbeanstalkIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1217. CloudElasticsearchIntegration¶
Elasticsearch Service Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchNodes: Specify if metrics should be collected for nodes. Turning it on will increase the number of API calls made to CloudWatch.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudElasticsearchIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_nodes",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_nodes = sgqlc.types.Field(Boolean, graphql_name="fetchNodes")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1218. CloudElbIntegration¶
ELB (Classic) Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudElbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"fetch_tags",
"metrics_polling_interval",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1219. CloudEmrIntegration¶
EMR Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags and the extended inventory should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudEmrIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1220. CloudFossaIssuesIntegration¶
FOSSA Issues Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudFossaIssuesIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1221. CloudGcpAiplatformIntegration¶
Vertex AI Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpAiplatformIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1222. CloudGcpAlloydbIntegration¶
AlloyDB Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpAlloydbIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1223. CloudGcpAppengineIntegration¶
App Engine Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpAppengineIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1224. CloudGcpBigqueryIntegration¶
BigQuery Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchTableMetrics: Fetch BigQuery Table metrics, disabled by defaultfetchTags: Specify if labels and the extended inventory should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpBigqueryIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("fetch_table_metrics", "fetch_tags", "metrics_polling_interval")
fetch_table_metrics = sgqlc.types.Field(Boolean, graphql_name="fetchTableMetrics")
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1225. CloudGcpBigtableIntegration¶
Bigtable Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpBigtableIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1226. CloudGcpComposerIntegration¶
Composer Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpComposerIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1227. CloudGcpDataflowIntegration¶
Dataflow Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpDataflowIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1228. CloudGcpDataprocIntegration¶
Dataproc Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpDataprocIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1229. CloudGcpDatastoreIntegration¶
Datastore Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpDatastoreIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1230. CloudGcpFirebasedatabaseIntegration¶
Firebase Database Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpFirebasedatabaseIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1231. CloudGcpFirebasehostingIntegration¶
Firebase Hosting Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpFirebasehostingIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1232. CloudGcpFirebasestorageIntegration¶
Firebase Storage Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpFirebasestorageIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1233. CloudGcpFirestoreIntegration¶
Firestore Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpFirestoreIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1234. CloudGcpFunctionsIntegration¶
Cloud Functions Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpFunctionsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1235. CloudGcpInterconnectIntegration¶
Interconnect Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpInterconnectIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1236. CloudGcpKubernetesIntegration¶
Kubernetes Engine Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpKubernetesIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1237. CloudGcpLoadbalancingIntegration¶
Cloud Load Balancing Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpLoadbalancingIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1238. CloudGcpMemcacheIntegration¶
Memcache Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpMemcacheIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1239. CloudGcpProvider¶
The Google Cloud Platform cloud provider
Available fields:
createdAt: The object creation date, in epoch (Unix) timeicon: The cloud provider icon name.id: The cloud provider identifier in NewRelic.name: The cloud provider name.service: Get details of one cloud provider service.serviceAccountId: The service account identifier used to link the GCP project to NewRelic.services: Get details of all the cloud provider services available for integration.slug: The cloud provider short name.templateParams: Get template params of one cloud provider service.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpProvider(sgqlc.types.Type, CloudProvider):
__schema__ = nerdgraph
__field_names__ = ("service_account_id",)
service_account_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="serviceAccountId"
)1240. CloudGcpPubsubIntegration¶
Cloud Pub/Sub Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if labels and the extended inventory should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpPubsubIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("fetch_tags", "metrics_polling_interval")
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1241. CloudGcpRedisIntegration¶
Redis Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpRedisIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1242. CloudGcpRouterIntegration¶
Router Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpRouterIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1243. CloudGcpRunIntegration¶
Run Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpRunIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1244. CloudGcpSpannerIntegration¶
Cloud Spanner Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if labels and the extended inventory should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpSpannerIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("fetch_tags", "metrics_polling_interval")
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1245. CloudGcpSqlIntegration¶
Cloud SQL Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpSqlIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1246. CloudGcpStorageIntegration¶
Cloud Storage Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if labels and the extended inventory should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpStorageIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("fetch_tags", "metrics_polling_interval")
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1247. CloudGcpVmsIntegration¶
Compute Engine Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpVmsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1248. CloudGcpVpcaccessIntegration¶
VPC Access Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudGcpVpcaccessIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1249. CloudHealthIntegration¶
Health Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudHealthIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1250. CloudIamIntegration¶
IAM Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudIamIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval", "tag_key", "tag_value")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1251. CloudIotIntegration¶
IoT Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudIotIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1252. CloudKinesisFirehoseIntegration¶
Kinesis Firehose Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudKinesisFirehoseIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1253. CloudKinesisIntegration¶
Kinesis Streams Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchShards: Specify if Shards should be monitored. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudKinesisIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_shards",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_shards = sgqlc.types.Field(Boolean, graphql_name="fetchShards")
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1254. CloudLambdaIntegration¶
Lambda Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudLambdaIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1255. CloudOciLogsIntegration¶
Fetch Metadata and Tags for OCI Logs integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.instrumentationType: Specifies the type of integration, such as metrics, logs, or a combination of logs and metrics.linkedAccount: The parent linked account identifier.loggingStacks: The logging OCI stack IDs.metricStacks: The metrics OCI stack IDs.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudOciLogsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"instrumentation_type",
"logging_stacks",
"metric_stacks",
"metrics_polling_interval",
)
instrumentation_type = sgqlc.types.Field(String, graphql_name="instrumentationType")
logging_stacks = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="loggingStacks"
)
metric_stacks = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="metricStacks"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1256. CloudOciMetadataAndTagsIntegration¶
Fetch Metadata and Tags for OCI integrations Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.instrumentationType: Specifies the type of integration, such as metrics, logs, or a combination of logs and metrics.linkedAccount: The parent linked account identifier.loggingStacks: The logging OCI stack IDs.metricStacks: The metrics OCI stack IDs.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudOciMetadataAndTagsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"instrumentation_type",
"logging_stacks",
"metric_stacks",
"metrics_polling_interval",
)
instrumentation_type = sgqlc.types.Field(String, graphql_name="instrumentationType")
logging_stacks = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="loggingStacks"
)
metric_stacks = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="metricStacks"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1257. CloudRdsIntegration¶
RDS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudRdsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1258. CloudRedshiftIntegration¶
Redshift Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudRedshiftIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1259. CloudRoute53Integration¶
Route 53 Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudRoute53Integration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("fetch_extended_inventory", "metrics_polling_interval")
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1260. CloudS3Integration¶
S3 Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudS3Integration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"fetch_extended_inventory",
"fetch_tags",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1261. CloudSecurityHubIntegration¶
SecurityHub Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudSecurityHubIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1262. CloudSesIntegration¶
SES Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudSesIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("aws_regions", "metrics_polling_interval")
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1263. CloudSnsIntegration¶
SNS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudSnsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"metrics_polling_interval",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1264. CloudSqsIntegration¶
SQS Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchExtendedInventory: Determine if extra inventory data be collected or not. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchTags: Specify if tags should be collected. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.queuePrefixes: Specify each name or prefix for the Queues that you want to monitor. Filter values are case-sensitive.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudSqsIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_extended_inventory",
"fetch_tags",
"metrics_polling_interval",
"queue_prefixes",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_extended_inventory = sgqlc.types.Field(
Boolean, graphql_name="fetchExtendedInventory"
)
fetch_tags = sgqlc.types.Field(Boolean, graphql_name="fetchTags")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
queue_prefixes = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="queuePrefixes"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1265. CloudTrustedadvisorIntegration¶
Trusted Advisor Integration
Available fields:
createdAt: The object creation date, in epoch (Unix) timeid: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.updatedAt: The object last update date, in epoch (Unix) time
class CloudTrustedadvisorIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = ("metrics_polling_interval",)
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)1266. CloudVpcIntegration¶
VPC Integration
Available fields:
awsRegions: Specify each AWS region that includes the resources that you want to monitor.createdAt: The object creation date, in epoch (Unix) timefetchNatGateway: Specify if NAT gateway should be monitored. May affect total data collection time and contribute to the Cloud provider API rate limit.fetchVpn: Specify if VPN should be monitored. May affect total data collection time and contribute to the Cloud provider API rate limit.id: The cloud service integration identifier.linkedAccount: The parent linked account identifier.metricsPollingInterval: The data polling interval in seconds.name: The cloud service integration name.nrAccountId: The parent NewRelic account identifier.service: The cloud service used in the integration.tagKey: Specify a Tag key associated with the resources that you want to monitor. Filter values are case-sensitive.tagValue: Specify a Tag value associated with the resources that you want to monitor. Filter values are case-sensitive.updatedAt: The object last update date, in epoch (Unix) time
class CloudVpcIntegration(sgqlc.types.Type, CloudIntegration):
__schema__ = nerdgraph
__field_names__ = (
"aws_regions",
"fetch_nat_gateway",
"fetch_vpn",
"metrics_polling_interval",
"tag_key",
"tag_value",
)
aws_regions = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="awsRegions"
)
fetch_nat_gateway = sgqlc.types.Field(Boolean, graphql_name="fetchNatGateway")
fetch_vpn = sgqlc.types.Field(Boolean, graphql_name="fetchVpn")
metrics_polling_interval = sgqlc.types.Field(
Int, graphql_name="metricsPollingInterval"
)
tag_key = sgqlc.types.Field(String, graphql_name="tagKey")
tag_value = sgqlc.types.Field(String, graphql_name="tagValue")1267. DashboardEntity¶
A Dashboard entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.createdAt: The date and time the dashboard was createddashboardParentGuid: The parent entityguidof the dashboard.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.description: Dashboard description.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
owner: The owner information of the dashboard.pages: A nested block of all pages belonging to the dashboard.permalink: The url to the entity.permissions: The permissions of the dashboard.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s typeupdatedAt: The date and time the dashboard was updatedvariables: Dashboard-local variable definitions.
class DashboardEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"dashboard_parent_guid",
"description",
"owner",
"pages",
"permissions",
"updated_at",
"variables",
)
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
dashboard_parent_guid = sgqlc.types.Field(
EntityGuid, graphql_name="dashboardParentGuid"
)
description = sgqlc.types.Field(String, graphql_name="description")
owner = sgqlc.types.Field(DashboardEntityOwnerInfo, graphql_name="owner")
pages = sgqlc.types.Field(sgqlc.types.list_of(DashboardPage), graphql_name="pages")
permissions = sgqlc.types.Field(
DashboardEntityPermissions, graphql_name="permissions"
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")
variables = sgqlc.types.Field(
sgqlc.types.list_of(DashboardVariable), graphql_name="variables"
)1268. DashboardEntityOutline¶
A Dashboard entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.createdAt: The date and time the dashboard was createddashboardParentGuid: The parent entityguidof the dashboard.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.owner: The owner information of the dashboard.permalink: The url to the entity.permissions: The permissions of the dashboard.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s typeupdatedAt: The date and time the dashboard was updated
class DashboardEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = (
"created_at",
"dashboard_parent_guid",
"owner",
"permissions",
"updated_at",
)
created_at = sgqlc.types.Field(DateTime, graphql_name="createdAt")
dashboard_parent_guid = sgqlc.types.Field(
EntityGuid, graphql_name="dashboardParentGuid"
)
owner = sgqlc.types.Field(DashboardEntityOwnerInfo, graphql_name="owner")
permissions = sgqlc.types.Field(
DashboardEntityPermissions, graphql_name="permissions"
)
updated_at = sgqlc.types.Field(DateTime, graphql_name="updatedAt")1269. EdgeAgentEndpointDetail¶
All the details necessary to configure an agent to connect to an endoint.
Available fields:
host: Full host name that is used to connect to the endpoint. This is the part that will be placed into an agent config namedinfinite_tracing.trace_observer.host.port: Port that is used to connect to the endpoint. This is the part that will be placed into an agent config namedinfinite_tracing.trace_observer.port.
class EdgeAgentEndpointDetail(sgqlc.types.Type, EdgeEndpointDetail):
__schema__ = nerdgraph
__field_names__ = ()1270. EdgeHttpsEndpointDetail¶
All the details necessary to configure an integration to connect to the Infinite Tracing Trace API (HTTP 1.1) endpoint.
Available fields:
host: Full host name that is used to connect to the endpoint.port: Port that is used to connect to the endpoint.url: Full URL used to send data to the endpoint. For instance, if you were using the Java Telemetry SDK this is the data you would use to create aURIto pass to theuriOverridemethod.
class EdgeHttpsEndpointDetail(sgqlc.types.Type, EdgeEndpointDetail):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1271. EntityManagementAgentConfigurationEntity¶
A configuration that can contain multiple immutable versions and can be deployed to a fleet
Available fields:
agentType: The agentTypeconfigurationType: Configuration typeid: The entity’s global unique identifier.managedEntityType: The managedEntityType this configuration is intended to be deployed tometadata: Metadata about the entity.name: A unique user provided name for the configurationoperatingSystem: The operating system of the managed entity this configuration is intended to be deployed toscope: The entity’s scope.tags: Collection of tags.type: The entity type.versionCount: The total number of versions that have been created for this configuration
class EntityManagementAgentConfigurationEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"agent_type",
"configuration_type",
"managed_entity_type",
"operating_system",
"version_count",
)
agent_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="agentType"
)
configuration_type = sgqlc.types.Field(String, graphql_name="configurationType")
managed_entity_type = sgqlc.types.Field(
EntityManagementManagedEntityType, graphql_name="managedEntityType"
)
operating_system = sgqlc.types.Field(
EntityManagementOperatingSystem, graphql_name="operatingSystem"
)
version_count = sgqlc.types.Field(Int, graphql_name="versionCount")1272. EntityManagementAgentConfigurationVersionEntity¶
A version of an agent configuration
Available fields:
agentConfiguration: EntityGuid of the parent AgentConfiguration objectblob: Metadata about the configuration blobid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.version: Monotonically increasing version number
class EntityManagementAgentConfigurationVersionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("agent_configuration", "blob", "version")
agent_configuration = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="agentConfiguration"
)
blob = sgqlc.types.Field(EntityManagementBlob, graphql_name="blob")
version = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="version")1273. EntityManagementAgentEffectiveConfigurationEntity¶
The configuration that is actively being used to configure an agent
Available fields:
blob: Metadata about the effective configuration blobid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementAgentEffectiveConfigurationEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("blob",)
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)1274. EntityManagementAgentEntity¶
A software component that collects or processes telemetry
Available fields:
agentType: The agentTypefleetControlProperties: Properties specific to fleet controlid: The entity’s global unique identifier.infrastructureManagers: The infrastructure managers related to the agentmetadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.version: Version of the agent
class EntityManagementAgentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"agent_type",
"fleet_control_properties",
"infrastructure_managers",
"version",
)
agent_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="agentType"
)
fleet_control_properties = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementFleetControlProperties),
graphql_name="fleetControlProperties",
)
infrastructure_managers = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementInfrastructureManager),
graphql_name="infrastructureManagers",
)
version = sgqlc.types.Field(String, graphql_name="version")1275. EntityManagementAiAgentEntity¶
Agent configuration for agentic-platform
Available fields:
agents: list of worker agents available to the planner agent in a multi-agent setup, ignore this for a single agent setupcategory: agent category, to identify different agents supported by the platform in both single and multi-agent setupsdescription: short description of the agent, important for the discoverability of the agent in a group chat, so make it clear and concise.displayName: display name for the agentid: entity’s global identifierinitialized: flag to be set to true once agent validation is complete and is ready for use.llmConfig: llm configuration for the agent which includes exact LLM name and temperature settingsmcpServers: list of MCP server entities to be attached to the agent, each MCP server entity allows you to include/exclude a subset of toolsmetadata: agent metadataname: unique name of the agent entityprompt: system instructions for the agent, this guides the behaviour of the llm, so make it elaborate but avoid noise.provider: creator of the agent entity, will help to distinguish extrernal agents from NR owned agentsscope: entity scopetags: collection of tagstest: test flag (true in case entity is experimental, default is true)type: entity type
class EntityManagementAiAgentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"agents",
"category",
"description",
"display_name",
"initialized",
"llm_config",
"mcp_servers",
"prompt",
"provider",
"test",
)
agents = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementEntity)),
graphql_name="agents",
)
category = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="category")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
display_name = sgqlc.types.Field(String, graphql_name="displayName")
initialized = sgqlc.types.Field(Boolean, graphql_name="initialized")
llm_config = sgqlc.types.Field(EntityManagementLlmConfig, graphql_name="llmConfig")
mcp_servers = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementAiAgentMcpServerConfig)
),
graphql_name="mcpServers",
)
prompt = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="prompt")
provider = sgqlc.types.Field(EntityManagementProvider, graphql_name="provider")
test = sgqlc.types.Field(Boolean, graphql_name="test")1276. EntityManagementAiCapableEntity¶
AI Capable Library for AI Inventory Catalog
Available fields:
category: Category of the tool/libraryid: The entity’s global unique identifier.language: Language of the ai tool/librarylastSeen: Last seen timestamp: A date and time as an ISO8601 formatted string.metadata: Entity metadataname: Unique name of the agent entityscope: Entity scopetags: Collection of tagstoolType: Type of the tool. Eg: library or usagetoolVersion: Version of the ai tool/librarytype: The entity type.
class EntityManagementAiCapableEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("category", "language", "last_seen", "tool_type", "tool_version")
category = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="category")
language = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="language")
last_seen = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="lastSeen"
)
tool_type = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="toolType")
tool_version = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="toolVersion"
)1277. EntityManagementAiEvaluationConfigEntity¶
Experimental feature for ai evaluation configuration
Available fields:
description: The entity description.enabled: Enable or disable Evaluations for all the entities under the scopeid: The entity’s global unique identifier.managedEvaluationsEntity: Reference to the ManagedEvaluationsEntity containing the evaluation configurations to be appliedmetadata: Metadata about the entity.name: A unique user provided name for the evaluation.samplingRate: Defines the fraction of incoming messages to be evaluated. Value ranges from 0.0 (none) to 1.0 (all).scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementAiEvaluationConfigEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"description",
"enabled",
"managed_evaluations_entity",
"sampling_rate",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
managed_evaluations_entity = sgqlc.types.Field(
"EntityManagementManagedEvaluationsEntity",
graphql_name="managedEvaluationsEntity",
)
sampling_rate = sgqlc.types.Field(Float, graphql_name="samplingRate")1278. EntityManagementAiToolEntity¶
Tool configuration for agentic-platform
Available fields:
description: short description of the tool, useful for tool discovery by an agentid: entity’s unique global indentifierinitialized: flag to be set to true once agent validation is complete and is ready for use.metadata: tool metadataname: unique name of the toolparameters: tool parameters to be passed for each toolprovider: creator of the agent entity, will help to distinguish extrernal agents from NR owned agentsscope: entity scopetags: collection of tagstest: test flag (true in case entity is experimental, default is true)toolType: type of tool from a list of first class citizen toolstype: entity typeurl: It is primarily a nerdgraph query in single line format
class EntityManagementAiToolEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"description",
"initialized",
"parameters",
"provider",
"test",
"tool_type",
"url",
)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
initialized = sgqlc.types.Field(Boolean, graphql_name="initialized")
parameters = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementAiToolParameter)),
graphql_name="parameters",
)
provider = sgqlc.types.Field(EntityManagementProvider, graphql_name="provider")
test = sgqlc.types.Field(Boolean, graphql_name="test")
tool_type = sgqlc.types.Field(EntityManagementAiToolType, graphql_name="toolType")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1279. EntityManagementApiSpecificationBlobEntity¶
Entity of type Spec Blob.
Available fields:
blob: The blob containing the Api specification content.description: Description of the specification content.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the specification file.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementApiSpecificationBlobEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("blob", "description")
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
description = sgqlc.types.Field(String, graphql_name="description")1280. EntityManagementAwsConnectionEntity¶
Connection entity type for Aws
Available fields:
credential: A single credential from the choice of AwsCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.region: Default region for this connectionscope: The entity’s scope.settings: Optional list of connection settingstags: Collection of tags.type: The entity’s type.
class EntityManagementAwsConnectionEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"region",
"settings",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementAwsCredentials), graphql_name="credential"
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
region = sgqlc.types.Field(String, graphql_name="region")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)1281. EntityManagementBackgroundProcessingRuleEntity¶
At rest background processing types
Available fields:
description: Entity description.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.query: The account and NRQL query definition for the ruleruleType: Classification of the query type. This field is primarily for filteringschedule: The cronExpression to run the scheduled query. Minute step values, ranges and lists are not permitted.scope: The entity’s scope.state: Describes the asynchronous at-rest process state to communicate through the API what is happeningtags: Collection of tags.type: The entity type.
class EntityManagementBackgroundProcessingRuleEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("description", "query", "rule_type", "schedule", "state")
description = sgqlc.types.Field(String, graphql_name="description")
query = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBackgroundProcessingQuery),
graphql_name="query",
)
rule_type = sgqlc.types.Field(
EntityManagementBackgroundProcessingType, graphql_name="ruleType"
)
schedule = sgqlc.types.Field(EntityManagementSchedule, graphql_name="schedule")
state = sgqlc.types.Field(EntityManagementProcessState, graphql_name="state")1282. EntityManagementBackgroundSqlProcessingRuleEntity¶
At rest background sql processing types
Available fields:
description: Entity description.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.query: The account and SQL query definition for the ruleschedule: The cronExpression to run the scheduled query. Minute step values, ranges and lists are not permitted.scope: The entity’s scope.state: Describes the asynchronous at-rest process state to communicate through the API what is happeningtags: Collection of tags.type: The entity type.
class EntityManagementBackgroundSqlProcessingRuleEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("description", "query", "schedule", "state")
description = sgqlc.types.Field(String, graphql_name="description")
query = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBackgroundProcessingSqlQuery),
graphql_name="query",
)
schedule = sgqlc.types.Field(EntityManagementSchedule, graphql_name="schedule")
state = sgqlc.types.Field(EntityManagementProcessState, graphql_name="state")1283. EntityManagementBudgetEntity¶
Represents a New Relic Budget entity.
Available fields:
budgetAlertPolicies: A list of alert policies associated with this budget.budgetLimits: A list of limits defined for this budget.budgetSegment: The segment being tracked by the budget.budgetType: Budget Type as Ingest or computeid: The globally unique identifier of the entity.metadata: Metadata associated with the entity.name: The name of the entity.organizationBudget: True if it’s an org level budget, False otherwise.scope: The scope of the entity.tags: A collection of tags associated with the entity.type: The type of the entity.
class EntityManagementBudgetEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"budget_alert_policies",
"budget_limits",
"budget_segment",
"budget_type",
"organization_budget",
)
budget_alert_policies = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementBudgetAlertPolicy),
graphql_name="budgetAlertPolicies",
)
budget_limits = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementBudgetLimit), graphql_name="budgetLimits"
)
budget_segment = sgqlc.types.Field(
EntityManagementBudgetSegment, graphql_name="budgetSegment"
)
budget_type = sgqlc.types.Field(
EntityManagementBudgetType, graphql_name="budgetType"
)
organization_budget = sgqlc.types.Field(Boolean, graphql_name="organizationBudget")1284. EntityManagementCiscoMerakiConnectionEntity¶
Connection entity type for Cisco Meraki
Available fields:
credential: A single credential for Cisco Merakidescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.region: The Cisco Meraki region (e.g., India, China, Canada)scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.
class EntityManagementCiscoMerakiConnectionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"region",
"settings",
"signing_credentials",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCiscoMerakiCredential),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
region = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="region")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)1285. EntityManagementCollectionEntity¶
An entity type to represent collections of entities
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementCollectionEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1286. EntityManagementComponentEntity¶
An entity representing the component or the product available to create impact for an incident.
Available fields:
description: The component description.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: Name for the component.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementComponentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(String, graphql_name="description")1287. EntityManagementComputeLocationEntity¶
An entity representing a compute location for serverless job execution
Available fields:
description: Description for the ComputeLocationid: The entity’s global unique identifier.metadata: Metadata about the entity.name: A unique user provided name for the ComputeLocation, can be utilized for workload querying.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementComputeLocationEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)1288. EntityManagementConfluenceConnectionEntity¶
Connection entity type for Confluence
Available fields:
credential: A single credential from the choice of ConfluenceCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. False by default.externalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.
class EntityManagementConfluenceConnectionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"settings",
"signing_credentials",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementConfluenceCredentials),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)1289. EntityManagementConfluenceIntegration¶
Bare essentials for any integration with confluence
Available fields:
confluenceUserId: The confluence user ID associated with this integration.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the Confluence Rag Settings.scope: The entity’s scope.secretKey: The secret key referencing confluence credentials in secret store.tags: Collection of tags.type: The entity type.url: The confluence domain.
class EntityManagementConfluenceIntegration(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("confluence_user_id", "secret_key", "url")
confluence_user_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="confluenceUserId"
)
secret_key = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="secretKey"
)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1290. EntityManagementConfluenceRagSettingsEntity¶
Confluence Rag Settings
Available fields:
characterTextSplitterOptions: The options for character text splitterchunkOverlap: The chunk overlap for chunking documentschunkSize: The chunk size for chunking documentsconfluenceIntegrationId: The ID of the confluence integration entityconfluenceQuery: The CQL query for selecting documents to index.id: The entity’s global unique identifier.intervalSeconds: The interval, in seconds, for how often documents are synced.lastPullTime: The timestamp when the connector was last run.markdownTextSplitterOptions: The options when using the markdown text splittermetadata: Metadata about the entity.name: The name of the Confluence Rag Settings.nextPullTime: The timestamp for the connector’s next scheduled run.scope: The entity’s scope.tags: Collection of tags.textSplitterType: The text splitter to be usedtokenTextSplitterOptions: The options when using a token text splittertype: The entity type.
class EntityManagementConfluenceRagSettingsEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"character_text_splitter_options",
"chunk_overlap",
"chunk_size",
"confluence_integration_id",
"confluence_query",
"interval_seconds",
"last_pull_time",
"markdown_text_splitter_options",
"next_pull_time",
"text_splitter_type",
"token_text_splitter_options",
)
character_text_splitter_options = sgqlc.types.Field(
EntityManagementCharacterTextSplitterOptions,
graphql_name="characterTextSplitterOptions",
)
chunk_overlap = sgqlc.types.Field(Int, graphql_name="chunkOverlap")
chunk_size = sgqlc.types.Field(Int, graphql_name="chunkSize")
confluence_integration_id = sgqlc.types.Field(
sgqlc.types.non_null(ID), graphql_name="confluenceIntegrationId"
)
confluence_query = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="confluenceQuery"
)
interval_seconds = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="intervalSeconds"
)
last_pull_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="lastPullTime")
markdown_text_splitter_options = sgqlc.types.Field(
EntityManagementMarkdownTextSplitterOptions,
graphql_name="markdownTextSplitterOptions",
)
next_pull_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="nextPullTime")
text_splitter_type = sgqlc.types.Field(
EntityManagementTextSplitterType, graphql_name="textSplitterType"
)
token_text_splitter_options = sgqlc.types.Field(
EntityManagementTokenTextSplitterOptions,
graphql_name="tokenTextSplitterOptions",
)1291. EntityManagementCorrelationInternalSourceConfigEntity¶
CorrelationInternalSourceConfig persists the configuration required to provision DAQS filters, separating the ingestion mechanism from the correlation logic. This entity is internal only.
Available fields:
accountId: Account ID of the Rule Filter.alias: Alias for this subject used in criteria and linking configuration.filterId: The internal ID used by the DAQS filtering system.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this internal source configuration.namespaces: List of namespaces applicable to this filter.nrql: The NRQL query used to filter the stream.outputTopic: The Kafka topic where filtered data should be published.scope: The entity’s scope.source: The data source identifier (e.g., ai-external-incident).tags: Collection of tags.type: The entity type.
class EntityManagementCorrelationInternalSourceConfigEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"account_id",
"alias",
"filter_id",
"namespaces",
"nrql",
"output_topic",
"source",
)
account_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="accountId")
alias = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="alias")
filter_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="filterId")
namespaces = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="namespaces"
)
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")
output_topic = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="outputTopic"
)
source = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="source")1292. EntityManagementCorrelationLinkEntity¶
CorrelationLink represents a directional edge between two correlation subjects. When a CorrelationLinkingRule matches, it creates this relationship entity in NGEP. Note: The output is stored in NGEP as an entity and not a relationship, because the targets for the relationship need not be NGEP entities (can just be NRDB Events).
Available fields:
context: Metadata about why this link exists.directional: Indicates if the link is directional.id: The entity’s global unique identifier.linkType: The relationship type (e.g., CAUSED_BY, RELATED_TO).metadata: Metadata about the entity.name: The name of this correlation link.overrideInfo: Audit trail if a user manually modified/rejected this link.scope: The entity’s scope.source: The ‘From’ correlation subject.tags: Collection of tags.target: The ‘To’ correlation subject.type: The entity type.
class EntityManagementCorrelationLinkEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"context",
"directional",
"link_type",
"override_info",
"source",
"target",
)
context = sgqlc.types.Field(
EntityManagementCorrelationContext, graphql_name="context"
)
directional = sgqlc.types.Field(Boolean, graphql_name="directional")
link_type = sgqlc.types.Field(String, graphql_name="linkType")
override_info = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementCorrelationOverrideInfo)
),
graphql_name="overrideInfo",
)
source = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationSubjectReference),
graphql_name="source",
)
target = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationSubjectReference),
graphql_name="target",
)1293. EntityManagementCorrelationLinkingRuleEntity¶
CorrelationLinkingRule persists the logic required to drive the event correlation engine, defining which events (Drivers) trigger searches for other subjects (Candidates). Supports all standard CRUD operations including delete via the generic delete mutation.
Available fields:
criteria: The criteria defining how to match driver and candidates.description: Description of what this correlation rule does.enabled: Whether this correlation rule is currently enabled. Considered true by defaultid: The entity’s global unique identifier.linkingConfig: The output configuration defining the correlation result.metadata: Metadata about the entity.name: The name of this correlation rule.scope: The entity’s scope.subjects: Defines the Driver (trigger) and Candidates.tags: Collection of tags.type: The entity type.
class EntityManagementCorrelationLinkingRuleEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"criteria",
"description",
"enabled",
"linking_config",
"subjects",
)
criteria = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationLinkingCriteria),
graphql_name="criteria",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
linking_config = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCorrelationLinkingConfig),
graphql_name="linkingConfig",
)
subjects = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementCorrelationSubject)
)
),
graphql_name="subjects",
)1294. EntityManagementCustomEvaluationEntity¶
Experimental feature for custom evaluations
Available fields:
criteria: Evaluation criteria definitiondescription: The entity description.id: The entity’s global unique identifier.metadata: Metadata about the entity.model: Model identifier to use for evaluationname: A unique user provided name for the evaluation.parameters: Parameters required for the evaluationscope: The entity’s scope.steps: Step-by-step evaluation instructionstags: Collection of tags.threshold: Threshold value for passing the evaluation (0.0 to 1.0)type: The entity type.
class EntityManagementCustomEvaluationEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"criteria",
"description",
"model",
"parameters",
"steps",
"threshold",
)
criteria = sgqlc.types.Field(String, graphql_name="criteria")
description = sgqlc.types.Field(String, graphql_name="description")
model = sgqlc.types.Field(String, graphql_name="model")
parameters = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementEvaluationParameter)),
graphql_name="parameters",
)
steps = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="steps"
)
threshold = sgqlc.types.Field(Float, graphql_name="threshold")1295. EntityManagementCustomerImpactEntity¶
An entity representing customer impact information for an incident. It contains impact representing an incident.
Available fields:
blob: Impact along with attributescomponents: Impacted Components per issueid: The entity’s global unique identifier.issueId: Related issue idmetadata: Metadata about the entity.name: A unique user provided name for the customer impact.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementCustomerImpactEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("blob", "components", "issue_id")
blob = sgqlc.types.Field(EntityManagementBlob, graphql_name="blob")
components = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementComponentEntity)),
graphql_name="components",
)
issue_id = sgqlc.types.Field(ID, graphql_name="issueId")1296. EntityManagementCustomerImpactQueryEntity¶
An entity representing customer impact queries information for an incident.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.products: Impacted products.query: Customer impact query to determine the impacted account ids.queryAccountId: Query account id required to execute the customer impact query.scope: The entity’s scope.tags: Collection of tags.teamEntity: NRTeam responsible for the customer impact query.totalCustImpactQueryAccountIds: Account IDs to be used with the total customer impact query.totalCustomerImpactQuery: Customer impact query to determine the total customer impact.type: The entity type.
class EntityManagementCustomerImpactQueryEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"products",
"query",
"query_account_id",
"team_entity",
"total_cust_impact_query_account_ids",
"total_customer_impact_query",
)
products = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementComponentEntity)),
graphql_name="products",
)
query = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="query")
query_account_id = sgqlc.types.Field(
sgqlc.types.non_null(Int), graphql_name="queryAccountId"
)
team_entity = sgqlc.types.Field(
"EntityManagementTeamEntity", graphql_name="teamEntity"
)
total_cust_impact_query_account_ids = sgqlc.types.Field(
sgqlc.types.list_of(Int), graphql_name="totalCustImpactQueryAccountIds"
)
total_customer_impact_query = sgqlc.types.Field(
String, graphql_name="totalCustomerImpactQuery"
)1297. EntityManagementEventBridgeRuleEntity¶
Event Bridge Rule entity type
Available fields:
conditions: A list of conditions. All conditions in this list must be true for the rule to match (logical AND).description: An optional, user-defined description for the bridge rule.enabled: Whether this rule is enabled or not.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: A user-defined name for the bridge rule.scope: The entity’s scope.sourceType: Defines the origin of the event this rule applies to. It specifies both the high-level event source and the specific entity name within that source.tags: Collection of tags.targets: The list of target actions to execute when an event matches the filter.type: The entity type.
class EntityManagementEventBridgeRuleEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("conditions", "description", "enabled", "source_type", "targets")
conditions = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementEventBridgeCondition)
)
),
graphql_name="conditions",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
source_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEventBridgeSourceType),
graphql_name="sourceType",
)
targets = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementEventBridgeTarget))
),
graphql_name="targets",
)1298. EntityManagementFederatedLogPartitionEntity¶
Federated Log partition entity.
Available fields:
dataLocationUri: The URI location of the log partition in object storage.description: The description of the log partition.id: The entity’s global unique identifier.isDefault: Indicates if this log partition is the default partition.metadata: Metadata about the entity.name: The name of the log partition. This corresponds to the partition/event type used in log queries.partitionTable: The table name associated with the log partition. This could refer to a data catalog table or similar structure.retentionPolicy: The optional retention policy for logs in this partition.scope: The entity’s scope.setup: The federated log setup this partition belongs to.status: The status of the log partition.tags: Collection of tags.type: The entity type.
class EntityManagementFederatedLogPartitionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"data_location_uri",
"description",
"is_default",
"partition_table",
"retention_policy",
"setup",
"status",
)
data_location_uri = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="dataLocationUri"
)
description = sgqlc.types.Field(String, graphql_name="description")
is_default = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="isDefault"
)
partition_table = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="partitionTable"
)
retention_policy = sgqlc.types.Field(
EntityManagementRetentionPolicy, graphql_name="retentionPolicy"
)
setup = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementFederatedLogSetupEntity"),
graphql_name="setup",
)
status = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementLogPartitionStatus), graphql_name="status"
)1299. EntityManagementFederatedLogSetupEntity¶
Federated Log Setup Entity.
Available fields:
cloudProvider: The cloud provider where this Federated Log setup is deployed.cloudProviderRegion: The cloud provider region where the Federated Log setup is deployed.dataLocationBucket: The object storage bucket where log data is stored.dataProcessingComponent: The data processing component that defines transformation rules and partition routing logic for this federated log setup.dataProcessingConnection: The connection manager entity used for data processing, transformation, and partition routing. Must match the cloudProvider type (e.g., AwsConnectionEntity for AWS, AzureConnectionEntity for Azure) and typically has write/update permissions.description: The description of the Federated Log setup.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the federated log setup.partitionDatabase: The database name associated with the federated log setup. This could refer to a data catalog database or similar structure.queryConnection: The connection manager entity used by query workers for reading and accessing federated log resources. Must match the cloudProvider type (e.g., AwsConnectionEntity for AWS, AzureConnectionEntity for Azure) and typically has read-only permissions.scope: The entity’s scope.status: The status of the federated log setup.tags: Collection of tags.type: The entity type.
class EntityManagementFederatedLogSetupEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"cloud_provider",
"cloud_provider_region",
"data_location_bucket",
"data_processing_component",
"data_processing_connection",
"description",
"partition_database",
"query_connection",
"status",
)
cloud_provider = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCloudProvider),
graphql_name="cloudProvider",
)
cloud_provider_region = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="cloudProviderRegion"
)
data_location_bucket = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="dataLocationBucket"
)
data_processing_component = sgqlc.types.Field(
EntityManagementEntity, graphql_name="dataProcessingComponent"
)
data_processing_connection = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntity),
graphql_name="dataProcessingConnection",
)
description = sgqlc.types.Field(String, graphql_name="description")
partition_database = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="partitionDatabase"
)
query_connection = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEntity), graphql_name="queryConnection"
)
status = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementFederatedLogSetupStatus),
graphql_name="status",
)1300. EntityManagementFleetDeploymentEntity¶
A set of configurations that can be deployed to a fleet
Available fields:
agents: Agents to deploydescription: Deployment descriptionfleetId: Deployment’s Fleet IDid: The entity’s global unique identifier.metadata: Metadata about the entity.name: Deployment namephase: Deployment phaseringsDeploymentTracker: Ring wise deployment statusscope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementFleetDeploymentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"agents",
"description",
"fleet_id",
"phase",
"rings_deployment_tracker",
)
agents = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementAgentToDeploy)),
graphql_name="agents",
)
description = sgqlc.types.Field(String, graphql_name="description")
fleet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetId")
phase = sgqlc.types.Field(
EntityManagementFleetDeploymentPhase, graphql_name="phase"
)
rings_deployment_tracker = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementRingDeploymentTracker),
graphql_name="ringsDeploymentTracker",
)1301. EntityManagementFleetEntity¶
A fleet of entities that are managed by NRAgentControl
Available fields:
description: User provided description for the fleetid: The entity’s global unique identifier.managedEntityRings: CollectionEntity that associates rings of managed entities for FleetmanagedEntityType: The type of entity the fleet will manage. e.g. HOSTmetadata: Metadata about the entity.name: A unique user provided name for the fleetoperatingSystem: The operating system type of the managed entities in this fleetproduct: Indicates this fleet has a specific product typescope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementFleetEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"description",
"managed_entity_rings",
"managed_entity_type",
"operating_system",
"product",
)
description = sgqlc.types.Field(String, graphql_name="description")
managed_entity_rings = sgqlc.types.Field(
EntityManagementCollectionEntity, graphql_name="managedEntityRings"
)
managed_entity_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementManagedEntityType),
graphql_name="managedEntityType",
)
operating_system = sgqlc.types.Field(
EntityManagementOperatingSystem, graphql_name="operatingSystem"
)
product = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="product"
)1302. EntityManagementFleetRingEntity¶
A group of Managed Entities in a fleet to which a fleet deployment is applied
Available fields:
fleetId: Ring’s Fleet IDid: The entity’s global unique identifier.managedEntities: CollectionEntity associated with the ringmetadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementFleetRingEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("fleet_id", "managed_entities")
fleet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="fleetId")
managed_entities = sgqlc.types.Field(
EntityManagementCollectionEntity, graphql_name="managedEntities"
)1303. EntityManagementFlowEntity¶
An entity representing a Pathpoint flow entity containing stages, steps, and configuration stored in a blob.
Available fields:
blob: The Blob containing the pathpoint flow data.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementFlowEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("blob",)
blob = sgqlc.types.Field(EntityManagementBlob, graphql_name="blob")1304. EntityManagementGenericEntity¶
A generic entity.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementGenericEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1305. EntityManagementGitHubIntegrationEntity¶
An entity representing github integration information
Available fields:
count: Composite count attribute encapsulating team and repo counts.gitHubRetentionOptions: Options for retain entities with GitHub integration.gitHubSyncOptions: Github sync options for customerid: The entity’s global unique identifier.installationId: The GitHub app installation ID.installationSource: source of github integration installationinstallationStatus: installation status of the GitHub applastSyncCompletedAt: last sync completed timestampmetadata: Metadata about the entity.name: The name of this entity.nextSyncAt: upcoming sync requested timestampscope: The entity’s scope.synchronizedGitHubTeams: Synchronized GitHub teams for customer team selection.tags: Collection of tags.type: The entity type.
class EntityManagementGitHubIntegrationEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"count",
"git_hub_retention_options",
"git_hub_sync_options",
"installation_id",
"installation_source",
"installation_status",
"last_sync_completed_at",
"next_sync_at",
"synchronized_git_hub_teams",
)
count = sgqlc.types.Field(EntityManagementCount, graphql_name="count")
git_hub_retention_options = sgqlc.types.Field(
EntityManagementGitHubRetentionOptions, graphql_name="gitHubRetentionOptions"
)
git_hub_sync_options = sgqlc.types.Field(
EntityManagementGitHubSyncOptions, graphql_name="gitHubSyncOptions"
)
installation_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="installationId"
)
installation_source = sgqlc.types.Field(
EntityManagementInstallationSource, graphql_name="installationSource"
)
installation_status = sgqlc.types.Field(
EntityManagementInstallationStatus, graphql_name="installationStatus"
)
last_sync_completed_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="lastSyncCompletedAt"
)
next_sync_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="nextSyncAt")
synchronized_git_hub_teams = sgqlc.types.Field(
EntityManagementSynchronizedGitHubTeams, graphql_name="synchronizedGitHubTeams"
)1306. EntityManagementGitRepositoryEntity¶
An entity representing a Repository of a organization
Available fields:
closedPullRequestCount: Count of closed pull requests(PR) in the repository.configuration: The latest Configuration Item associated to the repository. Contains a JSON representation of the repository configuration.description: The description of the repository.externalCreatedAt: Repository Creation date at code hosting tool like github, gitlab etcexternalId: External Unique Identifier in Code hosting systems like github,gitlab etc.externalLastDeployedAt: Last time the repository was deployed.externalOwner: External owner of the repository.externalUpdatedAt: Repository Updation date at code hosting tool like github, gitlab etcforkCount: Number of times Repository has been forked.hostingPlatform: Source of the repository.id: The entity’s global unique identifier.latestReleaseVersion: Last release version of the repository.license: License associated with the repositorylockedPullRequestCount: Count of locked pull requests(PR) in the repository.metadata: Metadata about the entity.name: The name of this entity.openPullRequestCount: Count of open pull requests(PR) in the repository.primaryLanguage: Most used language of the repository.scope: The entity’s scope.tags: Collection of tags.type: The entity type.url: Source Url of the repository eg:- gitUrl.
class EntityManagementGitRepositoryEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"closed_pull_request_count",
"configuration",
"description",
"external_created_at",
"external_id",
"external_last_deployed_at",
"external_owner",
"external_updated_at",
"fork_count",
"hosting_platform",
"latest_release_version",
"license",
"locked_pull_request_count",
"open_pull_request_count",
"primary_language",
"url",
)
closed_pull_request_count = sgqlc.types.Field(
Int, graphql_name="closedPullRequestCount"
)
configuration = sgqlc.types.Field(
EntityManagementConfiguration, graphql_name="configuration"
)
description = sgqlc.types.Field(String, graphql_name="description")
external_created_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="externalCreatedAt"
)
external_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="externalId"
)
external_last_deployed_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="externalLastDeployedAt"
)
external_owner = sgqlc.types.Field(
EntityManagementExternalOwner, graphql_name="externalOwner"
)
external_updated_at = sgqlc.types.Field(
EpochMilliseconds, graphql_name="externalUpdatedAt"
)
fork_count = sgqlc.types.Field(Int, graphql_name="forkCount")
hosting_platform = sgqlc.types.Field(
EntityManagementHostingPlatform, graphql_name="hostingPlatform"
)
latest_release_version = sgqlc.types.Field(
String, graphql_name="latestReleaseVersion"
)
license = sgqlc.types.Field(
EntityManagementRepositoryLicense, graphql_name="license"
)
locked_pull_request_count = sgqlc.types.Field(
Int, graphql_name="lockedPullRequestCount"
)
open_pull_request_count = sgqlc.types.Field(
Int, graphql_name="openPullRequestCount"
)
primary_language = sgqlc.types.Field(String, graphql_name="primaryLanguage")
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1307. EntityManagementGithubConnection¶
Connection entity type for Github
Available fields:
credential: A single credential from the choice of GithubCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.url: The Github API URL, default to https://api .github .com
class EntityManagementGithubConnection(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"settings",
"signing_credentials",
"url",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementGithubCredentials),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)
url = sgqlc.types.Field(String, graphql_name="url")1308. EntityManagementImpactProfileEntity¶
An entity representing impact profile.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: A unique user provided name for the impact profile.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementImpactProfileEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1309. EntityManagementInboxIssueCategoryEntity¶
Entity to represent category type configuration
Available fields:
categoryScope: Scope for this configurationcategoryType: New category Type. Start with capital letter.id: The entity’s global unique identifier.issueType: issue Type for category type. Should be pre-existed. New issue type have to be added manually in the code.messageAttributes: Message attributes provided in order. Application will fall back to second then third and so on if previous attribute not found or null or empty.metadata: Metadata about the entity.name: The name of this entity.nameAttributes: Name attributes in order. Application will fall back to second then third and so on if previous attribute not found or null or empty.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementInboxIssueCategoryEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"category_scope",
"category_type",
"issue_type",
"message_attributes",
"name_attributes",
)
category_scope = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementCategoryScope),
graphql_name="categoryScope",
)
category_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="categoryType"
)
issue_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementIssueType), graphql_name="issueType"
)
message_attributes = sgqlc.types.Field(
sgqlc.types.list_of(String), graphql_name="messageAttributes"
)
name_attributes = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(String)), graphql_name="nameAttributes"
)1310. EntityManagementIncidentAttachmentEntity¶
Represents a attachment entity used in incident
Available fields:
blob: Incident attachment Blobdescription: An optional description of the attachment, generally additional context about the attachmentid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementIncidentAttachmentEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("blob", "description")
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
description = sgqlc.types.Field(String, graphql_name="description")1311. EntityManagementIncidentEntity¶
Entity of type IncidentEntity.
Available fields:
assignedTo: The primary entity (user or team) responsible for the WorkItem.attributes: A flexible collection of key/value pair strings for storing domain-specific data.category: The high-level classification of the WorkItem (INCIDENT, ISSUE, VULNERABILITY, PERFORMANCE).customerImpact: Customer Impact Descriptiondescription: Detailed explanation of the WorkItem.dueDate: An optional Epoch timestamp indicating a potential due date (e.g., retrospective deadline).entitiesImpacted: Entities ImpactedexternalId: An optional, consumer-managed identifier (replaces incidentKey).id: The entitys global unique identifier.incidentCategory: Primary classification of the incident (e.g., Network, Software). Max length: 64 characters.incidentKey: A public-facing, human-readable identifier for the incident.incidentProfileId: The incident profile entity global unique identifier.incidentSubcategory: Secondary classification, dependent on the category. Max length: 64 characters.issueLinks: A list of issue links related to the incidentlabels: An optional list of alphanumeric tags or keywords (replaces incidentTags).lessonsLearned: Key takeaways and lessons learned from the incident and its resolution.links: A collection entity linking to external tickets or related documents.maxSeverity: The maximum severity level reached during the incident lifecycle.messages: A collection entity holding the stream of messages/notes (e.g., incident timeline).metadata: Metadata about the entity.name: The name or title of the message.priority: The relative importance or urgency of the WorkItem.reportedBy: The end-user who reported the incident, if different from the creator.resolutionCategory: The category of the resolution (e.g., Code Fix, Configuration Change).resolutionSummary: A summary of the steps taken to resolve the incident.retroActionItems: A list of references to work items that represent action items from the retrospective.rootCauseSummary: A detailed summary of the root cause analysis findings.rootCauseTags: Tags associated with the root cause for categorization and analysis.scope: The entitys scope.severity: Represents the severity level of the incident, Can be customer-configured.source: The originating system that created the incident record. Slack, UIstatus: The workitem status. statuscan be customised for each WorkItem independently, and can be a completely different set than the core status listtags: Collection of tags.timelines: Incident timelinestriggeringEvent: The specific event or action that initiated the incident.type: The entitys type.
class EntityManagementIncidentEntity(
sgqlc.types.Type, EntityManagementEntity, EntityManagementWorkItemV2
):
__schema__ = nerdgraph
__field_names__ = (
"customer_impact",
"entities_impacted",
"incident_category",
"incident_key",
"incident_profile_id",
"incident_subcategory",
"issue_links",
"lessons_learned",
"max_severity",
"reported_by",
"resolution_category",
"resolution_summary",
"retro_action_items",
"root_cause_summary",
"root_cause_tags",
"severity",
"source",
"timelines",
"triggering_event",
)
customer_impact = sgqlc.types.Field(String, graphql_name="customerImpact")
entities_impacted = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="entitiesImpacted",
)
incident_category = sgqlc.types.Field(String, graphql_name="incidentCategory")
incident_key = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="incidentKey"
)
incident_profile_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="incidentProfileId"
)
incident_subcategory = sgqlc.types.Field(String, graphql_name="incidentSubcategory")
issue_links = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="issueLinks"
)
lessons_learned = sgqlc.types.Field(String, graphql_name="lessonsLearned")
max_severity = sgqlc.types.Field(String, graphql_name="maxSeverity")
reported_by = sgqlc.types.Field(String, graphql_name="reportedBy")
resolution_category = sgqlc.types.Field(String, graphql_name="resolutionCategory")
resolution_summary = sgqlc.types.Field(String, graphql_name="resolutionSummary")
retro_action_items = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)), graphql_name="retroActionItems"
)
root_cause_summary = sgqlc.types.Field(String, graphql_name="rootCauseSummary")
root_cause_tags = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="rootCauseTags"
)
severity = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="severity")
source = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementIncidentSource), graphql_name="source"
)
timelines = sgqlc.types.Field(
EntityManagementCollectionEntity, graphql_name="timelines"
)
triggering_event = sgqlc.types.Field(String, graphql_name="triggeringEvent")1312. EntityManagementIncidentLinkEntity¶
Entity representing an incident link.
Available fields:
externalId: An optional external identifier for this link from a synced system.id: The entitys global unique identifier.metadata: Metadata about the entity.name: The name or title of the link.scope: The entitys scope.sourceSyncConfigurationId: The ID of the sync configuration that created this link.tags: Collection of tags.type: The entitys type.url: The URL of the external resource.
class EntityManagementIncidentLinkEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("external_id", "source_sync_configuration_id", "url")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
source_sync_configuration_id = sgqlc.types.Field(
ID, graphql_name="sourceSyncConfigurationId"
)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1313. EntityManagementIncidentMessageEntity¶
Entity representing an incident message.
Available fields:
content: The message content.contentEncoding: The encoding used for the message content.contentType: The type of message content (e.g., TEXT, HTML, MARKDOWN).externalId: An optional external identifier for this message from a synced system.id: The entitys global unique identifier.metadata: Metadata about the entity.name: The name or title of the message.parentId: The ID of the parent message if this is a reply or threaded message.scope: The entitys scope.sourceSyncConfigurationId: The ID of the sync configuration that created this message.tags: Collection of tags.type: The entitys type.
class EntityManagementIncidentMessageEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"content",
"content_encoding",
"content_type",
"external_id",
"parent_id",
"source_sync_configuration_id",
)
content = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="content")
content_encoding = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementEncodingType),
graphql_name="contentEncoding",
)
content_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementMessageType), graphql_name="contentType"
)
external_id = sgqlc.types.Field(String, graphql_name="externalId")
parent_id = sgqlc.types.Field(ID, graphql_name="parentId")
source_sync_configuration_id = sgqlc.types.Field(
ID, graphql_name="sourceSyncConfigurationId"
)1314. EntityManagementIncidentProfileAttachmentEntity¶
Represents a attachment entity used in profile
Available fields:
blob: Incident profile attachment Blobdescription: An optional description of the attachment, generally additional context about the attachmentid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementIncidentProfileAttachmentEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("blob", "description")
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
description = sgqlc.types.Field(String, graphql_name="description")1315. EntityManagementIncidentProfileEntity¶
Incident profile entity
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the Incident Profilescope: The entity’s scope.tags: Collection of tags.type: The entity’s type.
class EntityManagementIncidentProfileEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1316. EntityManagementIncidentTimelineEntity¶
Entity of type IncidentTimeline.
Available fields:
content: The content of the entry, which can include rich text formatting.entryType: The type of entry (e.g., NOTE, PROPOSED_CHANGE, KEY_MOMENTS, STATE).id: The entitys global unique identifier.metadata: Metadata about the entity.name: The name or title of the message.scope: The entitys scope.source: The source of the timeline entrytags: Collection of tags.type: The entitys type.
class EntityManagementIncidentTimelineEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("content", "entry_type", "source")
content = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="content")
entry_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="entryType"
)
source = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementIncidentTimelineSource),
graphql_name="source",
)1317. EntityManagementJiraConnection¶
Connection entity type for Jira
Available fields:
credential: A single credential from the choice of JiraCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.url: The Jira instance URL
class EntityManagementJiraConnection(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"settings",
"signing_credentials",
"url",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementJiraCredentials), graphql_name="credential"
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1318. EntityManagementJiraSyncConfigurationV2Entity¶
Jira Sync Configuration entity type
Available fields:
bidirectional: Direction of the sync, true for 2-way, false for 1-way from New Relic to Jira.connection: A reference to a connection entity for the 3rd party ticketing system, using NGEP identifier.description: Description of the sync configurationenabled: Flag to indicate if the sync is enabled or notid: The entity’s global unique identifier.issueType: The issue type of the Jira issue to be created: STORY, TASK, BUGmetadata: Metadata about the entity.mode: Sync configuration mode.name: The name of this entity.projectKey: The key of the Jira project where the issue will be createdscope: The entity’s scope.tags: Collection of tags.targets: A list of tags to match against a specific WorkItem set of tags to determine if the WorkItem should be synced.templateFields: The list of fields and their mapping from the WorkItem entitytype: The entity type.
class EntityManagementJiraSyncConfigurationV2Entity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"bidirectional",
"connection",
"description",
"enabled",
"issue_type",
"mode",
"project_key",
"targets",
"template_fields",
)
bidirectional = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="bidirectional"
)
connection = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="connection")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
issue_type = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementJiraIssueType), graphql_name="issueType"
)
mode = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSyncConfigurationMode), graphql_name="mode"
)
project_key = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="projectKey"
)
targets = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementTag))
),
graphql_name="targets",
)
template_fields = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementTemplateFieldType))
),
graphql_name="templateFields",
)1319. EntityManagementJuniperMistConnectionEntity¶
Connection entity type for Juniper Mist
Available fields:
credential: A single credential for Juniper Mistdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.region: The Juniper Mist region (e.g., Global 01, Global 02, Global 03, Global 04)scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.
class EntityManagementJuniperMistConnectionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"region",
"settings",
"signing_credentials",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementJuniperMistCredential),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
region = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="region")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)1320. EntityManagementMaintenanceWindowEntity¶
Represents Maintenance window entity.
Available fields:
affectedEntityType: The type of the entities affected by maintenance window.description: The description of the maintenance window.duration: The duration of the maintenance window in ISO8601 duration formatted string.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.rrule: The recurrence rule for the maintenance window.scope: The entity’s scope.startTime: The start of maintenance window in ISO8601 UTC formatted string.tags: Collection of tags.timezone: The timezone in which the maintenance window is scheduled.type: The entity type.
class EntityManagementMaintenanceWindowEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"affected_entity_type",
"description",
"duration",
"rrule",
"start_time",
"timezone",
)
affected_entity_type = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="affectedEntityType"
)
description = sgqlc.types.Field(String, graphql_name="description")
duration = sgqlc.types.Field(
sgqlc.types.non_null(Duration), graphql_name="duration"
)
rrule = sgqlc.types.Field(String, graphql_name="rrule")
start_time = sgqlc.types.Field(
sgqlc.types.non_null(DateTime), graphql_name="startTime"
)
timezone = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="timezone")1321. EntityManagementManagedEvaluationsEntity¶
Experimental feature for managed evaluations
Available fields:
description: The entity description.evaluations: List of evaluation configurations for this entityid: The entity’s global unique identifier.metadata: Metadata about the entity.name: A unique user provided name for the evaluation.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementManagedEvaluationsEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("description", "evaluations")
description = sgqlc.types.Field(String, graphql_name="description")
evaluations = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementManagedEvaluationConfig)
)
),
graphql_name="evaluations",
)1322. EntityManagementMcpServerEntity¶
MCP Server entity for agentic-platform
Available fields:
auth: Authentication configuration for connecting to the MCP serverdescription: short description of the MCP server used for validation by agentic-platformdisplayName: display name for the mcp serverendpoint: Endpoint for the MCP serverid: entity’s unique global indentifiermetadata: tool metadataname: unique name of the MCP server used for validation by agentic-platformprotocolVersion: Protocol version expected (if empty assume latest supported)scope: entity scopetags: collection of tagstransport: Transport mechanism used to communicate with the servertype: entity type
class EntityManagementMcpServerEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"auth",
"description",
"display_name",
"endpoint",
"protocol_version",
"transport",
)
auth = sgqlc.types.Field(EntityManagementMcpServerAuth, graphql_name="auth")
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)
display_name = sgqlc.types.Field(String, graphql_name="displayName")
endpoint = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="endpoint")
protocol_version = sgqlc.types.Field(String, graphql_name="protocolVersion")
transport = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementMcpTransport), graphql_name="transport"
)1323. EntityManagementMeterEntity¶
An entity representing a Meter used to report customer-driven usage and associated contextual data, primarily for billing.
Available fields:
attributes: Collection of attributes associated with the meter.description: Human understandable 1 liner explaining the meter’s purpose.id: The entity’s global unique identifier.metadata: Metadata about the entity.meterType: Reference to the meter type entity that defines how usage is calculated.name: Human understandable identifier for the meter.owningTeam: Reference to the owning team entity that is responsible for reporting usage with this meter.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementMeterEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("attributes", "description", "meter_type", "owning_team")
attributes = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementMeterAttribute)),
graphql_name="attributes",
)
description = sgqlc.types.Field(String, graphql_name="description")
meter_type = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementMeterTypeEntity"),
graphql_name="meterType",
)
owning_team = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamEntity"), graphql_name="owningTeam"
)1324. EntityManagementMeterTypeEntity¶
A meter type defines a way of calculating usage and what dimensions are guaranteed to be reported with that usage.
Available fields:
allowMeterCreation: Determines whether this meter type can be used to create meters.attributionDimensions: The names of dimensions that this meter type expects to report.description: Human understandable 1 liner explaining the meter type’s purpose.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: Human understandable identifier for the meter type.owningTeam: Reference to the owning team entity that is responsible for this meter type.productLine: Reference to the product line entity that this meter type belongs to.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementMeterTypeEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"allow_meter_creation",
"attribution_dimensions",
"description",
"owning_team",
"product_line",
)
allow_meter_creation = sgqlc.types.Field(
sgqlc.types.non_null(Boolean), graphql_name="allowMeterCreation"
)
attribution_dimensions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)),
graphql_name="attributionDimensions",
)
description = sgqlc.types.Field(String, graphql_name="description")
owning_team = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementTeamEntity"), graphql_name="owningTeam"
)
product_line = sgqlc.types.Field(
sgqlc.types.non_null("EntityManagementProductLineEntity"),
graphql_name="productLine",
)1325. EntityManagementNewRelicConnection¶
Connection entity type for New Relic
Available fields:
credential: A single credential from the choice of NewRelicCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.region: The NewRelic regionscope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.
class EntityManagementNewRelicConnection(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"region",
"settings",
"signing_credentials",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementNewRelicBasicAuthCredential),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
region = sgqlc.types.Field(String, graphql_name="region")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)1326. EntityManagementNotebookEntity¶
An entity representing a New Relic Notebook.
Available fields:
content: Configuration of the notebook, including the content of each of its blocks.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementNotebookEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("content",)
content = sgqlc.types.Field(EntityManagementBlob, graphql_name="content")1327. EntityManagementNotificationAttachmentEntity¶
Represents a attachment entity used in notifications
Available fields:
blob: Notification attachment Blobdescription: An optional description of the attachment, generally additional context about the attachmentid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementNotificationAttachmentEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("blob", "description")
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
description = sgqlc.types.Field(String, graphql_name="description")1328. EntityManagementNrAiAgentEntity¶
This is Nr Ai Agent Entity, currently under development.
Available fields:
displayName: display name of the agentid: entity’s global identifiermetadata: agent metadataname: unique name of the agent entityscope: entity scopetags: collection of tagstype: entity typeversion: version of the AiAgent
class EntityManagementNrAiAgentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("display_name", "version")
display_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="displayName"
)
version = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="version")1329. EntityManagementNrqlMacroEntity¶
A reusable NRQL macro that can be substituted into NRQL queries to simplify complex or frequently-used query patterns.
NRQL macros allow you to define query fragments that can be referenced and expanded in your queries, reducing duplication and improving maintainability. For example, you might create a macro for filtering out test data, calculating a specific metric, or defining commonly-used WHERE conditions.
Example Macro Expression¶
A macro for filtering production traffic:
environment = 'production' AND appName NOT LIKE '%test%'This macro could be used in WHERE clauses across multiple queries.
For more information about NRQL, see NRQL documentation.
Available fields:
expression: The NRQL expression that will be substituted when this macro is used in a query.
This can be any valid NRQL fragment appropriate for the supported clause(s). Examples:
WHERE clause:
environment = 'production' AND appName NOT LIKE '%test%'SELECT clause:
average(duration) / 1000 as 'avgDurationSeconds'FACET clause:
appName, host
id: The entity’s global unique identifier.metadata: System-generated metadata about this macro entity, including creation time, last update time, and version information.name: A unique, human-readable name for this macro. This name is used to identify and reference the macro.
The name cannot be changed after creation. Choose a descriptive name that indicates the macro’s purpose, such as ‘filterProductionTraffic’ or ‘calculateApdex’.
numParameters: The number of parameters used in the macro expression. Not required if the value is 0.
Within the macro expression, parameters are referenced by index as 2,...
scope: The entity’s scope.tags: Key-value pairs of tags. Tags are inherited from the Entity interface.type: The entity type identifier. Always returns ‘NRQL_MACRO’ for this entity type.
class EntityManagementNrqlMacroEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("expression", "num_parameters")
expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="expression"
)
num_parameters = sgqlc.types.Field(Int, graphql_name="numParameters")1330. EntityManagementOperationEntity¶
Entity of type OperationEntity.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementOperationEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1331. EntityManagementOperationMetricEntity¶
Entity of type OperationMetricEntity.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementOperationMetricEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ()1332. EntityManagementPerformanceInboxSettingEntity¶
Performance inbox setting entity. This entity encompasses all the performance inbox settings.
Available fields:
config: Collection of configs for performance inbox settings.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.thresholdScope: The scope at which the thresholds are applied.type: The entity type.
class EntityManagementPerformanceInboxSettingEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("config", "threshold_scope")
config = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConfig)),
graphql_name="config",
)
threshold_scope = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementThresholdScope),
graphql_name="thresholdScope",
)1333. EntityManagementPipelineCloudRuleEntity¶
A rule applied to telemetry data to modify how it’s processed in some way
Available fields:
description: Description of this pipeline cloud rule.enabled: The enabled boolean field used to enable or disable a Pipeline Cloud Rule (default value will be true)id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.nrql: The NRQL string used to specify the action you want to take and data you want to take the specified action on.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementPipelineCloudRuleEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description", "enabled", "nrql")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
nrql = sgqlc.types.Field(sgqlc.types.non_null(Nrql), graphql_name="nrql")1334. EntityManagementProductLineEntity¶
A product line represents a grouping of related products or services within the organization.
Available fields:
description: Human understandable 1 liner explaining the product line’s purpose.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: Human understandable identifier for the product line.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementProductLineEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(String, graphql_name="description")1335. EntityManagementRagDocumentEntity¶
A RAG Document
Available fields:
authorEmails: The email addresses of authors not found in the organizationblob: The blob representation of the document.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the document.scope: The entity’s scope.sourceIdentifier: Optional source identifier that identifies where the document came fromtags: Collection of tags.type: The entity type.
class EntityManagementRagDocumentEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("author_emails", "blob", "source_identifier")
author_emails = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="authorEmails"
)
blob = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementBlob), graphql_name="blob"
)
source_identifier = sgqlc.types.Field(String, graphql_name="sourceIdentifier")1336. EntityManagementRagToolEntity¶
A tool for use with NRAI
Available fields:
description: The description of the tool.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the toolscope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementRagToolEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description",)
description = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="description"
)1337. EntityManagementReactNativeSourcemapEntity¶
entityType for React native sourcemaps
Available fields:
appVersionId: The version of the mobile application this source-map belongs toapplicationId: The applicationId of the underlying mobile application this source-map belongs toblob: The Blob associated to the entity.id: The entity’s global unique identifier.jsBundleId: The unique identifier for the JS bundle built for the mobile application this source-map belongs tometadata: Metadata about the entity.name: The name of this entity(sourcemap).scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementReactNativeSourcemapEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("app_version_id", "application_id", "blob", "js_bundle_id")
app_version_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="appVersionId"
)
application_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="applicationId"
)
blob = sgqlc.types.Field(EntityManagementBlob, graphql_name="blob")
js_bundle_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="jsBundleId"
)1338. EntityManagementRestApiContractEntity¶
Entity of type RestApiContractEntity.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of the Api Contractscope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementRestApiContractEntity(
sgqlc.types.Type, EntityManagementApiCatalogApiContract, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ()1339. EntityManagementScorecardEntity¶
An entity with collection of scorecard rules.
Available fields:
description: The scorecard description.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: A unique user provided name for the scorecard.progressLevels: Represents the different progress levels within a scorecard. A maximum of 5 progress levels are allowed.rules: List of rules in the scorecard.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementScorecardEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description", "progress_levels", "rules")
description = sgqlc.types.Field(String, graphql_name="description")
progress_levels = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(EntityManagementProgressLevelDefinition)
),
graphql_name="progressLevels",
)
rules = sgqlc.types.Field(EntityManagementCollectionEntity, graphql_name="rules")1340. EntityManagementScorecardRuleEntity¶
An entity representing rule in scorecards.
Available fields:
description: The rule description.enabled: Is rule enabled.id: The entity’s global unique identifier.impactWeight: The weight this rule has on the overall Scorecard Score. This number is a whole integer with valid values from 1 to 100.lastExecutionStatus: Last execution status of the rulemetadata: Metadata about the entity.name: A unique user provided name for the rulenrqlEngine: The NRQL rule engine.progressLevel: The id of the progress level this rule falls in. This id must match one of the existing ids in the parent Scorecard levels field.runInterval: The run interval in minutes. This defines how often the rule will be executed.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementScorecardRuleEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"description",
"enabled",
"impact_weight",
"last_execution_status",
"nrql_engine",
"progress_level",
"run_interval",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(sgqlc.types.non_null(Boolean), graphql_name="enabled")
impact_weight = sgqlc.types.Field(Int, graphql_name="impactWeight")
last_execution_status = sgqlc.types.Field(
EntityManagementRuleExecutionStatus, graphql_name="lastExecutionStatus"
)
nrql_engine = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementNrqlRuleEngine), graphql_name="nrqlEngine"
)
progress_level = sgqlc.types.Field(ID, graphql_name="progressLevel")
run_interval = sgqlc.types.Field(Int, graphql_name="runInterval")1341. EntityManagementSegmentTermsEntity¶
Segment Terms for Mobile
Available fields:
appEntityId: Mobile/Browser app entity id associated with the Segment Termschannel: Channel associated with the Segment Termsdomain: Domain associated with the Segment Termsid: The entity’s global unique identifier.metadata: Metadata about the entity.metricPrefix: Metric Prefix associated with the Segment Termsname: The name of this entity.oldId: Old Integer id for backward compatibilityscope: The entity’s scope.tags: Collection of tags.type: The entity type.urlSegments: Array of url segments as strings
class EntityManagementSegmentTermsEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"app_entity_id",
"channel",
"domain",
"metric_prefix",
"old_id",
"url_segments",
)
app_entity_id = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="appEntityId"
)
channel = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementChannelType), graphql_name="channel"
)
domain = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="domain")
metric_prefix = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="metricPrefix"
)
old_id = sgqlc.types.Field(Int, graphql_name="oldId")
url_segments = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(String)), graphql_name="urlSegments"
)1342. EntityManagementServerlessJobDefinitionEntity¶
Represents a ServerlessJobDefinition entity for the Job Primitive platform. Defines runtime properties, compute requirements, health checks and other parameters required for running serverless jobs.
Available fields:
description: User provided description for the ServerlessJobDefinition.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: A unique user provided name for the ServerlessJobDefinition, can be utilized for ServerlessJobDefinition querying.namespace: Namespace corresponding to the onboarding team for the ServerlessJobDefinition.scope: The entity’s scope.secretKeys: Secret key names associated with the ServerlessJobDefinition for secure configuration.tags: Collection of tags.type: The entity type.
class EntityManagementServerlessJobDefinitionEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("description", "namespace", "secret_keys")
description = sgqlc.types.Field(String, graphql_name="description")
namespace = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="namespace"
)
secret_keys = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="secretKeys"
)1343. EntityManagementServiceNowConnection¶
Connection entity type for ServiceNow
Available fields:
credential: A single credential from the choice of ServiceNowCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. False by default.externalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.url: The ServiceNow instance URL, for example https://your -instance .service -now .com
class EntityManagementServiceNowConnection(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"external_id",
"settings",
"signing_credentials",
"url",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementServiceNowCredentials),
graphql_name="credential",
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1344. EntityManagementSlackConnection¶
Connection entity type for Slack
Available fields:
appId: The Slack Application IDdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. True by defaultexternalId: Optional field representing an identifier managed by the consumerid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.token: Slack bot tokentype: The entity’s type.workspace: Workspace name
class EntityManagementSlackConnection(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"app_id",
"description",
"enabled",
"external_id",
"settings",
"signing_credentials",
"token",
"workspace",
)
app_id = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="appId")
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
external_id = sgqlc.types.Field(String, graphql_name="externalId")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)
token = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementSecretReference), graphql_name="token"
)
workspace = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="workspace"
)1345. EntityManagementStatusPageAnnouncementEntity¶
An entity representing an end of life announcement published on a status page.
Available fields:
category: The entity category.communicationLogs: Communications happened during the incidentdescription: The incident description.effectiveDate: Effective date time for the Announcement eventeventUrl: Event URL for the announcementid: The entity’s global unique identifier.impactQuery: Impact query for the announcementmetadata: Metadata about the entity.name: Name for the event.pointOfContacts: Valid User entities of PMs / Engineering point of contactspublishedDate: Announcement event published date timescope: The entity’s scope.state: The state of an announcementtags: Collection of tags.type: The entity type.
class EntityManagementStatusPageAnnouncementEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"category",
"communication_logs",
"description",
"effective_date",
"event_url",
"impact_query",
"point_of_contacts",
"published_date",
"state",
)
category = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementStatusPageAnnouncementCategory),
graphql_name="category",
)
communication_logs = sgqlc.types.Field(
sgqlc.types.list_of(EntityManagementCommunicationLog),
graphql_name="communicationLogs",
)
description = sgqlc.types.Field(String, graphql_name="description")
effective_date = sgqlc.types.Field(EpochMilliseconds, graphql_name="effectiveDate")
event_url = sgqlc.types.Field(String, graphql_name="eventUrl")
impact_query = sgqlc.types.Field(
EntityManagementImpactQuery, graphql_name="impactQuery"
)
point_of_contacts = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null("EntityManagementUserEntity")),
graphql_name="pointOfContacts",
)
published_date = sgqlc.types.Field(EpochMilliseconds, graphql_name="publishedDate")
state = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementStatusPageAnnouncementState),
graphql_name="state",
)1346. EntityManagementStatusPageIncidentEntity¶
An entity representing an incident published on a status page.
Available fields:
communicationLogs: Communications happened during the incidentdescription: The incident description.endTime: Incident end timeid: The entity’s global unique identifier.incidentId: Incident IdincidentTitle: Incident titlelastUpdatedTime: Incident last updated timemetadata: Metadata about the entity.name: A unique user provided name for the incident.region: Incident impact regionscope: The entity’s scope.startTime: Incident start timestatus: The incident status.tags: Collection of tags.type: The entity type.
class EntityManagementStatusPageIncidentEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = (
"communication_logs",
"description",
"end_time",
"incident_id",
"incident_title",
"last_updated_time",
"region",
"start_time",
"status",
)
communication_logs = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementCommunicationLog)),
graphql_name="communicationLogs",
)
description = sgqlc.types.Field(String, graphql_name="description")
end_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="endTime")
incident_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="incidentId")
incident_title = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="incidentTitle"
)
last_updated_time = sgqlc.types.Field(
EpochMilliseconds, graphql_name="lastUpdatedTime"
)
region = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementRegion)),
graphql_name="region",
)
start_time = sgqlc.types.Field(EpochMilliseconds, graphql_name="startTime")
status = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementIncidentStatus), graphql_name="status"
)1347. EntityManagementSystemActor¶
A system actor.
Available fields:
id: Id of the actor.type: Type of the actor.
class EntityManagementSystemActor(sgqlc.types.Type, EntityManagementActor):
__schema__ = nerdgraph
__field_names__ = ()1348. EntityManagementTeamEntity¶
An entity representing a New Relic Team.
Available fields:
aliases: List of aliases associated to the team.description: Further information about team.externalIntegration: External Integration with another system.hierarchyLevelId: The hierarchy level the team belongs to.id: The entity’s global unique identifier.managers: The managers or contact persons for the team.membership: Collection that contains the list of members belonging to the team.metadata: Metadata about the entity.name: The name of this entity.ownership: Collection that contains the list of entities owned by the team.parentId: The parent team in the hierarchy.resources: List of resources attached to the team.scope: The entity’s scope.tags: Collection of tags.type: The entity type.
class EntityManagementTeamEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"aliases",
"description",
"external_integration",
"hierarchy_level_id",
"managers",
"membership",
"ownership",
"parent_id",
"resources",
)
aliases = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(String)), graphql_name="aliases"
)
description = sgqlc.types.Field(String, graphql_name="description")
external_integration = sgqlc.types.Field(
EntityManagementTeamExternalIntegration, graphql_name="externalIntegration"
)
hierarchy_level_id = sgqlc.types.Field(ID, graphql_name="hierarchyLevelId")
managers = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)), graphql_name="managers"
)
membership = sgqlc.types.Field(
EntityManagementCollectionEntity, graphql_name="membership"
)
ownership = sgqlc.types.Field(
EntityManagementCollectionEntity, graphql_name="ownership"
)
parent_id = sgqlc.types.Field(ID, graphql_name="parentId")
resources = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementTeamResource)),
graphql_name="resources",
)1349. EntityManagementTeamsHierarchyLevelEntity¶
A teams hierarchy level for the organization.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: List of tags.type: The entity type.
class EntityManagementTeamsHierarchyLevelEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ()1350. EntityManagementTeamsOrganizationSettingsEntity¶
Teams global settings per organization.
Available fields:
discovery: Discovery settings.hierarchyLevelOrder: The order of the teams hierarchy levels for the organization.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.syncGroups: Sync groups settings.tags: Collection of tags.type: The entity type.
class EntityManagementTeamsOrganizationSettingsEntity(
sgqlc.types.Type, EntityManagementEntity
):
__schema__ = nerdgraph
__field_names__ = ("discovery", "hierarchy_level_order", "sync_groups")
discovery = sgqlc.types.Field(
EntityManagementDiscoverySettings, graphql_name="discovery"
)
hierarchy_level_order = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ID)),
graphql_name="hierarchyLevelOrder",
)
sync_groups = sgqlc.types.Field(
EntityManagementSyncGroupsSettings, graphql_name="syncGroups"
)1351. EntityManagementUserActor¶
A user actor.
Available fields:
id: Id of the actor.type: Type of the actor.
class EntityManagementUserActor(sgqlc.types.Type, EntityManagementActor):
__schema__ = nerdgraph
__field_names__ = ()1352. EntityManagementUserEntity¶
An entity representing a New Relic User.
Available fields:
id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.tags: Collection of tags.type: The entity type.userId: User domain identifier.
class EntityManagementUserEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("user_id",)
user_id = sgqlc.types.Field(sgqlc.types.non_null(Int), graphql_name="userId")1353. EntityManagementWorkItemLinkV2Entity¶
Work Item Link entity type
Available fields:
externalId: External identifier for the work item linkid: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.scope: The entity’s scope.sourceSyncConfigurationId: Indicates which syncConfigurationId if any created this link. Creation managed internally from INBOUND synctags: Collection of tags.type: The entity type.url: URL of the work item link
class EntityManagementWorkItemLinkV2Entity(
sgqlc.types.Type, EntityManagementEntity, EntityManagementWorkItemLinkV2
):
__schema__ = nerdgraph
__field_names__ = ()1354. EntityManagementWorkItemMessageV2Entity¶
Work Item Message entity type
Available fields:
content: The message contentcontentEncoding: The message encoding: UTF8(default), BASE64contentType: The message type: TEXT(default), JSON, YAMLexternalId: Optional field representing an identifier managed by the consumer. There is no unique constraint enforced since the field is optional with non unique default value (null).id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of this entity.parentId: Optional id of the WorkItemMessage parent. This can be used to implement a replyTo functionality.scope: The entity’s scope.sourceSyncConfigurationId: Optional (internal readonly), indicate which syncConfigurationId if any created this message. Creation managed internally from INBOUND synctags: Collection of tags.type: The entity type.
class EntityManagementWorkItemMessageV2Entity(
sgqlc.types.Type, EntityManagementEntity, EntityManagementWorkItemMessageV2
):
__schema__ = nerdgraph
__field_names__ = ()1355. EntityManagementWorkItemV2Entity¶
Work Item entity type
Available fields:
assignedTo: Assigned entity of a work itemattributes: Collection of Work Item attributescategory: Category of the Work Item. Can set a different value on Create, cannot change on Updatedescription: Description of the Work ItemdueDate: Optional Epoch timestamp in milliseconds to indicate a potential due date.externalId: Represents an identifier managed by the consumerid: The entity’s global unique identifier.labels: Optional list of label as alphanumeric string.links: Collection of Work Item Linksmessages: Collection of Work Item messagesmetadata: Metadata about the entity.name: The name of this entity.priority: Priority of the work itemscope: The entity’s scope.status: Status of the work itemtags: Collection of tags.type: The entity type.
class EntityManagementWorkItemV2Entity(
sgqlc.types.Type, EntityManagementEntity, EntityManagementWorkItemV2
):
__schema__ = nerdgraph
__field_names__ = ()1356. EntityManagementWorkflowDefinition¶
Represents a workflow definition entity
Available fields:
description: An optional description of the workflow definitionid: The entity’s global unique identifier.metadata: Metadata about the entity.name: Unique name of the workflow definitionscope: The entity’s scope.tags: Collection of tags.type: The entity type.versions: An array of all the Versions of that definition
class EntityManagementWorkflowDefinition(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = ("description", "versions")
description = sgqlc.types.Field(String, graphql_name="description")
versions = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(Int))),
graphql_name="versions",
)1357. EntityManagementWorkflowSchedule¶
Represents a workflow schedule entity
Available fields:
cronExpression: The cron expression that defines the scheduledefinition: The Workflow Definition Version that this schedule is fordescription: An optional description of the workflow scheduleid: The entity’s global unique identifier.metadata: Metadata about the entity.name: Workflow Schedule nameoverlapPolicy: Overlap policy for the workflow schedulescope: The entity’s scope.tags: Collection of tags.timezone: An optional timezone of the workflow schedule.type: The entity type.
class EntityManagementWorkflowSchedule(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"cron_expression",
"definition",
"description",
"overlap_policy",
"timezone",
)
cron_expression = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="cronExpression"
)
definition = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementWorkflowDefinitionVersion),
graphql_name="definition",
)
description = sgqlc.types.Field(String, graphql_name="description")
overlap_policy = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementOverlapPolicy),
graphql_name="overlapPolicy",
)
timezone = sgqlc.types.Field(String, graphql_name="timezone")1358. EntityManagementZoomConnectionEntity¶
Connection entity type for Zoom
Available fields:
credential: A single credential from the choice of ZoomCredentialdescription: The description of that connection.enabled: Flag to indicate if the connection is enabled. False by default.id: The entity’s global unique identifier.metadata: Metadata about the entity.name: The name of that connection.scope: The entity’s scope.settings: Optional list of connection settingssigningCredentials: Array of up to 2 SigningCredential to verify incoming requests, and rotate new signing credentials when neededtags: Collection of tags.type: The entity’s type.
class EntityManagementZoomConnectionEntity(sgqlc.types.Type, EntityManagementEntity):
__schema__ = nerdgraph
__field_names__ = (
"credential",
"description",
"enabled",
"settings",
"signing_credentials",
)
credential = sgqlc.types.Field(
sgqlc.types.non_null(EntityManagementZoomCredentials), graphql_name="credential"
)
description = sgqlc.types.Field(String, graphql_name="description")
enabled = sgqlc.types.Field(Boolean, graphql_name="enabled")
settings = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementConnectionSettings)),
graphql_name="settings",
)
signing_credentials = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(EntityManagementSigningCredential)),
graphql_name="signingCredentials",
)1359. EntityRelationshipDetectedEdge¶
An entity relationship automatically detected by NewRelic.
Available fields:
createdAt: The time the relationship was created.source: The source entity of the relationship.target: The target entity of the relationship.type: The type of the relationship.
class EntityRelationshipDetectedEdge(sgqlc.types.Type, EntityRelationshipEdge):
__schema__ = nerdgraph
__field_names__ = ()1360. EntityRelationshipUserDefinedEdge¶
An entity user-defined relationship.
Available fields:
createdAt: The time the relationship was created.createdByUser: The user that created the relationship.source: The source entity of the relationship.target: The target entity of the relationship.type: The type of the relationship.
class EntityRelationshipUserDefinedEdge(sgqlc.types.Type, EntityRelationshipEdge):
__schema__ = nerdgraph
__field_names__ = ("created_by_user",)
created_by_user = sgqlc.types.Field(UserReference, graphql_name="createdByUser")1361. ErrorsInboxAssignErrorGroupError¶
Assign error group error
Available fields:
description: The description of the errortype: The error type
class ErrorsInboxAssignErrorGroupError(sgqlc.types.Type, ErrorsInboxResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(ErrorsInboxAssignErrorGroupErrorType), graphql_name="type"
)1362. ErrorsInboxErrorGroup¶
A grouping of similar error events with all fields.
Available fields:
assignment: User assigned to the error groupentityGuid: Source entity GuideventsQuery: NRQL formatted query for retrieving error eventsfirstSeenAt: Time of first occurrencefirstSeenVersions: Versions running within 30 min after this error was first seen, ordered alphanumerically Note: This field requires additional queries that may slow down the responseid: A unique identifier for the error groupisCustom: Indicates whether this error group was custom generated.
false = this is a system-generated error group
true = this is a custom error group, created and sent by the end user
issueType: Indicates the type of issue
PERFORMANCE = Any performance issue like slow query, NPlusOneQuery, etc falls under this issue type
ERROR = Any error like TransactionError, MobileRequestError, etc falls under this issue type
lastSeenAt: Time of last occurrencelastSeenVersions: Versions running within 30 min before this error was last seen, ordered alphanumerically Note: This field requires additional queries that may slow down the responsemessage: Error group messagename: Error group nameoccurrences: The occurrences of this error group.regressedAt: Time of regression occurrence for regressed error groupsresources: List of resources associated with this error groupsource: The source event of the error group.state: Value to indicate the current state of the group.url: The public URL of the error group detail view.
class ErrorsInboxErrorGroup(sgqlc.types.Type, ErrorsInboxErrorGroupBase):
__schema__ = nerdgraph
__field_names__ = ("first_seen_versions", "last_seen_versions")
first_seen_versions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ErrorsInboxVersion)),
graphql_name="firstSeenVersions",
)
last_seen_versions = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(ErrorsInboxVersion)),
graphql_name="lastSeenVersions",
)1363. ErrorsInboxErrorGroupOutline¶
A grouping of similar error events with minimal fields.
Available fields:
assignment: User assigned to the error groupentityGuid: Source entity GuideventsQuery: NRQL formatted query for retrieving error eventsfirstSeenAt: Time of first occurrenceid: A unique identifier for the error groupisCustom: Indicates whether this error group was custom generated.
false = this is a system-generated error group
true = this is a custom error group, created and sent by the end user
issueType: Indicates the type of issue
PERFORMANCE = Any performance issue like slow query, NPlusOneQuery, etc falls under this issue type
ERROR = Any error like TransactionError, MobileRequestError, etc falls under this issue type
lastSeenAt: Time of last occurrencemessage: Error group messagename: Error group nameoccurrences: The occurrences of this error group.regressedAt: Time of regression occurrence for regressed error groupsresources: List of resources associated with this error groupsource: The source event of the error group.state: Value to indicate the current state of the group.url: The public URL of the error group detail view.
class ErrorsInboxErrorGroupOutline(sgqlc.types.Type, ErrorsInboxErrorGroupBase):
__schema__ = nerdgraph
__field_names__ = ()1364. ErrorsInboxJiraIssue¶
An single issue in JIRA
Available fields:
id: Unique resource identifierissueId: Issue Id in JIRAurl: Url to access the issue in JIRA
class ErrorsInboxJiraIssue(sgqlc.types.Type, ErrorsInboxResource):
__schema__ = nerdgraph
__field_names__ = ("issue_id",)
issue_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="issueId")1365. ErrorsInboxUpdateErrorGroupStateError¶
Configure notification policy error
Available fields:
description: The description of the errortype: The error type
class ErrorsInboxUpdateErrorGroupStateError(sgqlc.types.Type, ErrorsInboxResponseError):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(ErrorsInboxUpdateErrorGroupStateErrorType),
graphql_name="type",
)1366. ExternalEntity¶
An External entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class ExternalEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ()1367. ExternalEntityOutline¶
An External entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class ExternalEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = ()1368. GenericEntity¶
A generic entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class GenericEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ()1369. GenericEntityOutline¶
A generic entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class GenericEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = ()1370. GenericInfrastructureEntity¶
An Infrastructure entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.integrationTypeCodelastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class GenericInfrastructureEntity(
sgqlc.types.Type, AlertableEntity, Entity, InfrastructureIntegrationEntity
):
__schema__ = nerdgraph
__field_names__ = ()1371. GenericInfrastructureEntityOutline¶
An Infrastructure entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.integrationTypeCodelastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class GenericInfrastructureEntityOutline(
sgqlc.types.Type,
AlertableEntityOutline,
EntityOutline,
InfrastructureIntegrationEntityOutline,
):
__schema__ = nerdgraph
__field_names__ = ()1372. InfrastructureAwsLambdaFunctionEntity¶
An AWS Lambda Function entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.integrationTypeCodelastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runtimeserviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class InfrastructureAwsLambdaFunctionEntity(
sgqlc.types.Type, AlertableEntity, Entity, InfrastructureIntegrationEntity
):
__schema__ = nerdgraph
__field_names__ = ("runtime",)
runtime = sgqlc.types.Field(String, graphql_name="runtime")1373. InfrastructureAwsLambdaFunctionEntityOutline¶
An AWS Lambda Function entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.integrationTypeCodelastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.runtimeserviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class InfrastructureAwsLambdaFunctionEntityOutline(
sgqlc.types.Type,
AlertableEntityOutline,
EntityOutline,
InfrastructureIntegrationEntityOutline,
):
__schema__ = nerdgraph
__field_names__ = ("runtime",)
runtime = sgqlc.types.Field(String, graphql_name="runtime")1374. InfrastructureHostEntity¶
An Infrastructure Host entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.hostSummaryindexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class InfrastructureHostEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ("host_summary",)
host_summary = sgqlc.types.Field(
InfrastructureHostSummaryData, graphql_name="hostSummary"
)1375. InfrastructureHostEntityOutline¶
An Infrastructure Host entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.hostSummaryindexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class InfrastructureHostEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ("host_summary",)
host_summary = sgqlc.types.Field(
InfrastructureHostSummaryData, graphql_name="hostSummary"
)1376. KeyTransactionEntity¶
A Key Transaction entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.apdexTarget: The acceptable amount of time spent in the backend before customers get frustrated (Apdex target).application: The application associated with this key transactionbrowserApdexTarget: The acceptable amount of time for rendering a page in a browser before customers get frustrated (browser Apdex target).deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.metricName: The name of the metric underlying this key transaction.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class KeyTransactionEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"apdex_target",
"application",
"browser_apdex_target",
"metric_name",
)
apdex_target = sgqlc.types.Field(
sgqlc.types.non_null(Float), graphql_name="apdexTarget"
)
application = sgqlc.types.Field(
sgqlc.types.non_null(KeyTransactionApplication), graphql_name="application"
)
browser_apdex_target = sgqlc.types.Field(Float, graphql_name="browserApdexTarget")
metric_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="metricName"
)1377. KeyTransactionEntityOutline¶
A Key Transaction entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class KeyTransactionEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ()1378. MobileApplicationEntity¶
A Mobile Application entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.applicationId: The ID of the Mobile App.crash: A Crash that occurred in your Mobile Application.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.exception: A Handled Exception that occurred in your Mobile Application.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.metricGroupingIssues: Retrieves the entity metric grouping issues.metricNormalizationRule: Retrieves a rule.metricNormalizationRules: Retrieves the rules for the application.mobileProperties: Access general properties for the application.mobileSettings: Settings that are common across mobile applications.mobileSummary: Summary statistics about the Mobile App.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class MobileApplicationEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"application_id",
"crash",
"exception",
"metric_grouping_issues",
"metric_normalization_rule",
"metric_normalization_rules",
"mobile_properties",
"mobile_settings",
"mobile_summary",
)
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
crash = sgqlc.types.Field(
StackTraceMobileCrash,
graphql_name="crash",
args=sgqlc.types.ArgDict(
(
(
"occurrence_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="occurrenceId",
default=None,
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `occurrence_id` (`String!`): A unique identifer for an
occurrence of a Mobile Crash.
* `time_window` (`TimeWindowInput`): The time window (60 minutes
maximum) in which to search for the mobile crash. Defaults to
standard NRQL query window.
"""
exception = sgqlc.types.Field(
StackTraceMobileException,
graphql_name="exception",
args=sgqlc.types.ArgDict(
(
(
"fingerprint",
sgqlc.types.Arg(String, graphql_name="fingerprint", default=None),
),
(
"occurrence_id",
sgqlc.types.Arg(String, graphql_name="occurrenceId", default=None),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `fingerprint` (`String`): The fingerprint of a Mobile Handled
Exception. The first handled exception matching the fingerprint
will be returned.
* `occurrence_id` (`String`): A unique identifier for an
occurrence of a Mobile Handled Exception. This is the
'handledExceptionUuid' attribute on the MobileHandledException
events.
* `time_window` (`TimeWindowInput`): The time window (60 minutes
maximum) in which to search for the handled exception. Defaults
to standard NRQL query window.
"""
metric_grouping_issues = sgqlc.types.Field(
sgqlc.types.list_of(
sgqlc.types.non_null(MetricNormalizationRuleMetricGroupingIssue)
),
graphql_name="metricGroupingIssues",
args=sgqlc.types.ArgDict(
(
(
"end_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="endTime", default=None
),
),
(
"metric_normalization_rule_ids",
sgqlc.types.Arg(
sgqlc.types.list_of(Int),
graphql_name="metricNormalizationRuleIds",
default=None,
),
),
(
"start_time",
sgqlc.types.Arg(
EpochMilliseconds, graphql_name="startTime", default=None
),
),
)
),
)
"""Arguments:
* `end_time` (`EpochMilliseconds`): End time.
* `metric_normalization_rule_ids` (`[Int]`): Metric normalization
rule ids
* `start_time` (`EpochMilliseconds`): Start time.
"""
metric_normalization_rule = sgqlc.types.Field(
MetricNormalizationRule,
graphql_name="metricNormalizationRule",
args=sgqlc.types.ArgDict(
(
(
"id",
sgqlc.types.Arg(
sgqlc.types.non_null(Int), graphql_name="id", default=None
),
),
)
),
)
metric_normalization_rules = sgqlc.types.Field(
sgqlc.types.list_of(sgqlc.types.non_null(MetricNormalizationRule)),
graphql_name="metricNormalizationRules",
args=sgqlc.types.ArgDict(
(
(
"enabled",
sgqlc.types.Arg(Boolean, graphql_name="enabled", default=None),
),
)
),
)
mobile_properties = sgqlc.types.Field(
AgentApplicationSettingsMobileProperties, graphql_name="mobileProperties"
)
mobile_settings = sgqlc.types.Field(
AgentApplicationSettingsMobileBase, graphql_name="mobileSettings"
)
mobile_summary = sgqlc.types.Field(
MobileAppSummaryData, graphql_name="mobileSummary"
)1379. MobileApplicationEntityOutline¶
A Mobile Application entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.applicationId: The ID of the Mobile App.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.mobileSummary: Summary statistics about the Mobile App.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class MobileApplicationEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ("application_id", "mobile_summary")
application_id = sgqlc.types.Field(Int, graphql_name="applicationId")
mobile_summary = sgqlc.types.Field(
MobileAppSummaryData, graphql_name="mobileSummary"
)1380. Nr1CatalogAllSupportedEntityTypes¶
Specifies the supported entity types to be all entity types
Available fields:
mode: The level of support entity types. Always set to ALL
class Nr1CatalogAllSupportedEntityTypes(
sgqlc.types.Type, Nr1CatalogSupportedEntityTypes
):
__schema__ = nerdgraph
__field_names__ = ()1381. Nr1CatalogInstallPlan¶
An installer that uses install plan steps
Available fields:
steps: The list of install plan steps necessary to execute the installation of the quickstarttype: The type of installer
class Nr1CatalogInstallPlan(sgqlc.types.Type, Nr1CatalogInstaller):
__schema__ = nerdgraph
__field_names__ = ("steps",)
steps = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogInstallPlanStep))
),
graphql_name="steps",
)1382. Nr1CatalogLauncher¶
Information about a launcher in a Nerdpack
Available fields:
id: The unique identifier for the launcher.metadata: Metadata associated with the launcher
class Nr1CatalogLauncher(sgqlc.types.Type, Nr1CatalogNerdpackItem):
__schema__ = nerdgraph
__field_names__ = ()1383. Nr1CatalogLauncherMetadata¶
Metadata information for a launcher
Available fields:
description: A short form description for the launcher.displayName: The human-readable name for the launcher.icon: The corresponding icon for the launcher.previews: A list of previews for the launcher, such as screenshots.
class Nr1CatalogLauncherMetadata(sgqlc.types.Type, Nr1CatalogNerdpackItemMetadata):
__schema__ = nerdgraph
__field_names__ = ("icon",)
icon = sgqlc.types.Field(Nr1CatalogIcon, graphql_name="icon")1384. Nr1CatalogLinkInstallPlanDirective¶
Information about a link install plan directive
Available fields:
mode: The mode of the install plan directiveurl: The URL of the external link used to guide the user through installation
class Nr1CatalogLinkInstallPlanDirective(
sgqlc.types.Type, Nr1CatalogInstallPlanDirective
):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1385. Nr1CatalogNerdlet¶
Information about a Nerdlet in a Nerdpack
Available fields:
id: The unique identifier for the Nerdlet.metadata: Metadata associated with the Nerdlet
class Nr1CatalogNerdlet(sgqlc.types.Type, Nr1CatalogNerdpackItem):
__schema__ = nerdgraph
__field_names__ = ()1386. Nr1CatalogNerdletInstallPlanDirective¶
Information about a targeted install plan directive
Available fields:
mode: The mode of the install plan directivenerdletId: The nerdlet ID used to guide the user through installationnerdletState: The nerdlet state used to intialize the nerdlet
class Nr1CatalogNerdletInstallPlanDirective(
sgqlc.types.Type, Nr1CatalogInstallPlanDirective
):
__schema__ = nerdgraph
__field_names__ = ("nerdlet_id", "nerdlet_state")
nerdlet_id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="nerdletId")
nerdlet_state = sgqlc.types.Field(
Nr1CatalogRawNerdletState, graphql_name="nerdletState"
)1387. Nr1CatalogNerdletMetadata¶
Metadata information for a Nerdlet
Available fields:
description: A short form description for the Nerdlet.displayName: The human-readable name for the Nerdlet.previews: A list of previews for the Nerdlet, such as screenshots.supportedEntityTypes: The supported entity types by the Nerdlet.
class Nr1CatalogNerdletMetadata(sgqlc.types.Type, Nr1CatalogNerdpackItemMetadata):
__schema__ = nerdgraph
__field_names__ = ("supported_entity_types",)
supported_entity_types = sgqlc.types.Field(
Nr1CatalogSupportedEntityTypes, graphql_name="supportedEntityTypes"
)1388. Nr1CatalogNoSupportedEntityTypes¶
Specifies the supported entity types to be no entity types
Available fields:
mode: The level of support entity types. Always set to NONE
class Nr1CatalogNoSupportedEntityTypes(
sgqlc.types.Type, Nr1CatalogSupportedEntityTypes
):
__schema__ = nerdgraph
__field_names__ = ()1389. Nr1CatalogQuickstartAlert¶
Information about an alert in a quickstart
Available fields:
class Nr1CatalogQuickstartAlert(sgqlc.types.Type, Nr1CatalogQuickstartComponent):
__schema__ = nerdgraph
__field_names__ = ()1390. Nr1CatalogQuickstartAlertCondition¶
Information about an alert condition in a quickstart
Available fields:
id: The unique identifier for the alert conditionmetadata: Metadata associated with the alert condition
class Nr1CatalogQuickstartAlertCondition(
sgqlc.types.Type, Nr1CatalogQuickstartComponent
):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1391. Nr1CatalogQuickstartAlertConditionMetadata¶
Metadata associated with the alert condition in a quickstart
Available fields:
description: A short form description for the alert conditiondisplayName: The human-readable name for the alert conditiontype: Determines the type of alert condition that will be created
class Nr1CatalogQuickstartAlertConditionMetadata(
sgqlc.types.Type, Nr1CatalogQuickstartComponentMetadata
):
__schema__ = nerdgraph
__field_names__ = ("type",)
type = sgqlc.types.Field(
sgqlc.types.non_null(Nr1CatalogQuickstartAlertConditionType),
graphql_name="type",
)1392. Nr1CatalogQuickstartAlertMetadata¶
Metadata associated with the alert in a quickstart
Available fields:
class Nr1CatalogQuickstartAlertMetadata(
sgqlc.types.Type, Nr1CatalogQuickstartComponentMetadata
):
__schema__ = nerdgraph
__field_names__ = ()1393. Nr1CatalogQuickstartDashboard¶
Information about a dashboard in a quickstart
Available fields:
id: The unique identifier for the dashboardmetadata: Metadata associated with the dashboard
class Nr1CatalogQuickstartDashboard(sgqlc.types.Type, Nr1CatalogQuickstartComponent):
__schema__ = nerdgraph
__field_names__ = ("id",)
id = sgqlc.types.Field(sgqlc.types.non_null(ID), graphql_name="id")1394. Nr1CatalogQuickstartDashboardMetadata¶
Metadata associated with the dashboard in a quickstart
Available fields:
description: A short form description for the dashboard.displayName: The human-readable name for the dashboard.previews: A list of previews for the dashboard, such as screenshots.
class Nr1CatalogQuickstartDashboardMetadata(
sgqlc.types.Type, Nr1CatalogQuickstartComponentMetadata
):
__schema__ = nerdgraph
__field_names__ = ("previews",)
previews = sgqlc.types.Field(
sgqlc.types.non_null(
sgqlc.types.list_of(sgqlc.types.non_null(Nr1CatalogPreview))
),
graphql_name="previews",
)1395. Nr1CatalogQuickstartDocumentation¶
Information about a documentation component in a quickstart
Available fields:
metadata: Metadata associated with the dashboard
class Nr1CatalogQuickstartDocumentation(
sgqlc.types.Type, Nr1CatalogQuickstartComponent
):
__schema__ = nerdgraph
__field_names__ = ()1396. Nr1CatalogQuickstartDocumentationMetadata¶
Metadata associated with the documentation component in a quickstart
Available fields:
description: A short form description for the documentation component.displayName: The human-readable name for the documentation component.url: The documentation URL
class Nr1CatalogQuickstartDocumentationMetadata(
sgqlc.types.Type, Nr1CatalogQuickstartComponentMetadata
):
__schema__ = nerdgraph
__field_names__ = ("url",)
url = sgqlc.types.Field(sgqlc.types.non_null(String), graphql_name="url")1397. Nr1CatalogQuickstartInstallPlan¶
Information about an install plan component in a quickstart
Available fields:
class Nr1CatalogQuickstartInstallPlan(sgqlc.types.Type, Nr1CatalogQuickstartComponent):
__schema__ = nerdgraph
__field_names__ = ()1398. Nr1CatalogQuickstartInstallPlanMetadata¶
Metadata associated with the install plan in a quickstart
Available fields:
class Nr1CatalogQuickstartInstallPlanMetadata(
sgqlc.types.Type, Nr1CatalogQuickstartComponentMetadata
):
__schema__ = nerdgraph
__field_names__ = ()1399. Nr1CatalogScreenshot¶
Information about the publicly accessible screenshot
Available fields:
url: The publicly accessible URL for the screenshot
class Nr1CatalogScreenshot(sgqlc.types.Type, Nr1CatalogPreview):
__schema__ = nerdgraph
__field_names__ = ()1400. Nr1CatalogSpecificSupportedEntityTypes¶
Specifies the supported entity types to be a specific subset of entity types
Available fields:
entityTypes: The list of support entity types.mode: The level of support entity types. Always set to SPECIFIC
class Nr1CatalogSpecificSupportedEntityTypes(
sgqlc.types.Type, Nr1CatalogSupportedEntityTypes
):
__schema__ = nerdgraph
__field_names__ = ("entity_types",)
entity_types = sgqlc.types.Field(
sgqlc.types.non_null(sgqlc.types.list_of(sgqlc.types.non_null(DomainType))),
graphql_name="entityTypes",
)1401. Nr1CatalogTargetedInstallPlanDirective¶
Information about a targeted install plan directive
Available fields:
mode: The mode of the install plan directiverecipeName: The name of the recipe used for the installation
class Nr1CatalogTargetedInstallPlanDirective(
sgqlc.types.Type, Nr1CatalogInstallPlanDirective
):
__schema__ = nerdgraph
__field_names__ = ("recipe_name",)
recipe_name = sgqlc.types.Field(
sgqlc.types.non_null(String), graphql_name="recipeName"
)1402. Nr1CatalogVisualization¶
Information about a visualization in a Nerdpack
Available fields:
id: The unique identifier for the visualization.metadata: Metadata associated with the visualization
class Nr1CatalogVisualization(sgqlc.types.Type, Nr1CatalogNerdpackItem):
__schema__ = nerdgraph
__field_names__ = ()1403. Nr1CatalogVisualizationMetadata¶
Metadata information for a visualization
Available fields:
description: A short form description for the visualization.displayName: The human-readable name for the visualization.previews: A list of previews for the visualization, such as screenshots.
class Nr1CatalogVisualizationMetadata(sgqlc.types.Type, Nr1CatalogNerdpackItemMetadata):
__schema__ = nerdgraph
__field_names__ = ()1404. SecureCredentialEntity¶
A secure credential entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.description: The description of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.secureCredentialId: The domain-specific identifier for the entity.secureCredentialSummary: Summary statistics for the Synthetic Monitor Secure Credential.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s typeupdatedAt: The time at which the entity was last updated.
class SecureCredentialEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"description",
"secure_credential_id",
"secure_credential_summary",
"updated_at",
)
description = sgqlc.types.Field(String, graphql_name="description")
secure_credential_id = sgqlc.types.Field(ID, graphql_name="secureCredentialId")
secure_credential_summary = sgqlc.types.Field(
SecureCredentialSummaryData, graphql_name="secureCredentialSummary"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")1405. SecureCredentialEntityOutline¶
A secure credential entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.description: The description of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.secureCredentialId: The domain-specific identifier for the entity.secureCredentialSummary: Summary statistics for the Synthetic Monitor Secure Credential.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s typeupdatedAt: The time at which the entity was last updated.
class SecureCredentialEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = (
"description",
"secure_credential_id",
"secure_credential_summary",
"updated_at",
)
description = sgqlc.types.Field(String, graphql_name="description")
secure_credential_id = sgqlc.types.Field(ID, graphql_name="secureCredentialId")
secure_credential_summary = sgqlc.types.Field(
SecureCredentialSummaryData, graphql_name="secureCredentialSummary"
)
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")1406. StackTraceApmStackTraceFrame¶
An object representing a stack trace segment
Available fields:
filepath: Frame filepathformatted: Formatted frameline: Frame line numbername: Frame name
class StackTraceApmStackTraceFrame(
sgqlc.types.Type, StackTraceFileBasedStackTraceFrame
):
__schema__ = nerdgraph
__field_names__ = ()1407. StackTraceMobileCrashStackTraceFrame¶
An object representing a stack trace segment
Available fields:
filepath: Frame filepathformatted: Formatted frameline: Frame line numbername: Frame name
class StackTraceMobileCrashStackTraceFrame(
sgqlc.types.Type, StackTraceFileBasedStackTraceFrame
):
__schema__ = nerdgraph
__field_names__ = ()1408. StackTraceMobileExceptionStackTraceFrame¶
An object representing a stack trace segment
Available fields:
filepath: Frame filepathformatted: Formatted frameline: Frame line numbername: Frame name
class StackTraceMobileExceptionStackTraceFrame(
sgqlc.types.Type, StackTraceFileBasedStackTraceFrame
):
__schema__ = nerdgraph
__field_names__ = ()1409. SuggestedAnomalyBasedNrqlQuery¶
A query suggestion based on analysis of events within a specific anomalous time range vs. nearby events outside of that time range.
Available fields:
anomaly: Information about the anomaly upon which this suggestion is basednrql: The NRQL string to run for the suggested querytitle: A human-readable title describing what the query shows
class SuggestedAnomalyBasedNrqlQuery(sgqlc.types.Type, SuggestedNrqlQuery):
__schema__ = nerdgraph
__field_names__ = ("anomaly",)
anomaly = sgqlc.types.Field(
sgqlc.types.non_null(SuggestedNrqlQueryAnomaly), graphql_name="anomaly"
)1410. SuggestedHistoryBasedNrqlQuery¶
A query suggestion based on historical query patterns.
Available fields:
nrql: The NRQL string to run for the suggested querytitle: A human-readable title describing what the query shows
class SuggestedHistoryBasedNrqlQuery(sgqlc.types.Type, SuggestedNrqlQuery):
__schema__ = nerdgraph
__field_names__ = ()1411. SyntheticMonitorEntity¶
A Synthetic Monitor entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.assets: Assets produced during the execution of the check, such as screenshotsdeploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.monitorId: The Synthetic Monitor IDmonitorSummary: Summary statistics for the Synthetic Monitor.monitorType: The Synthetic Monitor typemonitoredUrl: The URL being monitored by aSIMPLEorBROWSERmonitor type.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
period: The duration in minutes between Synthetic Monitor runs.permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class SyntheticMonitorEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = (
"assets",
"monitor_id",
"monitor_summary",
"monitor_type",
"monitored_url",
"period",
)
assets = sgqlc.types.Field(
sgqlc.types.list_of(SyntheticsSyntheticMonitorAsset),
graphql_name="assets",
args=sgqlc.types.ArgDict(
(
(
"check_id",
sgqlc.types.Arg(
sgqlc.types.non_null(String),
graphql_name="checkId",
default=None,
),
),
)
),
)
monitor_id = sgqlc.types.Field(ID, graphql_name="monitorId")
monitor_summary = sgqlc.types.Field(
SyntheticMonitorSummaryData, graphql_name="monitorSummary"
)
monitor_type = sgqlc.types.Field(SyntheticMonitorType, graphql_name="monitorType")
monitored_url = sgqlc.types.Field(String, graphql_name="monitoredUrl")
period = sgqlc.types.Field(Minutes, graphql_name="period")1412. SyntheticMonitorEntityOutline¶
A Synthetic Monitor entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.monitorId: The Synthetic Monitor IDmonitorSummary: Summary statistics for the Synthetic Monitor.monitorType: The Synthetic Monitor typemonitoredUrl: The URL being monitored by aSIMPLEorBROWSERmonitor type.name: The name of this entity.period: The duration in minutes between Synthetic Monitor runs.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class SyntheticMonitorEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = (
"monitor_id",
"monitor_summary",
"monitor_type",
"monitored_url",
"period",
)
monitor_id = sgqlc.types.Field(ID, graphql_name="monitorId")
monitor_summary = sgqlc.types.Field(
SyntheticMonitorSummaryData, graphql_name="monitorSummary"
)
monitor_type = sgqlc.types.Field(SyntheticMonitorType, graphql_name="monitorType")
monitored_url = sgqlc.types.Field(String, graphql_name="monitoredUrl")
period = sgqlc.types.Field(Minutes, graphql_name="period")1413. TeamEntity¶
A Team entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.collectiondeploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class TeamEntity(sgqlc.types.Type, AlertableEntity, CollectionEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ()1414. TeamEntityOutline¶
A Team entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class TeamEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = ()1415. ThirdPartyServiceEntity¶
A third party service entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.flamegraph: Retrieves a flamegraph for the specific third-party service over the time period specified.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class ThirdPartyServiceEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ("flamegraph",)
flamegraph = sgqlc.types.Field(
JavaFlightRecorderFlamegraph,
graphql_name="flamegraph",
args=sgqlc.types.ArgDict(
(
(
"service_instance_id",
sgqlc.types.Arg(
String, graphql_name="serviceInstanceId", default=None
),
),
(
"time_window",
sgqlc.types.Arg(
TimeWindowInput, graphql_name="timeWindow", default=None
),
),
)
),
)
"""Arguments:
* `service_instance_id` (`String`): The service instance ID to get
flamegraph stack trace events for
* `time_window` (`TimeWindowInput`): The start and end of the
flamegraph events. Defaults to last 30 minutes
"""1416. ThirdPartyServiceEntityOutline¶
A third party service entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class ThirdPartyServiceEntityOutline(
sgqlc.types.Type, AlertableEntityOutline, EntityOutline
):
__schema__ = nerdgraph
__field_names__ = ()1417. UnavailableEntity¶
An entity that is unavailable.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s type
class UnavailableEntity(sgqlc.types.Type, AlertableEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ()1418. UnavailableEntityOutline¶
An entity outline that is unavailable.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s type
class UnavailableEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = ()1419. WhatsNewAnnouncementContent¶
Represents the details about an announcement.
Available fields:
body: The body of the news.contentType: The type of the news.context: Contains information about the context of the announcement.docUrl: A link to the documentation.gettingStartedUrl: A link to a page to get started.id: The ID of the announcement.isFeatured: A boolean representing whether this content is Featured.learnMoreUrl: A link to a page to learn more about the announcement.publishDate: The date the announcement was published.requirements: Information about the requirements.summary: The summary of the announcement.title: The title of the announcement.
class WhatsNewAnnouncementContent(sgqlc.types.Type, WhatsNewContent):
__schema__ = nerdgraph
__field_names__ = (
"body",
"doc_url",
"getting_started_url",
"is_featured",
"learn_more_url",
"requirements",
)
body = sgqlc.types.Field(String, graphql_name="body")
doc_url = sgqlc.types.Field(String, graphql_name="docUrl")
getting_started_url = sgqlc.types.Field(String, graphql_name="gettingStartedUrl")
is_featured = sgqlc.types.Field(Boolean, graphql_name="isFeatured")
learn_more_url = sgqlc.types.Field(String, graphql_name="learnMoreUrl")
requirements = sgqlc.types.Field(String, graphql_name="requirements")1420. WhatsNewEolAnnouncementContent¶
Represents the details about an EOL announcement.
Available fields:
body: The body of the EOL announcement.contentType: The type of the news.context: Contains information about the context of the EOL announcement.docUrl: A link to the documentation.eolEffectiveDate: The date when the service/feature will be end-of-life.id: The ID of the EOL announcement.learnMoreUrl: A link to a page to learn more about the EOL announcement.publishDate: The date the EOL announcement was published.summary: The summary of the EOL announcement.title: The title of the EOL announcement.
class WhatsNewEolAnnouncementContent(sgqlc.types.Type, WhatsNewContent):
__schema__ = nerdgraph
__field_names__ = ("body", "doc_url", "eol_effective_date", "learn_more_url")
body = sgqlc.types.Field(String, graphql_name="body")
doc_url = sgqlc.types.Field(String, graphql_name="docUrl")
eol_effective_date = sgqlc.types.Field(
EpochMilliseconds, graphql_name="eolEffectiveDate"
)
learn_more_url = sgqlc.types.Field(String, graphql_name="learnMoreUrl")1421. WorkloadEntity¶
A workload entity.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.alertViolations: Violations on the entity that were open during the specified time window. This will return up to 500 violations - if there are more in the time window selected, you must narrow the time window or look at fewer entities.collectioncreatedAt: When the workload was created.createdByUser: The user that created the workload.deploymentSearch: Retrieve the deployment event(s). Ordered by timestamp DESC.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.nerdStoragenrdbQuery: Make anEntityscoped query to NRDB with a NRQL string.
A relevant WHERE clause will be added to your query to scope data to the entity in question.
See the NRQL Docs for more information about generating a query string.
permalink: The url to the entity.recentAlertViolations: Recent violations on the entity.relatedEntities: Related entities result with optional filtering.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
tagsWithMetadata: The tags applied to the entity with their metadata.tracingSummary: Look up Distributed Tracing summary data for the selectedEntityGuidtype: The entity’s typeupdatedAt: When the workload was last updated.workloadStatus: Status of the workload.
class WorkloadEntity(sgqlc.types.Type, AlertableEntity, CollectionEntity, Entity):
__schema__ = nerdgraph
__field_names__ = ("created_at", "created_by_user", "updated_at", "workload_status")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by_user = sgqlc.types.Field(UserReference, graphql_name="createdByUser")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
workload_status = sgqlc.types.Field(WorkloadStatus, graphql_name="workloadStatus")1422. WorkloadEntityOutline¶
A workload entity outline.
Available fields:
accountaccountId: The New Relic account ID associated with this entity.alertSeverity: The current alerting severity of the entity.createdAt: When the workload was created.createdByUser: The user that created the workload.domain: The entity’s domainentityType: A value representing the combination of the entity’s domain and type.firstIndexedAt: The date of last time the entity has updated any of its fields.goldenMetrics: The list of golden metrics for a specific entitygoldenTags: The list of golden tags for a specific entityType.guid: A unique entity identifier.indexedAt: The time the entity was indexed.lastReportingChangeAt: The last time the entity’s reporting status changed.name: The name of this entity.permalink: The url to the entity.reporting: The reporting status of the entity. If New Relic is successfully collecting data from your application, this will be true.serviceLevel: The service level defined for the entity.tags: The tags applied to the entity.
For details on tags, as well as query and mutation examples, visit our docs.
type: The entity’s typeupdatedAt: When the workload was last updated.workloadStatus: Status of the workload.
class WorkloadEntityOutline(sgqlc.types.Type, AlertableEntityOutline, EntityOutline):
__schema__ = nerdgraph
__field_names__ = ("created_at", "created_by_user", "updated_at", "workload_status")
created_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="createdAt")
created_by_user = sgqlc.types.Field(UserReference, graphql_name="createdByUser")
updated_at = sgqlc.types.Field(EpochMilliseconds, graphql_name="updatedAt")
workload_status = sgqlc.types.Field(WorkloadStatus, graphql_name="workloadStatus")1423. WorkloadRollupRuleStatusResult¶
A rollup rule that was involved in the calculation of the workload status.
Available fields:
rollupRuleDetails: Represents the details of a rollup rule.source: Indicates where the status value derives from.value: The status of a rollup rule.
class WorkloadRollupRuleStatusResult(sgqlc.types.Type, WorkloadStatusResult):
__schema__ = nerdgraph
__field_names__ = ("rollup_rule_details",)
rollup_rule_details = sgqlc.types.Field(
WorkloadRollupRuleDetails, graphql_name="rollupRuleDetails"
)1424. WorkloadStaticStatusResult¶
A static status that was involved in the calculation of the workload status.
Available fields:
description: A description that provides additional details about the status of the workload.source: Indicates where the status value derives from.summary: A short description of the status of the workload.value: The value of a static status.
class WorkloadStaticStatusResult(sgqlc.types.Type, WorkloadStatusResult):
__schema__ = nerdgraph
__field_names__ = ("description", "summary")
description = sgqlc.types.Field(String, graphql_name="description")
summary = sgqlc.types.Field(String, graphql_name="summary")Union types¶
1. AiNotificationsAuth¶
Authentication interface
class AiNotificationsAuth(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
AiNotificationsBasicAuth,
AiNotificationsCustomHeadersAuth,
AiNotificationsOAuth2Auth,
AiNotificationsTokenAuth,
)2. AiNotificationsError¶
Error object
class AiNotificationsError(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
AiNotificationsConstraintsError,
AiNotificationsDataValidationError,
AiNotificationsResponseError,
AiNotificationsSuggestionError,
)3. AiWorkflowsConfiguration¶
Enrichment configuration object
class AiWorkflowsConfiguration(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (AiWorkflowsNrqlConfiguration,)4. AlertsNotificationChannelMutation¶
Notification channel types that are available for create and update operations.
class AlertsNotificationChannelMutation(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
AlertsEmailNotificationChannel,
AlertsOpsGenieNotificationChannel,
AlertsPagerDutyNotificationChannel,
AlertsSlackNotificationChannel,
AlertsVictorOpsNotificationChannel,
AlertsWebhookNotificationChannel,
AlertsXMattersNotificationChannel,
)5. IncidentIntelligenceEnvironmentCreateEnvironmentResultDetails¶
Result details union
class IncidentIntelligenceEnvironmentCreateEnvironmentResultDetails(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
IncidentIntelligenceEnvironmentEnvironmentAlreadyExists,
IncidentIntelligenceEnvironmentEnvironmentCreated,
)6. IncidentIntelligenceEnvironmentCurrentEnvironmentResultReasonDetails¶
Reason details union
class IncidentIntelligenceEnvironmentCurrentEnvironmentResultReasonDetails(
sgqlc.types.Union
):
__schema__ = nerdgraph
__types__ = (
IncidentIntelligenceEnvironmentMultipleEnvironmentsAvailable,
IncidentIntelligenceEnvironmentUserNotAuthorizedForAccount,
IncidentIntelligenceEnvironmentUserNotCapableToOperateOnAccount,
)7. Nr1CatalogDataSourceInstallDirective¶
Installation information for a data source
class Nr1CatalogDataSourceInstallDirective(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (Nr1CatalogLinkInstallDirective, Nr1CatalogNerdletInstallDirective)8. Nr1CatalogSearchResult¶
A result returned when executing a search
class Nr1CatalogSearchResult(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
Nr1CatalogAlertPolicyTemplate,
Nr1CatalogDashboardTemplate,
Nr1CatalogDataSource,
Nr1CatalogNerdpack,
Nr1CatalogQuickstart,
)9. WorkflowAutomationValidationType¶
Validation types for action definition inputs
class WorkflowAutomationValidationType(sgqlc.types.Union):
__schema__ = nerdgraph
__types__ = (
WorkflowAutomationAllowedStringValuesValidation,
WorkflowAutomationMaxIntegerValueValidation,
WorkflowAutomationMaxLengthValidation,
WorkflowAutomationMinIntegerValueValidation,
WorkflowAutomationRegexValidation,
)