synthetics

package
v0.90.0 Latest Latest
Warning

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

 Go to latest Published: Aug 15, 2022 License: Apache-2.0 Imports: 12 Imported by: 5

Documentation

Overview

Package synthetics provides a programmatic API for interacting with the New Relic Synthetics API. It can be used for a variety of operations, including:

- Creating, reading, updating, and deleting Synthetics monitors

- Reading and updating Synthetics monitor scripts

- Associating Synthetics monitor scripts with existing Synthetics monitors

- Creating, reading, updating, and deleting Synthetics secure credentials

Synthetics labels have been EOL'd as of July 20, 2020. This functionality has been superceded by entity tags, which can be provisioned via the `entities` package. More information can be found here:

https://discuss.newrelic.com/t/end-of-life-notice-synthetics-labels-and-synthetics-apm-group-by-tag/103781

Authentication

You will need a Personal API key to communicate with the backend New Relic API that provides this functionality. See the API key documentation below for more information on how to locate this keys:

https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys

Package synthetics provides a programmatic API for interacting with the New Relic Synthetics product.

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Example (Monitor) 
// Initialize the client configuration. A Personal API key is required to
// communicate with the backend API.
cfg := config.New()
cfg.PersonalAPIKey = os.Getenv("NEW_RELIC_API_KEY")

// Initialize the client.
client := New(cfg)

// Create a simple Synthetics monitor.
simpleMonitor := Monitor{
	Name:         "Example monitor",
	Type:         MonitorTypes.Ping,
	Status:       MonitorStatus.Enabled,
	SLAThreshold: 2.0,
	URI:          "https://www.example.com",
	Frequency:    5,
	Locations:    []string{"AWS_US_EAST_1"},
}

created, err := client.CreateMonitor(simpleMonitor)
if err != nil {
	log.Fatal("error creating Synthetics monitor: ", err)
}

// Create a scripted browser monitor.
scriptedBrowser := Monitor{
	Name:         "Example scriptied browser monitor",
	Type:         MonitorTypes.ScriptedBrowser,
	Status:       MonitorStatus.Enabled,
	SLAThreshold: 2.0,
	URI:          "https://www.example.com",
	Frequency:    1440,
	Locations:    []string{"AWS_US_EAST_1", "AWS_US_WEST_1"},
}

monitorScript := MonitorScript{
	Text: `
var assert = require("assert");
$browser.get("http://www.example.com").then(function(){ 

	// Check the H1 title matches "Example Domain" 
	return $browser.findElement($driver.By.css("h1")).then(function(element){ 
		return element.getText().then(function(text){ 
		assert.equal("Example Domain", text, "Page H1 title did not match"); 
		}); 
	}); 
})`,
}

created, err = client.CreateMonitor(scriptedBrowser)
if err != nil {
	log.Fatal("error creating Synthetics monitor: ", err)
}

_, err = client.UpdateMonitorScript(created.ID, monitorScript)
if err != nil {
	log.Fatal("error updating Synthetics monitor script: ", err)
}

// Update an existing Synthetics monitor script.
created.Locations = []string{"AWS_US_WEST_1"}

updated, err := client.UpdateMonitor(*created)
if err != nil {
	log.Fatal("error updating Synthetics monitor: ", err)
}

// Delete an existing Synthetics monitor script.
err = client.DeleteMonitor(updated.ID)
if err != nil {
	log.Fatal("error deleting Synthetics monitor: ", err)
}

// Get all valid Synthetics monitor locations.
locations, err := client.GetMonitorLocations()
if err != nil {
	log.Fatal("error retrieving valid Synthetics monitor locations: ", err)
}

log.Printf("found %d valid Synthetics monitor locations", len(locations))

Output:
Example (SecureCredentials) 
// Initialize the client configuration.
cfg := config.New()
cfg.PersonalAPIKey = os.Getenv("NEW_RELIC_API_KEY")

// Initialize the client.
client := New(cfg)

// Get the Synthetics secure credentials for this account.
credentials, err := client.GetSecureCredentials()
if err != nil {
	log.Fatal("error getting Synthetics secure credentials: ", err)
}

// Get a single Synthetics secure credential belonging to this account.
credential, err := client.GetSecureCredential(credentials[0].Key)
if err != nil {
	log.Fatal("error getting Synthetics secure credential: ", err)
}

// Add a secure credential for use with Synthetics.
credential, err = client.AddSecureCredential("key", "value", "description")
if err != nil {
	log.Fatal("error adding Synthetics secure credential: ", err)
}

// Delete a Synthetics secure credential.
err = client.DeleteSecureCredential(credential.Key)
if err != nil {
	log.Fatal("error deleting Synthetics secure credential: ", err)
}

Output:

Index

Examples

Constants

View Source 
const SyntheticsCreateBrokenLinksMonitorMutation = `` /* 328-byte string literal not displayed */
View Source 
const SyntheticsCreateCertCheckMonitorMutation = `` /* 363-byte string literal not displayed */
View Source 
const SyntheticsCreatePrivateLocationMutation = `` /* 390-byte string literal not displayed */
View Source 
const SyntheticsCreateScriptAPIMonitorMutation = `` /* 389-byte string literal not displayed */
View Source 
const SyntheticsCreateScriptBrowserMonitorMutation = `` /* 459-byte string literal not displayed */
View Source 
const SyntheticsCreateSecureCredentialMutation = `` /* 284-byte string literal not displayed */
View Source 
const SyntheticsCreateSimpleBrowserMonitorMutation = `` /* 511-byte string literal not displayed */
View Source 
const SyntheticsCreateSimpleMonitorMutation = `` /* 497-byte string literal not displayed */
View Source 
const SyntheticsCreateStepMonitorMutation = `` /* 413-byte string literal not displayed */
View Source 
const SyntheticsDeleteMonitorMutation = `mutation(
	$guid: EntityGuid!,
) { syntheticsDeleteMonitor(
	guid: $guid,
) {
	deletedGuid
} }`
View Source 
const SyntheticsDeletePrivateLocationMutation = `mutation(
	$guid: EntityGuid!,
) { syntheticsDeletePrivateLocation(
	guid: $guid,
) {
	errors {
		description
		type
	}
} }`
View Source 
const SyntheticsDeleteSecureCredentialMutation = `` /* 194-byte string literal not displayed */
View Source 
const SyntheticsPurgePrivateLocationQueueMutation = `` /* 127-byte string literal not displayed */
View Source 
const SyntheticsUpdateBrokenLinksMonitorMutation = `` /* 320-byte string literal not displayed */
View Source 
const SyntheticsUpdateCertCheckMonitorMutation = `` /* 355-byte string literal not displayed */
View Source 
const SyntheticsUpdatePrivateLocationMutation = `` /* 350-byte string literal not displayed */
View Source 
const SyntheticsUpdateScriptAPIMonitorMutation = `` /* 381-byte string literal not displayed */
View Source 
const SyntheticsUpdateScriptBrowserMonitorMutation = `` /* 451-byte string literal not displayed */
View Source 
const SyntheticsUpdateSecureCredentialMutation = `` /* 283-byte string literal not displayed */
View Source 
const SyntheticsUpdateSimpleBrowserMonitorMutation = `` /* 503-byte string literal not displayed */
View Source 
const SyntheticsUpdateSimpleMonitorMutation = `` /* 428-byte string literal not displayed */
View Source 
const SyntheticsUpdateStepMonitorMutation = `` /* 405-byte string literal not displayed */

Variables

