nrqldroprules

package
v2.43.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package nrqldroprules provides a programmatic API for interacting configuring New Relc NRQL Drop Rules.

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const NRQLDropRulesCreateMutation = `` /* 442-byte string literal not displayed */
View Source 
const NRQLDropRulesDeleteMutation = `` /* 395-byte string literal not displayed */

Variables

View Source 
var NRQLDropRulesActionTypes = struct {
	// This action will strip the attributes specified in the SELECT clause of the NRQL string for all events that match the associated NRQL string.
	DROP_ATTRIBUTES NRQLDropRulesAction
	// This action will strip the attributes specified in the SELECT clause of the NRQL string for metric aggregates. The event type must be Metric.
	DROP_ATTRIBUTES_FROM_METRIC_AGGREGATES NRQLDropRulesAction
	// This action will drop all data that match the associated NRQL string. That string MUST be a `SELECT *`.
	DROP_DATA NRQLDropRulesAction
}{

	DROP_ATTRIBUTES: "DROP_ATTRIBUTES",

	DROP_ATTRIBUTES_FROM_METRIC_AGGREGATES: "DROP_ATTRIBUTES_FROM_METRIC_AGGREGATES",

	DROP_DATA: "DROP_DATA",
}
View Source 
var NRQLDropRulesErrorReasonTypes = struct {
	// Targeted account does not have access to this feature.
	FEATURE_FLAG_DISABLED NRQLDropRulesErrorReason
	// Other errors.
	GENERAL NRQLDropRulesErrorReason
	// Something about the request was invalid.
	INVALID_INPUT NRQLDropRulesErrorReason
	// The provided NRQL string was ill formed or used invalid features.
	INVALID_QUERY NRQLDropRulesErrorReason
	// The drop rule being acted upon did not exist.
	RULE_NOT_FOUND NRQLDropRulesErrorReason
	// The current user does not have authority to perform the given action.
	USER_NOT_AUTHORIZED NRQLDropRulesErrorReason
}{

	FEATURE_FLAG_DISABLED: "FEATURE_FLAG_DISABLED",

	GENERAL: "GENERAL",

	INVALID_INPUT: "INVALID_INPUT",

	INVALID_QUERY: "INVALID_QUERY",

	RULE_NOT_FOUND: "RULE_NOT_FOUND",

	USER_NOT_AUTHORIZED: "USER_NOT_AUTHORIZED",
}

Functions

This section is empty.

Types

type Account 

type Account struct {
	//
	ID int `json:"id,omitempty"`
	//
	LicenseKey string `json:"licenseKey,omitempty"`
	//
	Name string `json:"name,omitempty"`
	// This field provides access to NrqlDropRules data.
	NRQLDropRules NRQLDropRulesAccountStitchedFields `json:"nrqlDropRules,omitempty"`
}

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.

type AccountReference added in v2.6.1 