View Source 
var (
	// MonitorTypes specifies the possible types for a Synthetics monitor.
	MonitorTypes = struct {
		Ping            MonitorType
		Browser         MonitorType
		ScriptedBrowser MonitorType
		APITest         MonitorType
	}{
		Ping:            "SIMPLE",
		Browser:         "BROWSER",
		ScriptedBrowser: "SCRIPT_BROWSER",
		APITest:         "SCRIPT_API",
	}

	// MonitorStatus specifies the possible Synthetics monitor status types.
	MonitorStatus = struct {
		Enabled  MonitorStatusType
		Muted    MonitorStatusType
		Disabled MonitorStatusType
	}{
		Enabled:  "ENABLED",
		Muted:    "MUTED",
		Disabled: "DISABLED",
	}
)
View Source 
var Nr1CatalogInstallPlanDestinationTypes = struct {
	// Application (APM) install
	APPLICATION Nr1CatalogInstallPlanDestination
	// Cloud provider install
	CLOUD Nr1CatalogInstallPlanDestination
	// Host install
	HOST Nr1CatalogInstallPlanDestination
	// Kubernetes install
	KUBERNETES Nr1CatalogInstallPlanDestination
	// Unknown install - special case when the target where the install takes place is unknown (such as guided install)
	UNKNOWN Nr1CatalogInstallPlanDestination
}{

	APPLICATION: "APPLICATION",

	CLOUD: "CLOUD",

	HOST: "HOST",

	KUBERNETES: "KUBERNETES",

	UNKNOWN: "UNKNOWN",
}
View Source 
var Nr1CatalogInstallPlanDirectiveModeTypes = struct {
	// Directs the installation toward an external link
	LINK Nr1CatalogInstallPlanDirectiveMode
	// Directs the installation to open a stacked Nerdlet to perform the installation
	NERDLET Nr1CatalogInstallPlanDirectiveMode
	// Directs the installation toward a specific target
	TARGETED Nr1CatalogInstallPlanDirectiveMode
}{

	LINK: "LINK",

	NERDLET: "NERDLET",

	TARGETED: "TARGETED",
}
View Source 
var Nr1CatalogInstallPlanOperatingSystemTypes = struct {
	// Mac operating system
	DARWIN Nr1CatalogInstallPlanOperatingSystem
	// Linux operating system
	LINUX Nr1CatalogInstallPlanOperatingSystem
	// Windows operating system
	WINDOWS Nr1CatalogInstallPlanOperatingSystem
}{

	DARWIN: "DARWIN",

	LINUX: "LINUX",

	WINDOWS: "WINDOWS",
}
View Source 
var Nr1CatalogInstallPlanTargetTypeTypes = struct {
	// Agent install
	AGENT Nr1CatalogInstallPlanTargetType
	// Integration install
	INTEGRATION Nr1CatalogInstallPlanTargetType
	// On host integration install
	ON_HOST_INTEGRATION Nr1CatalogInstallPlanTargetType
	// Unknown install - special case when the target where the install takes place is unknown (such as guided install)
	UNKNOWN Nr1CatalogInstallPlanTargetType
}{

	AGENT: "AGENT",

	INTEGRATION: "INTEGRATION",

	ON_HOST_INTEGRATION: "ON_HOST_INTEGRATION",

	UNKNOWN: "UNKNOWN",
}
View Source 
var SyntheticsMonitorCreateErrorTypeTypes = struct {
	// Received a request missing required fields or containing invalid data
	BAD_REQUEST SyntheticsMonitorCreateErrorType
	// An unknown error occured while processing request to mutate monitor
	INTERNAL_SERVER_ERROR SyntheticsMonitorCreateErrorType
	// Monitor not found for given guid (monitor does not exist on account or has already been deleted)
	NOT_FOUND SyntheticsMonitorCreateErrorType
	// Monitor tags were not udpated.
	TAGGING_ERROR SyntheticsMonitorCreateErrorType
	// User does not have authorization to perform monitor mutation.
	UNAUTHORIZED SyntheticsMonitorCreateErrorType
	// An unknown error occurred while processing request to create monitor
	UNKNOWN_ERROR SyntheticsMonitorCreateErrorType
}{

	BAD_REQUEST: "BAD_REQUEST",

	INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR",

	NOT_FOUND: "NOT_FOUND",

	TAGGING_ERROR: "TAGGING_ERROR",

	UNAUTHORIZED: "UNAUTHORIZED",

	UNKNOWN_ERROR: "UNKNOWN_ERROR",
}
View Source 
var SyntheticsMonitorPeriodTypes = struct {
	// 10 minute monitor period
	EVERY_10_MINUTES SyntheticsMonitorPeriod
	// 12 hour monitor period (720 minutes)
	EVERY_12_HOURS SyntheticsMonitorPeriod
	// 15 minute monitor period
	EVERY_15_MINUTES SyntheticsMonitorPeriod
	// 30 minute monitor period
	EVERY_30_MINUTES SyntheticsMonitorPeriod
	// 5 minute monitor period
	EVERY_5_MINUTES SyntheticsMonitorPeriod
	// 6 hour monitor period (360 minutes)
	EVERY_6_HOURS SyntheticsMonitorPeriod
	// 1 day monitor period (1440 minutes)
	EVERY_DAY SyntheticsMonitorPeriod
	// 1 hour monitor period (60 minutes)
	EVERY_HOUR SyntheticsMonitorPeriod
	// 1 minute monitor period
	EVERY_MINUTE SyntheticsMonitorPeriod
}{

	EVERY_10_MINUTES: "EVERY_10_MINUTES",

	EVERY_12_HOURS: "EVERY_12_HOURS",

	EVERY_15_MINUTES: "EVERY_15_MINUTES",

	EVERY_30_MINUTES: "EVERY_30_MINUTES",

	EVERY_5_MINUTES: "EVERY_5_MINUTES",

	EVERY_6_HOURS: "EVERY_6_HOURS",

	EVERY_DAY: "EVERY_DAY",

	EVERY_HOUR: "EVERY_HOUR",

	EVERY_MINUTE: "EVERY_MINUTE",
}
View Source 
var SyntheticsMonitorStatusTypes = struct {
	// Monitor disabled runs status of a monitor
	DISABLED SyntheticsMonitorStatus
	// Enabled status of a monitor
	ENABLED SyntheticsMonitorStatus
	// Alerts muted status of a monitor
	MUTED SyntheticsMonitorStatus
}{

	DISABLED: "DISABLED",

	ENABLED: "ENABLED",

	MUTED: "MUTED",
}
View Source 
var SyntheticsMonitorUpdateErrorTypeTypes = struct {
	// Received a request missing required fields or containing invalid data
	BAD_REQUEST SyntheticsMonitorUpdateErrorType
	// An unknown error occured while processing request to mutate monitor
	INTERNAL_SERVER_ERROR SyntheticsMonitorUpdateErrorType
	// Monitor not found for given guid (monitor does not exist on account or has already been deleted)
	NOT_FOUND SyntheticsMonitorUpdateErrorType
	// An error occurred while updating monitor script
	SCRIPT_ERROR SyntheticsMonitorUpdateErrorType
	// Monitor tags were not udpated.
	TAGGING_ERROR SyntheticsMonitorUpdateErrorType
	// User does not have authorization to perform monitor mutation.
	UNAUTHORIZED SyntheticsMonitorUpdateErrorType
	// An unknown error occurred while processing request to update monitor
	UNKNOWN_ERROR SyntheticsMonitorUpdateErrorType
}{

	BAD_REQUEST: "BAD_REQUEST",

	INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR",

	NOT_FOUND: "NOT_FOUND",

	SCRIPT_ERROR: "SCRIPT_ERROR",

	TAGGING_ERROR: "TAGGING_ERROR",

	UNAUTHORIZED: "UNAUTHORIZED",

	UNKNOWN_ERROR: "UNKNOWN_ERROR",
}
View Source 
var SyntheticsPrivateLocationMutationErrorTypeTypes = struct {
	// Received a request missing required fields or containing invalid data
	BAD_REQUEST SyntheticsPrivateLocationMutationErrorType
	// An unknown error occured while processing request to purge specified private location job queue
	INTERNAL_SERVER_ERROR SyntheticsPrivateLocationMutationErrorType
	// Private location not found for key (private location does not exist on account or has already been deleted)
	NOT_FOUND SyntheticsPrivateLocationMutationErrorType
	// User does not have authorization to purge job queue for specified private location
	UNAUTHORIZED SyntheticsPrivateLocationMutationErrorType
}{

	BAD_REQUEST: "BAD_REQUEST",

	INTERNAL_SERVER_ERROR: "INTERNAL_SERVER_ERROR",

	NOT_FOUND: "NOT_FOUND",

	UNAUTHORIZED: "UNAUTHORIZED",
}
View Source 
var SyntheticsStepTypeTypes = struct {
	// Assert on element accessed by ID, CSS, or x-path
	ASSERT_ELEMENT SyntheticsStepType
	// Assert on modal exists
	ASSERT_MODAL SyntheticsStepType
	// Assert on text accessed by ID, CSS, or x-path
	ASSERT_TEXT SyntheticsStepType
	// Assert on title of page
	ASSERT_TITLE SyntheticsStepType
	// Click on an element by ID, CSS, or x-path
	CLICK_ELEMENT SyntheticsStepType
	// Preform actions on a modal to dismiss
	DISMISS_MODAL SyntheticsStepType
	// Double click on an element by ID, CSS, or x-path
	DOUBLE_CLICK_ELEMENT SyntheticsStepType
	// Hover over an element by x-path
	HOVER_ELEMENT SyntheticsStepType
	// Navigate to the specified url
	NAVIGATE SyntheticsStepType
	// Input secure credential into element accessed by ID, CSS, or x-path
	SECURE_TEXT_ENTRY SyntheticsStepType
	// Select a dropdown element by value, text, ID, CSS, or x-path
	SELECT_ELEMENT SyntheticsStepType
	// Input text into element accessed by ID, CSS, or x-path
	TEXT_ENTRY SyntheticsStepType
}{

	ASSERT_ELEMENT: "ASSERT_ELEMENT",

	ASSERT_MODAL: "ASSERT_MODAL",

	ASSERT_TEXT: "ASSERT_TEXT",

	ASSERT_TITLE: "ASSERT_TITLE",

	CLICK_ELEMENT: "CLICK_ELEMENT",

	DISMISS_MODAL: "DISMISS_MODAL",

	DOUBLE_CLICK_ELEMENT: "DOUBLE_CLICK_ELEMENT",

	HOVER_ELEMENT: "HOVER_ELEMENT",

	NAVIGATE: "NAVIGATE",

	SECURE_TEXT_ENTRY: "SECURE_TEXT_ENTRY",

	SELECT_ELEMENT: "SELECT_ELEMENT",

	TEXT_ENTRY: "TEXT_ENTRY",
}

Functions

This section is empty.

Types

type Account added in v0.89.0 

type Account struct {
	//
	ID int `json:"id,omitempty"`
	//
	LicenseKey string `json:"licenseKey,omitempty"`
	//
	Name string `json:"name,omitempty"`
	// This field provides access to Synthetics data.
	Synthetics SyntheticsAccountStitchedFields `json:"synthetics,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 Actor added in v0.89.0 

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 EntityGUID added in v0.83.0 

type EntityGUID string

EntityGUID - An encoded Entity GUID

type ErrorDetail 

type ErrorDetail struct {
	Message string `json:"error,omitempty"`
}

ErrorDetail represents an single error from New Relic Synthetics.

type ErrorResponse 

type ErrorResponse struct {
	http.DefaultErrorResponse

	Message            string        `json:"error,omitempty"`
	Messages           []ErrorDetail `json:"errors,omitempty"`
	ServerErrorMessage string        `json:"message,omitempty"`
}

ErrorResponse represents an error response from New Relic Synthetics.

func (*ErrorResponse) Error 

func (e *ErrorResponse) Error() string

Error surfaces an error message from the New Relic Synthetics error response.

func (*ErrorResponse) New added in v0.13.0 

func (e *ErrorResponse) New() http.ErrorResponse

New creates a new instance of ErrorResponse.

type Monitor 

type Monitor struct {
	ID           string            `json:"id,omitempty"`
	Name         string            `json:"name"`
	Type         MonitorType       `json:"type"`
	Frequency    uint              `json:"frequency"`
	URI          string            `json:"uri"`
	Locations    []string          `json:"locations"`
	Status       MonitorStatusType `json:"status"`
	SLAThreshold float64           `json:"slaThreshold"`
	UserID       uint              `json:"userId,omitempty"`
	APIVersion   string            `json:"apiVersion,omitempty"`
	ModifiedAt   *Time             `json:"modifiedAt,omitempty"`
	CreatedAt    *Time             `json:"createdAt,omitempty"`
	Options      MonitorOptions    `json:"options,omitempty"`
}

Monitor represents a New Relic Synthetics monitor.

type MonitorLocation deprecated added in v0.32.0 

type MonitorLocation struct {
	HighSecurityMode bool   `json:"highSecurityMode"`
	Private          bool   `json:"private"`
	Name             string `json:"name"`
	Label            string `json:"label"`
	Description      string `json:"description"`
}

Deprecated: MonitorLocation is now a considered an Entity and adheres to the SyntheticMonitorEntityOutline interface. MonitorLocation represents a valid location for a New Relic Synthetics monitor.

type MonitorOptions 

type MonitorOptions struct {
	ValidationString       string `json:"validationString,omitempty"`
	VerifySSL              bool   `json:"verifySSL,omitempty"`
	BypassHEADRequest      bool   `json:"bypassHEADRequest,omitempty"`
	TreatRedirectAsFailure bool   `json:"treatRedirectAsFailure,omitempty"`
}

MonitorOptions represents the options for a New Relic Synthetics monitor.

type MonitorScript 

type MonitorScript struct {
	Text      string                  `json:"scriptText"`
	Locations []MonitorScriptLocation `json:"scriptLocations"`
}

MonitorScript represents a New Relic Synthetics monitor script.

type MonitorScriptLocation 

type MonitorScriptLocation struct {
	Name string `json:"name"`
	HMAC string `json:"hmac"`
}

MonitorScriptLocation represents a New Relic Synthetics monitor script location.

type MonitorStatusType 

type MonitorStatusType string

MonitorStatusType represents a Synthetics monitor status type.

type MonitorType 

type MonitorType string

MonitorType represents a Synthetics monitor type.

type Nr1CatalogInstallPlanDestination added in v0.89.0 

type Nr1CatalogInstallPlanDestination string

Nr1CatalogInstallPlanDestination - Possible destinations for the install plan target

type Nr1CatalogInstallPlanDirective added in v0.89.0 

type Nr1CatalogInstallPlanDirective struct {
	// The mode of the install plan directive
	Mode Nr1CatalogInstallPlanDirectiveMode `json:"mode"`
}

Nr1CatalogInstallPlanDirective - Information about an install plan directive

func (*Nr1CatalogInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective added in v0.89.0 

func (x *Nr1CatalogInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogInstallPlanDirectiveInterface added in v0.89.0 

type Nr1CatalogInstallPlanDirectiveInterface interface {
	ImplementsNr1CatalogInstallPlanDirective()
}

Nr1CatalogInstallPlanDirective - Information about an install plan directive

func UnmarshalNr1CatalogInstallPlanDirectiveInterface added in v0.89.0 

func UnmarshalNr1CatalogInstallPlanDirectiveInterface(b []byte) (*Nr1CatalogInstallPlanDirectiveInterface, error)

UnmarshalNr1CatalogInstallPlanDirectiveInterface unmarshals the interface into the correct type based on __typename provided by GraphQL

type Nr1CatalogInstallPlanDirectiveMode added in v0.89.0 

type Nr1CatalogInstallPlanDirectiveMode string

Nr1CatalogInstallPlanDirectiveMode - Possible modes for an install plan directive

type Nr1CatalogInstallPlanOperatingSystem added in v0.89.0 

type Nr1CatalogInstallPlanOperatingSystem string

Nr1CatalogInstallPlanOperatingSystem - Possible types for the install plan operating system

type Nr1CatalogInstallPlanStep added in v0.89.0 

type Nr1CatalogInstallPlanStep struct {
	// A short form description for the install plan step
	Description string `json:"description,omitempty"`
	// The human-readable name for the install plan step
	DisplayName string `json:"displayName"`
	// Provides context about how the fallback install plan step should proceed
	Fallback Nr1CatalogInstallPlanDirectiveInterface `json:"fallback,omitempty"`
	// Used as a heading for the install plan step
	Heading string `json:"heading"`
	// The unique identifier for the install plan step
	ID string `json:"id"`
	// Provides context about how the primary install plan step should proceed
	Primary Nr1CatalogInstallPlanDirectiveInterface `json:"primary"`
	// Provides context about where the install will occur
	Target Nr1CatalogInstallPlanTarget `json:"target"`
}

Nr1CatalogInstallPlanStep - Information pertaining to a specific step in the installation plan

func (*Nr1CatalogInstallPlanStep) UnmarshalJSON added in v0.89.0 

func (x *Nr1CatalogInstallPlanStep) UnmarshalJSON(b []byte) error

special

type Nr1CatalogInstallPlanTarget added in v0.89.0 

type Nr1CatalogInstallPlanTarget struct {
	// Provides context on the location the install will take place
	Destination Nr1CatalogInstallPlanDestination `json:"destination"`
	// Provides context for the operating system that will be targeted
	Os []Nr1CatalogInstallPlanOperatingSystem `json:"os"`
	// Provides context for the type of installation that will take place
	Type Nr1CatalogInstallPlanTargetType `json:"type"`
}

Nr1CatalogInstallPlanTarget - Represents the location of an install

type Nr1CatalogInstallPlanTargetType added in v0.89.0 

type Nr1CatalogInstallPlanTargetType string

Nr1CatalogInstallPlanTargetType - Possible types for the install plan target

type Nr1CatalogLinkInstallPlanDirective added in v0.89.0 

type Nr1CatalogLinkInstallPlanDirective struct {
	// The mode of the install plan directive
	Mode Nr1CatalogInstallPlanDirectiveMode `json:"mode"`
	// The URL of the external link used to guide the user through installation
	URL string `json:"url"`
}

Nr1CatalogLinkInstallPlanDirective - Information about a link install plan directive

func (*Nr1CatalogLinkInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective added in v0.89.0 

func (x *Nr1CatalogLinkInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogNerdletInstallPlanDirective added in v0.89.0 

type Nr1CatalogNerdletInstallPlanDirective struct {
	// The mode of the install plan directive
	Mode Nr1CatalogInstallPlanDirectiveMode `json:"mode"`
	// The nerdlet ID used to guide the user through installation
	NerdletId string `json:"nerdletId"`
	// The nerdlet state used to intialize the nerdlet
	NerdletState Nr1CatalogRawNerdletState `json:"nerdletState,omitempty"`
}

Nr1CatalogNerdletInstallPlanDirective - Information about a targeted install plan directive

func (*Nr1CatalogNerdletInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective added in v0.89.0 

func (x *Nr1CatalogNerdletInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogRawNerdletState added in v0.89.0 

type Nr1CatalogRawNerdletState string

Nr1CatalogRawNerdletState - Represents JSON nerdlet state data

type Nr1CatalogTargetedInstallPlanDirective added in v0.89.0 

type Nr1CatalogTargetedInstallPlanDirective struct {
	// The mode of the install plan directive
	Mode Nr1CatalogInstallPlanDirectiveMode `json:"mode"`
	// The name of the recipe used for the installation
	RecipeName string `json:"recipeName"`
}

Nr1CatalogTargetedInstallPlanDirective - Information about a targeted install plan directive

func (*Nr1CatalogTargetedInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective added in v0.89.0 

func (x *Nr1CatalogTargetedInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type SecureCredential added in v0.10.0 

type SecureCredential struct {
	Key         string `json:"key"`
	Description string `json:"description"`
	Value       string `json:"value"`
	CreatedAt   *Time  `json:"createdAt"`
	LastUpdated *Time  `json:"lastUpdated"`
}

SecureCredential represents a Synthetics secure credential.

type SecureValue added in v0.79.0 

type SecureValue string

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

type SemVer added in v0.85.0 

type SemVer string

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

type Synthetics 

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

Synthetics is used to communicate with the New Relic Synthetics product.

func New 

func New(config config.Config) Synthetics

New is used to create a new Synthetics client instance.

func (*Synthetics) AddSecureCredential deprecated added in v0.10.0 

func (s *Synthetics) AddSecureCredential(key, value, description string) (*SecureCredential, error)

Deprecated: Use synthetics.SyntheticsCreateSecureCredential instead.

func (*Synthetics) AddSecureCredentialWithContext deprecated added in v0.60.0 

func (s *Synthetics) AddSecureCredentialWithContext(ctx context.Context, key, value, description string) (*SecureCredential, error)

Deprecated: Use synthetics.SyntheticsCreateSecureCredentialWithContext instead.

func (*Synthetics) CreateMonitor 

func (s *Synthetics) CreateMonitor(monitor Monitor) (*Monitor, error)

CreateMonitor is used to create a New Relic Synthetics monitor. Deprecated: Use one of the following methods instead based on your needs - syntheticsCreateBrokenLinksMonitor(Broken links monitor), syntheticsCreateCertCheckMonitor(Cert Check Monitor), syntheticsCreateScriptBrowserMonitor(Script Browser Monitor), syntheticsCreateSimpleBrowserMonitor(Simple Browser Monitor), syntheticsCreateSimpleMonitor(Simple Monitor), syntheticsCreateStepMonitor(Step Monitor).

func (*Synthetics) CreateMonitorWithContext added in v0.60.0 

func (s *Synthetics) CreateMonitorWithContext(ctx context.Context, monitor Monitor) (*Monitor, error)

CreateMonitorWithContext is used to create a New Relic Synthetics monitor. Deprecated: Use one of the following methods instead based on your needs - syntheticsCreateBrokenLinksMonitorWithContext(Broken links monitor), syntheticsCreateCertCheckMonitorWithContext(Cert Check Monitor), syntheticsCreateScriptBrowserMonitorWithContext(Script Browser Monitor), syntheticsCreateSimpleBrowserMonitorWithContext(Simple Browser Monitor), syntheticsCreateSimpleMonitorWithContext(Simple Monitor), syntheticsCreateStepMonitorWithContext(Step Monitor).

func (*Synthetics) DeleteMonitor 

func (s *Synthetics) DeleteMonitor(monitorID string) error

DeleteMonitor is used to delete a New Relic Synthetics monitor. Deprecated: Use the following method to delete all New Relic Synthetics Monitors. SyntheticsDeleteMonitor

func (*Synthetics) DeleteMonitorWithContext added in v0.60.0 

func (s *Synthetics) DeleteMonitorWithContext(ctx context.Context, monitorID string) error

DeleteMonitorWithContext is used to delete a New Relic Synthetics monitor. Deprecated: Use the following method to delete all New Relic Synthetics Monitors. SyntheticsDeleteMonitorWithContext

func (*Synthetics) DeleteSecureCredential deprecated added in v0.10.0 

func (s *Synthetics) DeleteSecureCredential(key string) error

Deprecated: Use synthetics.SyntheticsDeleteSecureCredential instead

func (*Synthetics) DeleteSecureCredentialWithContext deprecated added in v0.60.0 

func (s *Synthetics) DeleteSecureCredentialWithContext(ctx context.Context, key string) error

Deprecated: Use synthetics.SyntheticsDeleteSecureCredentialWithContext instead

func (*Synthetics) GetMonitor 

func (s *Synthetics) GetMonitor(monitorID string) (*Monitor, error)

GetMonitor is used to retrieve a specific New Relic Synthetics monitor.

func (*Synthetics) GetMonitorLocations deprecated added in v0.32.0 

func (s *Synthetics) GetMonitorLocations() ([]*MonitorLocation, error)

Deprecated: Use entities.GetEntitySearch instead. GetMonitorLocations is used to retrieve all valid locations for Synthetics monitors.

func (*Synthetics) GetMonitorLocationsWithContext deprecated added in v0.60.0 

func (s *Synthetics) GetMonitorLocationsWithContext(ctx context.Context) ([]*MonitorLocation, error)

Deprecated: Use entities.GetEntitySearchWithContext instead. GetMonitorLocationsWithContext is used to retrieve all valid locations for Synthetics monitors.

func (*Synthetics) GetMonitorScript deprecated 

func (s *Synthetics) GetMonitorScript(monitorID string) (*MonitorScript, error)

Deprecated: Use entities.GetEntitySearch instead. GetMonitorScript is used to retrieve the script that belongs to a New Relic Synthetics scripted monitor.

func (*Synthetics) GetMonitorScriptWithContext deprecated added in v0.60.0 

func (s *Synthetics) GetMonitorScriptWithContext(ctx context.Context, monitorID string) (*MonitorScript, error)

Deprecated: Use entities.GetEntitySearchWithContext instead. GetMonitorScriptWithContext is used to retrieve the script that belongs to a New Relic Synthetics scripted monitor.

func (*Synthetics) GetMonitorWithContext added in v0.60.0 

func (s *Synthetics) GetMonitorWithContext(ctx context.Context, monitorID string) (*Monitor, error)

GetMonitorWithContext is used to retrieve a specific New Relic Synthetics monitor.

func (*Synthetics) GetScript added in v0.89.0 

func (a *Synthetics) GetScript(
	accountID int,
	monitorGUID EntityGUID,
) (*SyntheticsMonitorScriptQueryResponse, error)

Query that fetches the script of a specific scripted monitor

func (*Synthetics) GetScriptWithContext added in v0.89.0 

func (a *Synthetics) GetScriptWithContext(
	ctx context.Context,
	accountID int,
	monitorGUID EntityGUID,
) (*SyntheticsMonitorScriptQueryResponse, error)

Query that fetches the script of a specific scripted monitor

func (*Synthetics) GetSecureCredential deprecated added in v0.10.0 

func (s *Synthetics) GetSecureCredential(key string) (*SecureCredential, error)

Deprecated: Use entities.GetEntitySearch instead.

func (*Synthetics) GetSecureCredentialWithContext deprecated added in v0.60.0 

func (s *Synthetics) GetSecureCredentialWithContext(ctx context.Context, key string) (*SecureCredential, error)

Deprecated: Use entities.GetEntitySearchWithContext instead.

func (*Synthetics) GetSecureCredentials deprecated added in v0.10.0 

func (s *Synthetics) GetSecureCredentials() ([]*SecureCredential, error)

Deprecated: Use entities.GetEntitySearch instead.

func (*Synthetics) GetSecureCredentialsWithContext deprecated added in v0.60.0 

func (s *Synthetics) GetSecureCredentialsWithContext(ctx context.Context) ([]*SecureCredential, error)

Deprecated: Use entities.GetEntitySearchWithContext instead.

func (*Synthetics) GetSteps added in v0.89.0 

func (a *Synthetics) GetSteps(
	accountID int,
	monitorGUID EntityGUID,
) (*[]SyntheticsStep, error)

Query that fetches the steps used by the specified Step Monitor

func (*Synthetics) GetStepsWithContext added in v0.89.0 

func (a *Synthetics) GetStepsWithContext(
	ctx context.Context,
	accountID int,
	monitorGUID EntityGUID,
) (*[]SyntheticsStep, error)

Query that fetches the steps used by the specified Step Monitor

func (*Synthetics) ListMonitors 

func (s *Synthetics) ListMonitors() ([]*Monitor, error)

ListMonitors is used to retrieve New Relic Synthetics monitors.

func (*Synthetics) ListMonitorsWithContext added in v0.60.0 

func (s *Synthetics) ListMonitorsWithContext(ctx context.Context) ([]*Monitor, error)

ListMonitorsWithContext is used to retrieve New Relic Synthetics monitors.

func (*Synthetics) SyntheticsCreateBrokenLinksMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateBrokenLinksMonitor(
	accountID int,
	monitor SyntheticsCreateBrokenLinksMonitorInput,
) (*SyntheticsBrokenLinksMonitorCreateMutationResult, error)

Create a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsCreateBrokenLinksMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateBrokenLinksMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateBrokenLinksMonitorInput,
) (*SyntheticsBrokenLinksMonitorCreateMutationResult, error)

Create a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsCreateCertCheckMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateCertCheckMonitor(
	accountID int,
	monitor SyntheticsCreateCertCheckMonitorInput,
) (*SyntheticsCertCheckMonitorCreateMutationResult, error)

Create a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsCreateCertCheckMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateCertCheckMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateCertCheckMonitorInput,
) (*SyntheticsCertCheckMonitorCreateMutationResult, error)

Create a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsCreatePrivateLocation added in v0.83.0 

func (a *Synthetics) SyntheticsCreatePrivateLocation(
	accountID int,
	description string,
	name string,
	verifiedScriptExecution bool,
) (*SyntheticsPrivateLocationMutationResult, error)

Create a Synthetics Private Location

func (*Synthetics) SyntheticsCreatePrivateLocationWithContext added in v0.83.0 

func (a *Synthetics) SyntheticsCreatePrivateLocationWithContext(
	ctx context.Context,
	accountID int,
	description string,
	name string,
	verifiedScriptExecution bool,
) (*SyntheticsPrivateLocationMutationResult, error)

Create a Synthetics Private Location

func (*Synthetics) SyntheticsCreateScriptAPIMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateScriptAPIMonitor(
	accountID int,
	monitor SyntheticsCreateScriptAPIMonitorInput,
) (*SyntheticsScriptAPIMonitorCreateMutationResult, error)

Create a Synthetic Script Api monitor

func (*Synthetics) SyntheticsCreateScriptAPIMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateScriptAPIMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateScriptAPIMonitorInput,
) (*SyntheticsScriptAPIMonitorCreateMutationResult, error)

Create a Synthetic Script Api monitor

func (*Synthetics) SyntheticsCreateScriptBrowserMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateScriptBrowserMonitor(
	accountID int,
	monitor SyntheticsCreateScriptBrowserMonitorInput,
) (*SyntheticsScriptBrowserMonitorCreateMutationResult, error)

Create a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsCreateScriptBrowserMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateScriptBrowserMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateScriptBrowserMonitorInput,
) (*SyntheticsScriptBrowserMonitorCreateMutationResult, error)

Create a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsCreateSecureCredential added in v0.79.0 

func (a *Synthetics) SyntheticsCreateSecureCredential(
	accountID int,
	description string,
	key string,
	value SecureValue,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to create a secure credential

func (*Synthetics) SyntheticsCreateSecureCredentialWithContext added in v0.79.0 

func (a *Synthetics) SyntheticsCreateSecureCredentialWithContext(
	ctx context.Context,
	accountID int,
	description string,
	key string,
	value SecureValue,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to create a secure credential

func (*Synthetics) SyntheticsCreateSimpleBrowserMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateSimpleBrowserMonitor(
	accountID int,
	monitor SyntheticsCreateSimpleBrowserMonitorInput,
) (*SyntheticsSimpleBrowserMonitorCreateMutationResult, error)

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleBrowserMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateSimpleBrowserMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateSimpleBrowserMonitorInput,
) (*SyntheticsSimpleBrowserMonitorCreateMutationResult, error)

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateSimpleMonitor(
	accountID int,
	monitor SyntheticsCreateSimpleMonitorInput,
) (*SyntheticsSimpleBrowserMonitorCreateMutationResult, error)

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateSimpleMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateSimpleMonitorInput,
) (*SyntheticsSimpleBrowserMonitorCreateMutationResult, error)

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateStepMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsCreateStepMonitor(
	accountID int,
	monitor SyntheticsCreateStepMonitorInput,
) (*SyntheticsStepMonitorCreateMutationResult, error)

Create a Synthetic Step monitor

func (*Synthetics) SyntheticsCreateStepMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsCreateStepMonitorWithContext(
	ctx context.Context,
	accountID int,
	monitor SyntheticsCreateStepMonitorInput,
) (*SyntheticsStepMonitorCreateMutationResult, error)

Create a Synthetic Step monitor

func (*Synthetics) SyntheticsDeleteMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsDeleteMonitor(
	gUID EntityGUID,
) (*SyntheticsMonitorDeleteMutationResult, error)

Delete a Synthetic Monitor

func (*Synthetics) SyntheticsDeleteMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsDeleteMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
) (*SyntheticsMonitorDeleteMutationResult, error)

Delete a Synthetic Monitor

func (*Synthetics) SyntheticsDeletePrivateLocation added in v0.83.0 

func (a *Synthetics) SyntheticsDeletePrivateLocation(
	gUID EntityGUID,
) (*SyntheticsPrivateLocationDeleteResult, error)

Delete a Synthetics Private Location

func (*Synthetics) SyntheticsDeletePrivateLocationWithContext added in v0.83.0 

func (a *Synthetics) SyntheticsDeletePrivateLocationWithContext(
	ctx context.Context,
	gUID EntityGUID,
) (*SyntheticsPrivateLocationDeleteResult, error)

Delete a Synthetics Private Location

func (*Synthetics) SyntheticsDeleteSecureCredential added in v0.79.0 

func (a *Synthetics) SyntheticsDeleteSecureCredential(
	accountID int,
	key string,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to delete an existing secure credential

func (*Synthetics) SyntheticsDeleteSecureCredentialWithContext added in v0.79.0 

func (a *Synthetics) SyntheticsDeleteSecureCredentialWithContext(
	ctx context.Context,
	accountID int,
	key string,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to delete an existing secure credential

func (*Synthetics) SyntheticsPurgePrivateLocationQueue added in v0.83.0 

func (a *Synthetics) SyntheticsPurgePrivateLocationQueue(
	gUID EntityGUID,
) (*SyntheticsPrivateLocationPurgeQueueResult, error)

Purge the job queue for a specified private location

func (*Synthetics) SyntheticsPurgePrivateLocationQueueWithContext added in v0.83.0 

func (a *Synthetics) SyntheticsPurgePrivateLocationQueueWithContext(
	ctx context.Context,
	gUID EntityGUID,
) (*SyntheticsPrivateLocationPurgeQueueResult, error)

Purge the job queue for a specified private location

func (*Synthetics) SyntheticsUpdateBrokenLinksMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateBrokenLinksMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateBrokenLinksMonitorInput,
) (*SyntheticsBrokenLinksMonitorUpdateMutationResult, error)

Update a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsUpdateBrokenLinksMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateBrokenLinksMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateBrokenLinksMonitorInput,
) (*SyntheticsBrokenLinksMonitorUpdateMutationResult, error)

Update a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsUpdateCertCheckMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateCertCheckMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateCertCheckMonitorInput,
) (*SyntheticsCertCheckMonitorUpdateMutationResult, error)

Update a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsUpdateCertCheckMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateCertCheckMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateCertCheckMonitorInput,
) (*SyntheticsCertCheckMonitorUpdateMutationResult, error)

Update a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsUpdatePrivateLocation added in v0.83.0 

func (a *Synthetics) SyntheticsUpdatePrivateLocation(
	description string,
	gUID EntityGUID,
	verifiedScriptExecution bool,
) (*SyntheticsPrivateLocationMutationResult, error)

Update a Synthetics Private Location

func (*Synthetics) SyntheticsUpdatePrivateLocationWithContext added in v0.83.0 

func (a *Synthetics) SyntheticsUpdatePrivateLocationWithContext(
	ctx context.Context,
	description string,
	gUID EntityGUID,
	verifiedScriptExecution bool,
) (*SyntheticsPrivateLocationMutationResult, error)

Update a Synthetics Private Location

func (*Synthetics) SyntheticsUpdateScriptAPIMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateScriptAPIMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateScriptAPIMonitorInput,
) (*SyntheticsScriptAPIMonitorUpdateMutationResult, error)

Update a Synthetic Script Api monitor

func (*Synthetics) SyntheticsUpdateScriptAPIMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateScriptAPIMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateScriptAPIMonitorInput,
) (*SyntheticsScriptAPIMonitorUpdateMutationResult, error)

Update a Synthetic Script Api monitor

func (*Synthetics) SyntheticsUpdateScriptBrowserMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateScriptBrowserMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateScriptBrowserMonitorInput,
) (*SyntheticsScriptBrowserMonitorUpdateMutationResult, error)

Update a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsUpdateScriptBrowserMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateScriptBrowserMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateScriptBrowserMonitorInput,
) (*SyntheticsScriptBrowserMonitorUpdateMutationResult, error)

Update a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsUpdateSecureCredential added in v0.79.0 

func (a *Synthetics) SyntheticsUpdateSecureCredential(
	accountID int,
	description string,
	key string,
	value SecureValue,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to update an existing secure credential

func (*Synthetics) SyntheticsUpdateSecureCredentialWithContext added in v0.79.0 

func (a *Synthetics) SyntheticsUpdateSecureCredentialWithContext(
	ctx context.Context,
	accountID int,
	description string,
	key string,
	value SecureValue,
) (*SyntheticsSecureCredentialMutationResult, error)

Queues a request to update an existing secure credential

func (*Synthetics) SyntheticsUpdateSimpleBrowserMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateSimpleBrowserMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateSimpleBrowserMonitorInput,
) (*SyntheticsSimpleBrowserMonitorUpdateMutationResult, error)

Update a Synthetic Simple Browser monitor

func (*Synthetics) SyntheticsUpdateSimpleBrowserMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateSimpleBrowserMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateSimpleBrowserMonitorInput,
) (*SyntheticsSimpleBrowserMonitorUpdateMutationResult, error)

Update a Synthetic Simple Browser monitor

func (*Synthetics) SyntheticsUpdateSimpleMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateSimpleMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateSimpleMonitorInput,
) (*SyntheticsSimpleMonitorUpdateMutationResult, error)

Update a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsUpdateSimpleMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateSimpleMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateSimpleMonitorInput,
) (*SyntheticsSimpleMonitorUpdateMutationResult, error)

Update a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsUpdateStepMonitor added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateStepMonitor(
	gUID EntityGUID,
	monitor SyntheticsUpdateStepMonitorInput,
) (*SyntheticsStepMonitorUpdateMutationResult, error)

Update a Synthetic Step monitor

func (*Synthetics) SyntheticsUpdateStepMonitorWithContext added in v0.85.0 

func (a *Synthetics) SyntheticsUpdateStepMonitorWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitor SyntheticsUpdateStepMonitorInput,
) (*SyntheticsStepMonitorUpdateMutationResult, error)

Update a Synthetic Step monitor

func (*Synthetics) UpdateMonitor 

func (s *Synthetics) UpdateMonitor(monitor Monitor) (*Monitor, error)

UpdateMonitor is used to update a New Relic Synthetics monitor. Deprecated: Use one of the following methods instead based on your needs - syntheticsUpdateBrokenLinksMonitor(Broken links monitor), syntheticsUpdateCertCheckMonitor(Cert Check Monitor), syntheticsUpdateScriptBrowserMonitor(Script Browser Monitor), syntheticsUpdateSimpleBrowserMonitor(Simple Browser Monitor), syntheticsUpdateSimpleMonitor(Simple Monitor), syntheticsUpdateStepMonitor(Step Monitor).

func (*Synthetics) UpdateMonitorScript deprecated 

func (s *Synthetics) UpdateMonitorScript(monitorID string, script MonitorScript) (*MonitorScript, error)

Deprecated: Use one of following instead: 

synthetics.SyntheticsUpdateScriptAPIMonitor
synthetics.SyntheticsUpdateScriptBrowserMonitor

UpdateMonitorScript is used to add a script to an existing New Relic Synthetics monitor_script.

func (*Synthetics) UpdateMonitorScriptWithContext deprecated added in v0.60.0 

func (s *Synthetics) UpdateMonitorScriptWithContext(ctx context.Context, monitorID string, script MonitorScript) (*MonitorScript, error)

Deprecated: Use one of following instead: 

synthetics.SyntheticsUpdateScriptAPIMonitorWithContext
synthetics.SyntheticsUpdateScriptBrowserMonitorWithContext

UpdateMonitorScriptWithContext is used to add a script to an existing New Relic Synthetics monitor_script.

func (*Synthetics) UpdateMonitorWithContext added in v0.60.0 

func (s *Synthetics) UpdateMonitorWithContext(ctx context.Context, monitor Monitor) (*Monitor, error)

UpdateMonitorWithContext is used to update a New Relic Synthetics monitor. Deprecated: Use one of the following methods instead based on your needs - syntheticsUpdateBrokenLinksMonitorWithContext(Broken links monitor), syntheticsUpdateCertCheckMonitorWithContext(Cert Check Monitor), syntheticsUpdateScriptBrowserMonitorWithContext(Script Browser Monitor), syntheticsUpdateSimpleBrowserMonitorWithContext(Simple Browser Monitor), syntheticsUpdateSimpleMonitorWithContext(Simple Monitor), syntheticsUpdateStepMonitorWithContext(Step Monitor).

func (*Synthetics) UpdateSecureCredential deprecated added in v0.10.0 

func (s *Synthetics) UpdateSecureCredential(key, value, description string) (*SecureCredential, error)

Deprecated: Use synthetics.SyntheticsUpdateSecureCredential instead

func (*Synthetics) UpdateSecureCredentialWithContext deprecated added in v0.60.0 

func (s *Synthetics) UpdateSecureCredentialWithContext(ctx context.Context, key, value, description string) (*SecureCredential, error)

Deprecated: Use synthetics.SyntheticsUpdateSecureCredentialWithContext instead

type SyntheticsAccountStitchedFields added in v0.89.0 

type SyntheticsAccountStitchedFields struct {
	// Query that fetches the script of a specific scripted monitor
	Script SyntheticsMonitorScriptQueryResponse `json:"script,omitempty"`
	// visiblity(flag:Synthetics/setGraphqlCustomerVisible) Query that fetches the steps used by the specified Step Monitor
	Steps []SyntheticsStep `json:"steps"`
}

SyntheticsAccountStitchedFields - Nerdgraph account field

type SyntheticsBrokenLinksMonitor added in v0.85.0 

type SyntheticsBrokenLinksMonitor struct {
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsBrokenLinksMonitor - A Broken Links monitor resulting from a Broken Links monitor mutation

type SyntheticsBrokenLinksMonitorCreateMutationResult added in v0.85.0 

type SyntheticsBrokenLinksMonitorCreateMutationResult struct {
	// Errors that occurred during Broken Links monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting Broken Links monitor
	Monitor SyntheticsBrokenLinksMonitor `json:"monitor,omitempty"`
}

SyntheticsBrokenLinksMonitorCreateMutationResult - The result of a Broken Links monitor create mutation

type SyntheticsBrokenLinksMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsBrokenLinksMonitorUpdateMutationResult struct {
	// Errors that occurred during Broken Links monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Broken Links monitor
	Monitor SyntheticsBrokenLinksMonitor `json:"monitor,omitempty"`
}

SyntheticsBrokenLinksMonitorUpdateMutationResult - The result of a Broken Links monitor update mutation

type SyntheticsCertCheckMonitor added in v0.85.0 

type SyntheticsCertCheckMonitor struct {
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The domain of the host that will have its certificate checked
	Domain string `json:"domain,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The desired number of remaining days until the certificate expires to trigger a monitor failure
	NumberDaysToFailBeforeCertExpires int `json:"numberDaysToFailBeforeCertExpires,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
}

SyntheticsCertCheckMonitor - A Cert Check monitor resulting from a Cert Check monitor mutation

type SyntheticsCertCheckMonitorCreateMutationResult added in v0.85.0 

type SyntheticsCertCheckMonitorCreateMutationResult struct {
	// Errors that occurred during Cert Check monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting Cert Check monitor
	Monitor SyntheticsCertCheckMonitor `json:"monitor,omitempty"`
}

SyntheticsCertCheckMonitorCreateMutationResult - The result of a Cert Check monitor create mutation

type SyntheticsCertCheckMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsCertCheckMonitorUpdateMutationResult struct {
	// Errors that occurred during Cert Check monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Cert Check monitor
	Monitor SyntheticsCertCheckMonitor `json:"monitor,omitempty"`
}

SyntheticsCertCheckMonitorUpdateMutationResult - The result of a Cert Check monitor update mutation

type SyntheticsCreateBrokenLinksMonitorInput added in v0.85.0 

type SyntheticsCreateBrokenLinksMonitorInput struct {
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri"`
}