type AccountReference struct {
	//
	ID int `json:"id,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

AccountReference - The `AccountReference` object provides basic identifying information about the account.

type Actor 

type Actor struct {
	// The `account` field is the entry point into data that is scoped to a single account.
	Account Account `json:"account,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type NRQLDropRulesAccountStitchedFields 

type NRQLDropRulesAccountStitchedFields struct {
	// List the drop rules for the given account
	List NRQLDropRulesListDropRulesResult `json:"list,omitempty"`
}

NRQLDropRulesAccountStitchedFields -

type NRQLDropRulesAction 

type NRQLDropRulesAction string

NRQLDropRulesAction - Specifies how data matching the drop rule's NRQL string should be processed.

type NRQLDropRulesCreateDropRuleFailure 

type NRQLDropRulesCreateDropRuleFailure struct {
	// Information about why the create failed.
	Error NRQLDropRulesError `json:"error"`
	// Input information about a submitted rule that was unable to be created.
	Submitted NRQLDropRulesCreateDropRuleSubmission `json:"submitted"`
}

NRQLDropRulesCreateDropRuleFailure - Error details about the rule that failed to be created and why.

type NRQLDropRulesCreateDropRuleInput 

type NRQLDropRulesCreateDropRuleInput struct {
	// The type of drop rule you want. This changes the way your NRQL string is interpreted.
	Action NRQLDropRulesAction `json:"action"`
	// Additional information about the rule.
	Description string `json:"description,omitempty"`
	// The NRQL string used to match data you want to take the specified action on.
	NRQL string `json:"nrql"`
}

NRQLDropRulesCreateDropRuleInput - Details needed to create a NRQL drop rule.

type NRQLDropRulesCreateDropRuleResult 

type NRQLDropRulesCreateDropRuleResult struct {
	// Rules that were not created and why.
	Failures []NRQLDropRulesCreateDropRuleFailure `json:"failures,omitempty"`
	// Rules that were successfully created.
	Successes []NRQLDropRulesDropRule `json:"successes,omitempty"`
}

NRQLDropRulesCreateDropRuleResult - The result of which submitted drop rules were successfully and unsuccessfully created.

type NRQLDropRulesCreateDropRuleSubmission 

type NRQLDropRulesCreateDropRuleSubmission struct {
	// The account the targeted data report to.
	AccountID int `json:"accountId"`
	// The type of drop rule you want. This changes the way your NRQL string is interpreted.
	Action NRQLDropRulesAction `json:"action"`
	// Additional information about the rule.
	Description string `json:"description,omitempty"`
	// The NRQL string used to match data you want to take the specified action on.
	NRQL string `json:"nrql"`
}

NRQLDropRulesCreateDropRuleSubmission - The details that were submitted when creating a drop rule.

type NRQLDropRulesCreateQueryResponse 

type NRQLDropRulesCreateQueryResponse struct {
	NRQLDropRulesCreateDropRuleResult NRQLDropRulesCreateDropRuleResult `json:"NRQLDropRulesCreate"`
}

type NRQLDropRulesDeleteDropRuleFailure 

type NRQLDropRulesDeleteDropRuleFailure struct {
	// Information about why the delete failed.
	Error NRQLDropRulesError `json:"error"`
	// Input information about on what was unable to be deleted.
	Submitted NRQLDropRulesDeleteDropRuleSubmission `json:"submitted"`
}

NRQLDropRulesDeleteDropRuleFailure - Error details about the rule that failed to be deleted and why.

type NRQLDropRulesDeleteDropRuleResult 

type NRQLDropRulesDeleteDropRuleResult struct {
	// Rules that were not deleted and why.
	Failures []NRQLDropRulesDeleteDropRuleFailure `json:"failures,omitempty"`
	// Rules that were successfully deleted.
	Successes []NRQLDropRulesDropRule `json:"successes,omitempty"`
}

NRQLDropRulesDeleteDropRuleResult - The result of which drop rules were successfully and unsuccessfully deleted.

type NRQLDropRulesDeleteDropRuleSubmission 

type NRQLDropRulesDeleteDropRuleSubmission struct {
	// Account the rule was created on.
	AccountID int `json:"accountId"`
	// Id of the rule you want to delete.
	RuleId string `json:"ruleId"`
}

NRQLDropRulesDeleteDropRuleSubmission - The rules that were attempted to be deleted.

type NRQLDropRulesDeleteQueryResponse 

type NRQLDropRulesDeleteQueryResponse struct {
	NRQLDropRulesDeleteDropRuleResult NRQLDropRulesDeleteDropRuleResult `json:"NRQLDropRulesDelete"`
}

type NRQLDropRulesDropRule 

type NRQLDropRulesDropRule struct {
	// The account this drop rule targets.
	Account AccountReference `json:"account,omitempty"`
	// The account this drop rule targets.
	AccountID int `json:"accountId"`
	// The behavior of the drop rule.
	Action NRQLDropRulesAction `json:"action"`
	// The time this drop rule was created.
	CreatedAt nrtime.DateTime `json:"createdAt"`
	// The id of the user that created the drop rule.
	CreatedBy int `json:"createdBy"`
	// The user reference of the user that created the drop rule
	Creator UserReference `json:"creator,omitempty"`
	// Additional information about the rule.
	Description string `json:"description,omitempty"`
	// The unique id for the drop rule.
	ID string `json:"id"`
	// The NRQL used to match data that will receive the `action`.
	NRQL string `json:"nrql"`
	// Who or what registered this rule.
	Source string `json:"source,omitempty"`
}

NRQLDropRulesDropRule - Details of a drop rule.

type NRQLDropRulesError 

type NRQLDropRulesError struct {
	// A detailed error message.
	Description string `json:"description"`
	// The category of error that occurred.
	Reason NRQLDropRulesErrorReason `json:"reason"`
}

NRQLDropRulesError - Error details when processing drop rule requests.

type NRQLDropRulesErrorReason 

type NRQLDropRulesErrorReason string

NRQLDropRulesErrorReason - General error categories.

type NRQLDropRulesListDropRulesResult 

type NRQLDropRulesListDropRulesResult struct {
	// Information about why we could not list rules.
	Error NRQLDropRulesError `json:"error,omitempty"`
	// The list of drop rules queried on the targeted account.
	Rules []NRQLDropRulesDropRule `json:"rules,omitempty"`
}

NRQLDropRulesListDropRulesResult - The result of the request to list drop rules for an account.

type Nrqldroprules 

type Nrqldroprules struct {
	// contains filtered or unexported fields
}

NrqlDropRules is used to interact with New Relic accounts.

func New 

func New(config config.Config) Nrqldroprules

New returns a new client for interacting with New Relic accounts.

func (*Nrqldroprules) GetDropRuleByID added in v2.40.0 

func (a *Nrqldroprules) GetDropRuleByID(
	accountID int,
	dropRuleID int,
) (*NRQLDropRulesDropRule, error)

GetDropRuleByID helps to fetch a drop rule with the specified ID, from the list of drop rules retrieved for a given account

func (*Nrqldroprules) GetList 

func (a *Nrqldroprules) GetList(
	accountID int,
) (*NRQLDropRulesListDropRulesResult, error)

List the drop rules for the given account

func (*Nrqldroprules) GetListWithContext 

func (a *Nrqldroprules) GetListWithContext(
	ctx context.Context,
	accountID int,
) (*NRQLDropRulesListDropRulesResult, error)

List the drop rules for the given account

func (*Nrqldroprules) NRQLDropRulesCreate 

func (a *Nrqldroprules) NRQLDropRulesCreate(
	accountID int,
	rules []NRQLDropRulesCreateDropRuleInput,
) (*NRQLDropRulesCreateDropRuleResult, error)

Create new drop rule(s).

func (*Nrqldroprules) NRQLDropRulesCreateWithContext 

func (a *Nrqldroprules) NRQLDropRulesCreateWithContext(
	ctx context.Context,
	accountID int,
	rules []NRQLDropRulesCreateDropRuleInput,
) (*NRQLDropRulesCreateDropRuleResult, error)

Create new drop rule(s).

func (*Nrqldroprules) NRQLDropRulesDelete 

func (a *Nrqldroprules) NRQLDropRulesDelete(
	accountID int,
	ruleIds []string,
) (*NRQLDropRulesDeleteDropRuleResult, error)

Delete drop rule(s) by id.

func (*Nrqldroprules) NRQLDropRulesDeleteWithContext 

func (a *Nrqldroprules) NRQLDropRulesDeleteWithContext(
	ctx context.Context,
	accountID int,
	ruleIds []string,
) (*NRQLDropRulesDeleteDropRuleResult, error)

Delete drop rule(s) by id.

type UserReference added in v2.6.1 

type UserReference struct {
	//
	Email string `json:"email,omitempty"`
	//
	Gravatar string `json:"gravatar,omitempty"`
	//
	ID int `json:"id,omitempty"`
	//
	Name string `json:"name,omitempty"`
}

UserReference - The `UserReference` object provides basic identifying information about the user.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.