SyntheticsCreateBrokenLinksMonitorInput - The monitor input values needed to create a Broken Links monitor

type SyntheticsCreateBrokenLinksMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateBrokenLinksMonitorQueryResponse struct {
	SyntheticsBrokenLinksMonitorCreateMutationResult SyntheticsBrokenLinksMonitorCreateMutationResult `json:"SyntheticsCreateBrokenLinksMonitor"`
}

type SyntheticsCreateCertCheckMonitorInput added in v0.85.0 

type SyntheticsCreateCertCheckMonitorInput struct {
	// The domain of the host that will have its certificate checked
	Domain string `json:"domain"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The desired number of remaining days until the certificate expires to trigger a monitor failure
	NumberDaysToFailBeforeCertExpires int `json:"numberDaysToFailBeforeCertExpires"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsCreateCertCheckMonitorInput - The monitor input values needed to create a Cert Check monitor

type SyntheticsCreateCertCheckMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateCertCheckMonitorQueryResponse struct {
	SyntheticsCertCheckMonitorCreateMutationResult SyntheticsCertCheckMonitorCreateMutationResult `json:"SyntheticsCreateCertCheckMonitor"`
}

type SyntheticsCreatePrivateLocationQueryResponse added in v0.83.0 

type SyntheticsCreatePrivateLocationQueryResponse struct {
	SyntheticsPrivateLocationMutationResult SyntheticsPrivateLocationMutationResult `json:"SyntheticsCreatePrivateLocation"`
}

type SyntheticsCreateScriptAPIMonitorInput added in v0.85.0 

type SyntheticsCreateScriptAPIMonitorInput struct {
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The script that the monitor runs
	Script string `json:"script"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsCreateScriptAPIMonitorInput - The monitor input values needed to create a Script Api monitor

type SyntheticsCreateScriptAPIMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateScriptAPIMonitorQueryResponse struct {
	SyntheticsScriptAPIMonitorCreateMutationResult SyntheticsScriptAPIMonitorCreateMutationResult `json:"SyntheticsCreateScriptAPIMonitor"`
}

type SyntheticsCreateScriptBrowserMonitorInput added in v0.85.0 

type SyntheticsCreateScriptBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsScriptBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The script that the monitor runs
	Script string `json:"script"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsCreateScriptBrowserMonitorInput - The monitor input values needed to create a Script Browser monitor

type SyntheticsCreateScriptBrowserMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateScriptBrowserMonitorQueryResponse struct {
	SyntheticsScriptBrowserMonitorCreateMutationResult SyntheticsScriptBrowserMonitorCreateMutationResult `json:"SyntheticsCreateScriptBrowserMonitor"`
}

type SyntheticsCreateSecureCredentialQueryResponse added in v0.79.0 

type SyntheticsCreateSecureCredentialQueryResponse struct {
	SyntheticsSecureCredentialMutationResult SyntheticsSecureCredentialMutationResult `json:"SyntheticsCreateSecureCredential"`
}

type SyntheticsCreateSimpleBrowserMonitorInput added in v0.85.0 

type SyntheticsCreateSimpleBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri"`
}

SyntheticsCreateSimpleBrowserMonitorInput - The monitor input values needed to create a Simple Browser monitor

type SyntheticsCreateSimpleBrowserMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateSimpleBrowserMonitorQueryResponse struct {
	SyntheticsSimpleBrowserMonitorCreateMutationResult SyntheticsSimpleBrowserMonitorCreateMutationResult `json:"SyntheticsCreateSimpleBrowserMonitor"`
}

type SyntheticsCreateSimpleMonitorInput added in v0.85.0 

type SyntheticsCreateSimpleMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri"`
}

SyntheticsCreateSimpleMonitorInput - The monitor input values needed to create a Simple (ping) monitor

type SyntheticsCreateSimpleMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateSimpleMonitorQueryResponse struct {
	SyntheticsSimpleBrowserMonitorCreateMutationResult SyntheticsSimpleBrowserMonitorCreateMutationResult `json:"SyntheticsCreateSimpleMonitor"`
}

type SyntheticsCreateStepMonitorInput added in v0.85.0 

type SyntheticsCreateStepMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsStepMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status"`
	// The steps that make up the script the monitor will run
	Steps []SyntheticsStepInput `json:"steps,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsCreateStepMonitorInput - The monitor input values needed to create a Step monitor

type SyntheticsCreateStepMonitorQueryResponse added in v0.85.0 

type SyntheticsCreateStepMonitorQueryResponse struct {
	SyntheticsStepMonitorCreateMutationResult SyntheticsStepMonitorCreateMutationResult `json:"SyntheticsCreateStepMonitor"`
}

type SyntheticsCustomHeader added in v0.85.0 

type SyntheticsCustomHeader struct {
	// Header name
	Name string `json:"name"`
	// Header value
	Value string `json:"value"`
}

SyntheticsCustomHeader - Custom header for monitor jobs

type SyntheticsCustomHeaderInput added in v0.85.0 

type SyntheticsCustomHeaderInput struct {
	// Header name
	Name string `json:"name"`
	// Header value
	Value string `json:"value"`
}

SyntheticsCustomHeaderInput - Custom header input for monitor jobs

type SyntheticsDeleteMonitorQueryResponse added in v0.85.0 

type SyntheticsDeleteMonitorQueryResponse struct {
	SyntheticsMonitorDeleteMutationResult SyntheticsMonitorDeleteMutationResult `json:"SyntheticsDeleteMonitor"`
}

type SyntheticsDeletePrivateLocationQueryResponse added in v0.83.0 

type SyntheticsDeletePrivateLocationQueryResponse struct {
	SyntheticsPrivateLocationDeleteResult SyntheticsPrivateLocationDeleteResult `json:"SyntheticsDeletePrivateLocation"`
}

type SyntheticsDeleteSecureCredentialQueryResponse added in v0.79.0 

type SyntheticsDeleteSecureCredentialQueryResponse struct {
	SyntheticsSecureCredentialMutationResult SyntheticsSecureCredentialMutationResult `json:"SyntheticsDeleteSecureCredential"`
}

type SyntheticsError added in v0.79.0 

type SyntheticsError struct {
	// Description explaining the cause of the error
	Description string `json:"description,omitempty"`
}

SyntheticsError - Error object for Synthetics mutations

type SyntheticsLocations added in v0.85.0 

type SyntheticsLocations struct {
	// Existing private location(s) in which the monitor will run
	Private []string `json:"private,omitempty"`
	// Publicly available location(s) in which the monitor will run
	Public []string `json:"public,omitempty"`
}

SyntheticsLocations - The location(s) from which the monitor runs

type SyntheticsLocationsInput added in v0.85.0 

type SyntheticsLocationsInput struct {
	// Existing private location(s) in which the monitor will run
	Private []string `json:"private,omitempty"`
	// Publicly available location(s) in which the monitor will run
	Public []string `json:"public,omitempty"`
}

SyntheticsLocationsInput - The location(s) from which a non-scripted monitor runs

type SyntheticsMonitorCreateError added in v0.85.0 

type SyntheticsMonitorCreateError struct {
	// String description of error
	Description string `json:"description"`
	// Enum of error that was returned during monitor creation
	Type SyntheticsMonitorCreateErrorType `json:"type"`
}

SyntheticsMonitorCreateError - Error object for Synthetics monitor creation request

type SyntheticsMonitorCreateErrorType added in v0.85.0 

type SyntheticsMonitorCreateErrorType string

SyntheticsMonitorCreateErrorType - Types of errors that can be returned from a create monitor request

type SyntheticsMonitorDeleteMutationResult added in v0.85.0 

type SyntheticsMonitorDeleteMutationResult struct {
	// The unique identifier of the deleted monitor
	DeletedGUID EntityGUID `json:"deletedGuid,omitempty"`
}

SyntheticsMonitorDeleteMutationResult - The result of a monitor delete mutation

type SyntheticsMonitorPeriod added in v0.85.0 

type SyntheticsMonitorPeriod string

SyntheticsMonitorPeriod - Enum of monitor period types

type SyntheticsMonitorScriptQueryResponse added in v0.89.0 

type SyntheticsMonitorScriptQueryResponse struct {
	// The script associated with the specified monitor
	Text string `json:"text,omitempty"`
}

SyntheticsMonitorScriptQueryResponse - The script that a monitor runs

type SyntheticsMonitorStatus added in v0.85.0 

type SyntheticsMonitorStatus string

SyntheticsMonitorStatus - Run state of the monitor

type SyntheticsMonitorUpdateError added in v0.85.0 

type SyntheticsMonitorUpdateError struct {
	// String description of error
	Description string `json:"description"`
	// Enum of error that was returned during monitor update
	Type SyntheticsMonitorUpdateErrorType `json:"type"`
}

SyntheticsMonitorUpdateError - Error object for Synthetics monitor update request

type SyntheticsMonitorUpdateErrorType added in v0.85.0 

type SyntheticsMonitorUpdateErrorType string

SyntheticsMonitorUpdateErrorType - Types of errors that can be returned from a Monitor mutation request

type SyntheticsPrivateLocationDeleteResult added in v0.83.0 

type SyntheticsPrivateLocationDeleteResult struct {
	// An array container errors resulting from the mutation, if any
	Errors []SyntheticsPrivateLocationMutationError `json:"errors,omitempty"`
}

SyntheticsPrivateLocationDeleteResult - An array containing errors from the deletion of a private location, if any

type SyntheticsPrivateLocationInput added in v0.85.0 

type SyntheticsPrivateLocationInput struct {
	// The unique identifier for the Synthetics private location in New Relic
	GUID string `json:"guid"`
	// The location's Verified Script Execution password (Only necessary if Verified Script Execution is enabled for the location)
	VsePassword SecureValue `json:"vsePassword,omitempty"`
}

SyntheticsPrivateLocationInput - Information realating to a private location

type SyntheticsPrivateLocationMutationError added in v0.83.0 

type SyntheticsPrivateLocationMutationError struct {
	// String description of error
	Description string `json:"description"`
	// Enum type of error response
	Type SyntheticsPrivateLocationMutationErrorType `json:"type"`
}

SyntheticsPrivateLocationMutationError - Error object for Synthetic Private Location mutation request

type SyntheticsPrivateLocationMutationErrorType added in v0.83.0 

type SyntheticsPrivateLocationMutationErrorType string

SyntheticsPrivateLocationMutationErrorType - Types of errors that can be returned from a Private Location mutation request

type SyntheticsPrivateLocationMutationResult added in v0.83.0 

type SyntheticsPrivateLocationMutationResult struct {
	// The account associated to the private location
	AccountID int `json:"accountId,omitempty"`
	// A description of the private location
	Description string `json:"description,omitempty"`
	// The private location globally unique identifier
	DomainId string `json:"domainId,omitempty"`
	// An array container errors resulting from the mutation, if any
	Errors []SyntheticsPrivateLocationMutationError `json:"errors,omitempty"`
	// The unique client identifier for the Synthetics private location in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The private locations key
	Key string `json:"key,omitempty"`
	// An alternate identifier based on name
	LocationId string `json:"locationId,omitempty"`
	// The name of the private location
	Name string `json:"name,omitempty"`
	// Specifies whether the private location requires a password for scripted monitors
	VerifiedScriptExecution *bool `json:"verifiedScriptExecution,omitempty"`
}

SyntheticsPrivateLocationMutationResult - Result of a private location mutation

type SyntheticsPrivateLocationPurgeQueueResult added in v0.83.0 

type SyntheticsPrivateLocationPurgeQueueResult struct {
	// An array containing errors resulting from the mutation, if any
	Errors []SyntheticsPrivateLocationMutationError `json:"errors,omitempty"`
}

SyntheticsPrivateLocationPurgeQueueResult - Result of a Synthetics purge private location queue mutation

type SyntheticsPurgePrivateLocationQueueQueryResponse added in v0.83.0 

type SyntheticsPurgePrivateLocationQueueQueryResponse struct {
	SyntheticsPrivateLocationPurgeQueueResult SyntheticsPrivateLocationPurgeQueueResult `json:"SyntheticsPurgePrivateLocationQueue"`
}

type SyntheticsRuntime added in v0.85.0 

type SyntheticsRuntime struct {
	// The runtime type that the monitor will run
	RuntimeType string `json:"runtimeType,omitempty"`
	// The specific version of the runtime type selected
	RuntimeTypeVersion SemVer `json:"runtimeTypeVersion"`
	// The programing language that should execute the script
	ScriptLanguage string `json:"scriptLanguage,omitempty"`
}

SyntheticsRuntime - The runtime that a monitor runs

type SyntheticsRuntimeInput added in v0.85.0 

type SyntheticsRuntimeInput struct {
	// The runtime type that the monitor will run
	RuntimeType string `json:"runtimeType"`
	// The specific version of the runtime type selected
	RuntimeTypeVersion SemVer `json:"runtimeTypeVersion"`
	// The programing language that should execute the script
	ScriptLanguage string `json:"scriptLanguage,omitempty"`
}

SyntheticsRuntimeInput - Input to determine which runtime the monitor will run

type SyntheticsScriptAPIMonitor added in v0.85.0 

type SyntheticsScriptAPIMonitor struct {
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntime `json:"runtime,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
}

SyntheticsScriptAPIMonitor - A Script Api monitor resulting from a Script Api mutation

type SyntheticsScriptAPIMonitorCreateMutationResult added in v0.85.0 

type SyntheticsScriptAPIMonitorCreateMutationResult struct {
	// Errors that occurred during Script Api monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting Script Api monitor
	Monitor SyntheticsScriptAPIMonitor `json:"monitor,omitempty"`
}

SyntheticsScriptAPIMonitorCreateMutationResult - The result of a Script Api monitor create mutation

type SyntheticsScriptAPIMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsScriptAPIMonitorUpdateMutationResult struct {
	// Errors that occurred during Script Api monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Script Api monitor
	Monitor SyntheticsScriptAPIMonitor `json:"monitor,omitempty"`
}

SyntheticsScriptAPIMonitorUpdateMutationResult - The result of a Script Api monitor update mutation

type SyntheticsScriptBrowserMonitor added in v0.85.0 

type SyntheticsScriptBrowserMonitor struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsScriptBrowserMonitorAdvancedOptions `json:"advancedOptions,omitempty"`
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntime `json:"runtime,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
}

SyntheticsScriptBrowserMonitor - A Script Browser monitor resulting from a Script Browser mutation

type SyntheticsScriptBrowserMonitorAdvancedOptions added in v0.85.0 

type SyntheticsScriptBrowserMonitorAdvancedOptions struct {
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
}

SyntheticsScriptBrowserMonitorAdvancedOptions - The advanced options available for a Script Browser monitor

type SyntheticsScriptBrowserMonitorAdvancedOptionsInput added in v0.85.0 

type SyntheticsScriptBrowserMonitorAdvancedOptionsInput struct {
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
}

SyntheticsScriptBrowserMonitorAdvancedOptionsInput - The advanced options inputs available for a Script Browser monitor

type SyntheticsScriptBrowserMonitorCreateMutationResult added in v0.85.0 

type SyntheticsScriptBrowserMonitorCreateMutationResult struct {
	// Errors that occurred during Script Browser monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting script browser monitor
	Monitor SyntheticsScriptBrowserMonitor `json:"monitor,omitempty"`
}

SyntheticsScriptBrowserMonitorCreateMutationResult - The result of a Script Browser monitor create mutation

type SyntheticsScriptBrowserMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsScriptBrowserMonitorUpdateMutationResult struct {
	// Errors that occurred during Script Browser monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting script browser monitor
	Monitor SyntheticsScriptBrowserMonitor `json:"monitor,omitempty"`
}

SyntheticsScriptBrowserMonitorUpdateMutationResult - The result of a Script Browser monitor update mutation

type SyntheticsScriptedMonitorLocationsInput added in v0.85.0 

type SyntheticsScriptedMonitorLocationsInput struct {
	// The private location(s) that the monitor will run jobs from
	Private []SyntheticsPrivateLocationInput `json:"private,omitempty"`
	// The public location(s) that the monitor will run jobs from
	Public []string `json:"public"`
}

SyntheticsScriptedMonitorLocationsInput - The location(s) from which the scripted monitor runs.

type SyntheticsSecureCredentialMutationResult added in v0.79.0 

type SyntheticsSecureCredentialMutationResult struct {
	// The moment when the secure credential was created, represented in milliseconds since the Unix epoch.
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// Description of the secure credential, if available
	Description string `json:"description,omitempty"`
	// An array containing errors, if any
	Errors []SyntheticsError `json:"errors,omitempty"`
	// The unique identifier of the secure credential, if available
	Key string `json:"key,omitempty"`
	// The moment when the secure credential was last updated, represented in milliseconds since the Unix epoch.
	LastUpdate nrtime.EpochMilliseconds `json:"lastUpdate,omitempty"`
}

SyntheticsSecureCredentialMutationResult - The result of a secure credential mutation

type SyntheticsSimpleBrowserMonitor added in v0.85.0 

type SyntheticsSimpleBrowserMonitor struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleBrowserMonitorAdvancedOptions `json:"advancedOptions,omitempty"`
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntime `json:"runtime,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsSimpleBrowserMonitor - A Simple Browser monitor resulting from a Simple Browser monitor mutation

type SyntheticsSimpleBrowserMonitorAdvancedOptions added in v0.85.0 

type SyntheticsSimpleBrowserMonitorAdvancedOptions struct {
	// Custom headers to use in monitor job
	CustomHeaders []SyntheticsCustomHeader `json:"customHeaders,omitempty"`
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
	// Validation text for monitor to search for at given URI
	ResponseValidationText string `json:"responseValidationText,omitempty"`
	// Monitor should validate SSL certificate chain
	UseTlsValidation *bool `json:"useTlsValidation,omitempty"`
}

SyntheticsSimpleBrowserMonitorAdvancedOptions - The advanced options available for a Simple Browser monitor

type SyntheticsSimpleBrowserMonitorAdvancedOptionsInput added in v0.85.0 

type SyntheticsSimpleBrowserMonitorAdvancedOptionsInput struct {
	// Custom headers to use in monitor job
	CustomHeaders []SyntheticsCustomHeaderInput `json:"customHeaders,omitempty"`
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
	// Validation text for monitor to search for at given URI
	ResponseValidationText string `json:"responseValidationText,omitempty"`
	// Monitor should validate SSL certificate chain
	UseTlsValidation *bool `json:"useTlsValidation,omitempty"`
}

SyntheticsSimpleBrowserMonitorAdvancedOptionsInput - The advanced options inputs available for a Simple Browser monitor

type SyntheticsSimpleBrowserMonitorCreateMutationResult added in v0.85.0 

type SyntheticsSimpleBrowserMonitorCreateMutationResult struct {
	// Errors that occurred during Simple Browser monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting Simple Browser monitor
	Monitor SyntheticsSimpleBrowserMonitor `json:"monitor,omitempty"`
}

SyntheticsSimpleBrowserMonitorCreateMutationResult - The result of a Simple Browser monitor create mutation

type SyntheticsSimpleBrowserMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsSimpleBrowserMonitorUpdateMutationResult struct {
	// Errors that occurred during Simple Browser monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Simple Browser monitor
	Monitor SyntheticsSimpleBrowserMonitor `json:"monitor,omitempty"`
}

SyntheticsSimpleBrowserMonitorUpdateMutationResult - The result of a Simple Browser monitor update mutation

type SyntheticsSimpleMonitor added in v0.85.0 

type SyntheticsSimpleMonitor struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleMonitorAdvancedOptions `json:"advancedOptions,omitempty"`
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsSimpleMonitor - A Simple (ping) monitor resulting from a Simple monitor mutation

type SyntheticsSimpleMonitorAdvancedOptions added in v0.85.0 

type SyntheticsSimpleMonitorAdvancedOptions struct {
	// Custom headers to use in monitor job
	CustomHeaders []SyntheticsCustomHeader `json:"customHeaders,omitempty"`
	// Categorize redirects during a monitor job as a failure
	RedirectIsFailure *bool `json:"redirectIsFailure,omitempty"`
	// Validation text for monitor to search for at given URI
	ResponseValidationText string `json:"responseValidationText,omitempty"`
	// Monitor should skip default HEAD request and instead use GET verb in check
	ShouldBypassHeadRequest *bool `json:"shouldBypassHeadRequest,omitempty"`
	// Monitor should validate SSL certificate chain
	UseTlsValidation *bool `json:"useTlsValidation,omitempty"`
}

SyntheticsSimpleMonitorAdvancedOptions - The advanced options available for a Simple (ping) monitor

type SyntheticsSimpleMonitorAdvancedOptionsInput added in v0.85.0 

type SyntheticsSimpleMonitorAdvancedOptionsInput struct {
	// Custom headers to use in monitor job
	CustomHeaders []SyntheticsCustomHeaderInput `json:"customHeaders,omitempty"`
	// Categorize redirects during a monitor job as a failure
	RedirectIsFailure *bool `json:"redirectIsFailure,omitempty"`
	// Validation text for monitor to search for at given URI
	ResponseValidationText string `json:"responseValidationText,omitempty"`
	// Monitor should skip default HEAD request and instead use GET verb in check
	ShouldBypassHeadRequest *bool `json:"shouldBypassHeadRequest,omitempty"`
	// Monitor should validate SSL certificate chain
	UseTlsValidation *bool `json:"useTlsValidation,omitempty"`
}

SyntheticsSimpleMonitorAdvancedOptionsInput - The advanced options inputs available for a Simple (ping) monitor

type SyntheticsSimpleMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsSimpleMonitorUpdateMutationResult struct {
	// Errors that occurred during Simple (ping) monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Simple (ping) monitor
	Monitor SyntheticsSimpleMonitor `json:"monitor,omitempty"`
}

SyntheticsSimpleMonitorUpdateMutationResult - The result of a Simple (ping) monitor update mutation

type SyntheticsStep added in v0.85.0 

type SyntheticsStep struct {
	// The position of the step within the script ranging from 1-100.
	Ordinal int `json:"ordinal"`
	// The type of step to be added to the script
	Type SyntheticsStepType `json:"type"`
	// The metadata values related to the step
	Values []string `json:"values"`
}

SyntheticsStep - A step that will be added to the monitor script

type SyntheticsStepInput added in v0.85.0 

type SyntheticsStepInput struct {
	// The position of the step within the script ranging from 1-100.
	Ordinal int `json:"ordinal"`
	// The type of step to be added to the script
	Type SyntheticsStepType `json:"type"`
	// The metadata values related to the step
	Values []string `json:"values"`
}

SyntheticsStepInput - A step that will be added to the monitor script

type SyntheticsStepMonitor added in v0.85.0 

type SyntheticsStepMonitor struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsStepMonitorAdvancedOptions `json:"advancedOptions,omitempty"`
	// The creation time of the monitor in millis
	CreatedAt nrtime.EpochMilliseconds `json:"createdAt,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	GUID EntityGUID `json:"guid,omitempty"`
	// The unique identifier of the monitor within the Synthetics domain
	ID string `json:"id,omitempty"`
	// The locations the monitor runs from
	Locations SyntheticsLocations `json:"locations,omitempty"`
	// The last modification time of the monitor in millis
	ModifiedAt nrtime.EpochMilliseconds `json:"modifiedAt,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The steps that make up the script the monitor will run
	Steps []SyntheticsStep `json:"steps,omitempty"`
}

SyntheticsStepMonitor - A Step monitor resulting from a Step monitor mutation

type SyntheticsStepMonitorAdvancedOptions added in v0.85.0 

type SyntheticsStepMonitorAdvancedOptions struct {
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
}

SyntheticsStepMonitorAdvancedOptions - The advanced options available for a Step monitor

type SyntheticsStepMonitorAdvancedOptionsInput added in v0.85.0 

type SyntheticsStepMonitorAdvancedOptionsInput struct {
	// Capture a screenshot during job execution
	EnableScreenshotOnFailureAndScript *bool `json:"enableScreenshotOnFailureAndScript,omitempty"`
}

SyntheticsStepMonitorAdvancedOptionsInput - The advanced options inputs available for a Step monitor

type SyntheticsStepMonitorCreateMutationResult added in v0.85.0 

type SyntheticsStepMonitorCreateMutationResult struct {
	// Errors that occurred during Step monitor create mutation
	Errors []SyntheticsMonitorCreateError `json:"errors"`
	// The resulting Step monitor
	Monitor SyntheticsStepMonitor `json:"monitor,omitempty"`
}

SyntheticsStepMonitorCreateMutationResult - The result of a Step monitor create mutation

type SyntheticsStepMonitorUpdateMutationResult added in v0.85.0 

type SyntheticsStepMonitorUpdateMutationResult struct {
	// Errors that occurred during Step monitor update mutation
	Errors []SyntheticsMonitorUpdateError `json:"errors"`
	// The resulting Step monitor
	Monitor SyntheticsStepMonitor `json:"monitor,omitempty"`
}

SyntheticsStepMonitorUpdateMutationResult - The result of a Step monitor update mutation

type SyntheticsStepType added in v0.85.0 

type SyntheticsStepType string

SyntheticsStepType - enum of of script step types

type SyntheticsTag added in v0.85.0 

type SyntheticsTag struct {
	// Name of the tag key
	Key string `json:"key"`
	// Values associated with the tag key
	Values []string `json:"values"`
}

SyntheticsTag - Tag entries for the monitor

type SyntheticsUpdateBrokenLinksMonitorInput added in v0.85.0 

type SyntheticsUpdateBrokenLinksMonitorInput struct {
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsUpdateBrokenLinksMonitorInput - The monitor values that can be updated on a Broken Links monitor

type SyntheticsUpdateBrokenLinksMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateBrokenLinksMonitorQueryResponse struct {
	SyntheticsBrokenLinksMonitorUpdateMutationResult SyntheticsBrokenLinksMonitorUpdateMutationResult `json:"SyntheticsUpdateBrokenLinksMonitor"`
}

type SyntheticsUpdateCertCheckMonitorInput added in v0.85.0 

type SyntheticsUpdateCertCheckMonitorInput struct {
	// The domain of the host that will have its certificate checked
	Domain string `json:"domain,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The desired number of remaining days until the certificate expires to trigger a monitor failure
	NumberDaysToFailBeforeCertExpires int `json:"numberDaysToFailBeforeCertExpires,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsUpdateCertCheckMonitorInput - The monitor values that can be updated on a Cert Check monitor

type SyntheticsUpdateCertCheckMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateCertCheckMonitorQueryResponse struct {
	SyntheticsCertCheckMonitorUpdateMutationResult SyntheticsCertCheckMonitorUpdateMutationResult `json:"SyntheticsUpdateCertCheckMonitor"`
}

type SyntheticsUpdatePrivateLocationQueryResponse added in v0.83.0 

type SyntheticsUpdatePrivateLocationQueryResponse struct {
	SyntheticsPrivateLocationMutationResult SyntheticsPrivateLocationMutationResult `json:"SyntheticsUpdatePrivateLocation"`
}

type SyntheticsUpdateScriptAPIMonitorInput added in v0.85.0 

type SyntheticsUpdateScriptAPIMonitorInput struct {
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The script that the monitor runs
	Script string `json:"script,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsUpdateScriptAPIMonitorInput - The monitor values that can be updated on a Script Api monitor

type SyntheticsUpdateScriptAPIMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateScriptAPIMonitorQueryResponse struct {
	SyntheticsScriptAPIMonitorUpdateMutationResult SyntheticsScriptAPIMonitorUpdateMutationResult `json:"SyntheticsUpdateScriptAPIMonitor"`
}

type SyntheticsUpdateScriptBrowserMonitorInput added in v0.85.0 

type SyntheticsUpdateScriptBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsScriptBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The script that the monitor runs
	Script string `json:"script,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsUpdateScriptBrowserMonitorInput - The monitor values that can be updated on a Script Browser monitor

type SyntheticsUpdateScriptBrowserMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateScriptBrowserMonitorQueryResponse struct {
	SyntheticsScriptBrowserMonitorUpdateMutationResult SyntheticsScriptBrowserMonitorUpdateMutationResult `json:"SyntheticsUpdateScriptBrowserMonitor"`
}

type SyntheticsUpdateSecureCredentialQueryResponse added in v0.79.0 

type SyntheticsUpdateSecureCredentialQueryResponse struct {
	SyntheticsSecureCredentialMutationResult SyntheticsSecureCredentialMutationResult `json:"SyntheticsUpdateSecureCredential"`
}

type SyntheticsUpdateSimpleBrowserMonitorInput added in v0.85.0 

type SyntheticsUpdateSimpleBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The runtime that the monitor will use to run jobs
	Runtime SyntheticsRuntimeInput `json:"runtime,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsUpdateSimpleBrowserMonitorInput - The monitor values that can be updated on a Simple Browser monitor

type SyntheticsUpdateSimpleBrowserMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateSimpleBrowserMonitorQueryResponse struct {
	SyntheticsSimpleBrowserMonitorUpdateMutationResult SyntheticsSimpleBrowserMonitorUpdateMutationResult `json:"SyntheticsUpdateSimpleBrowserMonitor"`
}

type SyntheticsUpdateSimpleMonitorInput added in v0.85.0 

type SyntheticsUpdateSimpleMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
	// The uri the monitor runs against
	Uri string `json:"uri,omitempty"`
}

SyntheticsUpdateSimpleMonitorInput - The monitor values that can be updated on a simple (ping) monitor

type SyntheticsUpdateSimpleMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateSimpleMonitorQueryResponse struct {
	SyntheticsSimpleMonitorUpdateMutationResult SyntheticsSimpleMonitorUpdateMutationResult `json:"SyntheticsUpdateSimpleMonitor"`
}

type SyntheticsUpdateStepMonitorInput added in v0.85.0 

type SyntheticsUpdateStepMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsStepMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The locations the monitor will run from
	Locations SyntheticsScriptedMonitorLocationsInput `json:"locations,omitempty"`
	// The human readable identifier for the monitor
	Name string `json:"name,omitempty"`
	// The interval at which the monitor runs in minutes
	Period SyntheticsMonitorPeriod `json:"period,omitempty"`
	// The run state of the monitor
	Status SyntheticsMonitorStatus `json:"status,omitempty"`
	// The steps that make up the script the monitor will run
	Steps []SyntheticsStepInput `json:"steps,omitempty"`
	// The tags that will be associated with the monitor
	Tags []SyntheticsTag `json:"tags,omitempty"`
}

SyntheticsUpdateStepMonitorInput - The monitor values that can be updated on a Step monitor

type SyntheticsUpdateStepMonitorQueryResponse added in v0.85.0 

type SyntheticsUpdateStepMonitorQueryResponse struct {
	SyntheticsStepMonitorUpdateMutationResult SyntheticsStepMonitorUpdateMutationResult `json:"SyntheticsUpdateStepMonitor"`
}

type Time 

type Time time.Time

Time is a type used for unmarshaling timestamps generated by the Synthetics API. Its underlying type is time.Time.

func (Time) Equal 

func (t Time) Equal(u Time) bool

Equal provides a comparator for the Time type.

func (Time) MarshalJSON 

func (t Time) MarshalJSON() ([]byte, error)

MarshalJSON is responsible for marshaling the Time type.

func (*Time) UnmarshalJSON 

func (t *Time) UnmarshalJSON(s []byte) (err error)

UnmarshalJSON is responsible for unmarshaling the Time type.

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.