synthetics

package
v2.43.0 Latest Latest
Warning

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

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

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 = `` /* 381-byte string literal not displayed */
View Source 
const SyntheticsCreateCertCheckMonitorMutation = `` /* 416-byte string literal not displayed */
View Source 
const SyntheticsCreateDailyMonitorDowntimeMutation = `` /* 507-byte string literal not displayed */
View Source 
const SyntheticsCreateMonthlyMonitorDowntimeMutation = `` /* 671-byte string literal not displayed */
View Source 
const SyntheticsCreateOnceMonitorDowntimeMutation = `` /* 402-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 = `` /* 617-byte string literal not displayed */
View Source 
const SyntheticsCreateSimpleMonitorMutation = `` /* 497-byte string literal not displayed */
View Source 
const SyntheticsCreateStepMonitorMutation = `` /* 466-byte string literal not displayed */
View Source 
const SyntheticsCreateWeeklyMonitorDowntimeMutation = `` /* 618-byte string literal not displayed */
View Source 
const SyntheticsDeleteMonitorDowntimeMutation = `mutation(
	$guid: EntityGuid!,
) { syntheticsDeleteMonitorDowntime(
	guid: $guid,
) {
	guid
} }`
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 SyntheticsEditDailyMonitorDowntimeMutation = `` /* 343-byte string literal not displayed */
View Source 
const SyntheticsEditMonitorDowntimeMutation = `` /* 638-byte string literal not displayed */

Mutation generated by Tutone, but currently not being used, replaced by synthetics_api_monitor_downtime.go If Tutone is seen to make changes to the following mutation, they would need to be manually changed in in the above file

View Source 
const SyntheticsEditMonthlyMonitorDowntimeMutation = `` /* 432-byte string literal not displayed */
View Source 
const SyntheticsEditOneTimeMonitorDowntimeMutation = `` /* 303-byte string literal not displayed */
View Source 
const SyntheticsEditWeeklyMonitorDowntimeMutation = `` /* 364-byte string literal not displayed */
View Source 
const SyntheticsPurgePrivateLocationQueueMutation = `` /* 127-byte string literal not displayed */
View Source 
const SyntheticsStartAutomatedTestMutation = `` /* 188-byte string literal not displayed */
View Source 
const SyntheticsUpdateBrokenLinksMonitorMutation = `` /* 373-byte string literal not displayed */
View Source 
const SyntheticsUpdateCertCheckMonitorMutation = `` /* 408-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 = `` /* 609-byte string literal not displayed */
View Source 
const SyntheticsUpdateSimpleMonitorMutation = `` /* 428-byte string literal not displayed */
View Source 
const SyntheticsUpdateStepMonitorMutation = `` /* 458-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
		Disabled MonitorStatusType
	}{
		Enabled:  "ENABLED",
		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 SyntheticsAutomatedTestStatusTypes = struct {
	// At least one blocking job in the automated test has failed
	FAILED SyntheticsAutomatedTestStatus
	// Indicates jobs in the automated test are still running
	IN_PROGRESS SyntheticsAutomatedTestStatus
	// All blocking jobs in the automated test has passed
	PASSED SyntheticsAutomatedTestStatus
	// Some jobs in the automated test failed to provide a status within the timeout
	TIMEOUT SyntheticsAutomatedTestStatus
}{

	FAILED: "FAILED",

	IN_PROGRESS: "IN_PROGRESS",

	PASSED: "PASSED",

	TIMEOUT: "TIMEOUT",
}
View Source 
var SyntheticsDeviceOrientationTypes = struct {
	// This allows the screenshot to be taken in the landscape orientation
	LANDSCAPE SyntheticsDeviceOrientation
	// This will disable device emulation
	NONE SyntheticsDeviceOrientation
	// This allows the screenshot to be taken in the portrait orientation
	PORTRAIT SyntheticsDeviceOrientation
}{

	LANDSCAPE: "LANDSCAPE",

	NONE: "NONE",

	PORTRAIT: "PORTRAIT",
}
View Source 
var SyntheticsDeviceTypeTypes = struct {
	// This will be dimensions for a typical mobile device
	MOBILE SyntheticsDeviceType
	// This will disable device emulation
	NONE SyntheticsDeviceType
	// This will be dimensions for a typical tablet device
	TABLET SyntheticsDeviceType
}{

	MOBILE: "MOBILE",

	NONE: "NONE",

	TABLET: "TABLET",
}
View Source 
var SyntheticsJobStatusTypes = struct {
	// Indicates the job has failed
	FAILED SyntheticsJobStatus
	// Indicates an in-progress job
	PENDING SyntheticsJobStatus
	// Indicates the job has succeeded
	SUCCESS SyntheticsJobStatus
	// Indicates the job status was lost or unknown
	UNKNOWN SyntheticsJobStatus
}{

	FAILED: "FAILED",

	PENDING: "PENDING",

	SUCCESS: "SUCCESS",

	UNKNOWN: "UNKNOWN",
}
View Source 
var SyntheticsMonitorCreateErrorTypeTypes = struct {
	// Received a request missing required fields or containing invalid data
	BAD_REQUEST SyntheticsMonitorCreateErrorType
	// An unknown error occurred 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 creation exceeds account subscription limits
	PAYMENT_REQUIRED SyntheticsMonitorCreateErrorType
	// Monitor tags were not updated.
	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",

	PAYMENT_REQUIRED: "PAYMENT_REQUIRED",

	TAGGING_ERROR: "TAGGING_ERROR",

	UNAUTHORIZED: "UNAUTHORIZED",

	UNKNOWN_ERROR: "UNKNOWN_ERROR",
}
View Source 
var SyntheticsMonitorDowntimeDayOfMonthOrdinalTypes = struct {
	// First selected day of the month
	FIRST SyntheticsMonitorDowntimeDayOfMonthOrdinal
	// Fourth selected day of the month
	FOURTH SyntheticsMonitorDowntimeDayOfMonthOrdinal
	// Last selected day of the month
	LAST SyntheticsMonitorDowntimeDayOfMonthOrdinal
	// Second selected day of the month
	SECOND SyntheticsMonitorDowntimeDayOfMonthOrdinal
	// Third selected day of the month
	THIRD SyntheticsMonitorDowntimeDayOfMonthOrdinal
}{

	FIRST: "FIRST",

	FOURTH: "FOURTH",

	LAST: "LAST",

	SECOND: "SECOND",

	THIRD: "THIRD",
}
View Source 
var SyntheticsMonitorDowntimeWeekDaysTypes = struct {
	// Select monitor downtime to run on Friday
	FRIDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Monday
	MONDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Saturday
	SATURDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Sunday
	SUNDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Thursday
	THURSDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Tuesday
	TUESDAY SyntheticsMonitorDowntimeWeekDays
	// Select monitor downtime to run on Wednesday
	WEDNESDAY SyntheticsMonitorDowntimeWeekDays
}{

	FRIDAY: "FRIDAY",

	MONDAY: "MONDAY",

	SATURDAY: "SATURDAY",

	SUNDAY: "SUNDAY",

	THURSDAY: "THURSDAY",

	TUESDAY: "TUESDAY",

	WEDNESDAY: "WEDNESDAY",
}
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
}{

	DISABLED: "DISABLED",

	ENABLED: "ENABLED",
}
View Source 
var SyntheticsMonitorTypeTypes = struct {
	// Broken links monitor
	BROKEN_LINKS SyntheticsMonitorType
	// Simple browser monitor
	BROWSER SyntheticsMonitorType
	// Certificate Check
	CERT_CHECK SyntheticsMonitorType
	// Script API monitor
	SCRIPT_API SyntheticsMonitorType
	// Script browser monitor
	SCRIPT_BROWSER SyntheticsMonitorType
	// Simple (ping) monitor
	SIMPLE SyntheticsMonitorType
	// Step Monitor
	STEP_MONITOR SyntheticsMonitorType
}{

	BROKEN_LINKS: "BROKEN_LINKS",

	BROWSER: "BROWSER",

	CERT_CHECK: "CERT_CHECK",

	SCRIPT_API: "SCRIPT_API",

	SCRIPT_BROWSER: "SCRIPT_BROWSER",

	SIMPLE: "SIMPLE",

	STEP_MONITOR: "STEP_MONITOR",
}
View Source 
var SyntheticsMonitorUpdateErrorTypeTypes = struct {
	// Received a request missing required fields or containing invalid data
	BAD_REQUEST SyntheticsMonitorUpdateErrorType
	// An unknown error occurred 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
	// Monitor update exceeds account subscription limits
	PAYMENT_REQUIRED SyntheticsMonitorUpdateErrorType
	// An error occurred while updating monitor script
	SCRIPT_ERROR SyntheticsMonitorUpdateErrorType
	// Monitor tags were not updated.
	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",

	PAYMENT_REQUIRED: "PAYMENT_REQUIRED",

	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 occurred 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 

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 

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 Date added in v2.23.0 

type Date string

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

type EntityGUID 

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 

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

New creates a new instance of ErrorResponse.

type Float added in v2.18.0 

type Float string

Float - The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_754).

type Milliseconds added in v2.21.0 

type Milliseconds string

Milliseconds - The `Milliseconds` scalar represents a duration in milliseconds

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 

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 NaiveDateTime added in v2.23.0 

type NaiveDateTime string

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

type Nr1CatalogInstallPlanDestination 

type Nr1CatalogInstallPlanDestination string

Nr1CatalogInstallPlanDestination - Possible destinations for the install plan target

type Nr1CatalogInstallPlanDirective 

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

Nr1CatalogInstallPlanDirective - Information about an install plan directive

func (*Nr1CatalogInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective 

func (x *Nr1CatalogInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogInstallPlanDirectiveInterface 

type Nr1CatalogInstallPlanDirectiveInterface interface {
	ImplementsNr1CatalogInstallPlanDirective()
}

Nr1CatalogInstallPlanDirective - Information about an install plan directive

func UnmarshalNr1CatalogInstallPlanDirectiveInterface 

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

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

type Nr1CatalogInstallPlanDirectiveMode 

type Nr1CatalogInstallPlanDirectiveMode string

Nr1CatalogInstallPlanDirectiveMode - Possible modes for an install plan directive

type Nr1CatalogInstallPlanOperatingSystem 

type Nr1CatalogInstallPlanOperatingSystem string

Nr1CatalogInstallPlanOperatingSystem - Possible types for the install plan operating system

type Nr1CatalogInstallPlanStep 

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 

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

special

type Nr1CatalogInstallPlanTarget 

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 

type Nr1CatalogInstallPlanTargetType string

Nr1CatalogInstallPlanTargetType - Possible types for the install plan target

type Nr1CatalogLinkInstallPlanDirective 

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 

func (x *Nr1CatalogLinkInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogNerdletInstallPlanDirective 

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 

func (x *Nr1CatalogNerdletInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type Nr1CatalogRawNerdletState 

type Nr1CatalogRawNerdletState string

Nr1CatalogRawNerdletState - Represents JSON nerdlet state data

type Nr1CatalogTargetedInstallPlanDirective 

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 

func (x *Nr1CatalogTargetedInstallPlanDirective) ImplementsNr1CatalogInstallPlanDirective()

type SecureCredential 

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 

type SecureValue string

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

type SemVer 

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 

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

Deprecated: Use synthetics.SyntheticsCreateSecureCredential instead.

func (*Synthetics) AddSecureCredentialWithContext deprecated 

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 

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 

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 

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

Deprecated: Use synthetics.SyntheticsDeleteSecureCredential instead

func (*Synthetics) DeleteSecureCredentialWithContext deprecated 

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

Deprecated: Use synthetics.SyntheticsDeleteSecureCredentialWithContext instead

func (*Synthetics) GetAutomatedTestResult added in v2.21.0 

func (a *Synthetics) GetAutomatedTestResult(
	accountID int,
	batchId string,
) (*SyntheticsAutomatedTestResult, error)

Query that fetches results for an automated test

func (*Synthetics) GetAutomatedTestResultWithContext added in v2.21.0 

func (a *Synthetics) GetAutomatedTestResultWithContext(
	ctx context.Context,
	accountID int,
	batchId string,
) (*SyntheticsAutomatedTestResult, error)

Query that fetches results for an automated test

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 

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 

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 

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 

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 

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

Query that fetches the script of a specific scripted monitor

func (*Synthetics) GetScriptWithContext 

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 

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

Deprecated: Use entities.GetEntitySearch instead.

func (*Synthetics) GetSecureCredentialWithContext deprecated 

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

Deprecated: Use entities.GetEntitySearchWithContext instead.

func (*Synthetics) GetSecureCredentials deprecated 

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

Deprecated: Use entities.GetEntitySearch instead.

func (*Synthetics) GetSecureCredentialsWithContext deprecated 

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

Deprecated: Use entities.GetEntitySearchWithContext instead.

func (*Synthetics) GetSteps 

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

visiblity(flag:Synthetics/setGraphqlCustomerVisible) Query that fetches the steps used by the specified Step Monitor

func (*Synthetics) GetStepsWithContext 

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

visiblity(flag:Synthetics/setGraphqlCustomerVisible) 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 

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

ListMonitorsWithContext is used to retrieve New Relic Synthetics monitors.

func (*Synthetics) SyntheticsCreateBrokenLinksMonitor 

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

Create a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsCreateBrokenLinksMonitorWithContext 

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

Create a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsCreateCertCheckMonitor 

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

Create a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsCreateCertCheckMonitorWithContext 

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

Create a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsCreateDailyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsCreateDailyMonitorDowntime(
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsDailyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs daily

func (*Synthetics) SyntheticsCreateDailyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsCreateDailyMonitorDowntimeWithContext(
	ctx context.Context,
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsDailyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs daily

func (*Synthetics) SyntheticsCreateMonthlyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsCreateMonthlyMonitorDowntime(
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	frequency SyntheticsMonitorDowntimeMonthlyFrequency,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsMonthlyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs monthly

func (*Synthetics) SyntheticsCreateMonthlyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsCreateMonthlyMonitorDowntimeWithContext(
	ctx context.Context,
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	frequency SyntheticsMonitorDowntimeMonthlyFrequency,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsMonthlyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs monthly

func (*Synthetics) SyntheticsCreateOnceMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsCreateOnceMonitorDowntime(
	accountID int,
	endTime NaiveDateTime,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsOnceMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs once

func (*Synthetics) SyntheticsCreateOnceMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsCreateOnceMonitorDowntimeWithContext(
	ctx context.Context,
	accountID int,
	endTime NaiveDateTime,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsOnceMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs once

func (*Synthetics) SyntheticsCreatePrivateLocation 

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

Create a Synthetics Private Location

func (*Synthetics) SyntheticsCreatePrivateLocationWithContext 

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 

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

Create a Synthetic Script Api monitor

func (*Synthetics) SyntheticsCreateScriptAPIMonitorWithContext 

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

Create a Synthetic Script Api monitor

func (*Synthetics) SyntheticsCreateScriptBrowserMonitor 

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

Create a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsCreateScriptBrowserMonitorWithContext 

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

Create a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsCreateSecureCredential 

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 

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 

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

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleBrowserMonitorWithContext 

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

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleMonitor 

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

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateSimpleMonitorWithContext 

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

Create a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsCreateStepMonitor 

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

Create a Synthetic Step monitor

func (*Synthetics) SyntheticsCreateStepMonitorWithContext 

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

Create a Synthetic Step monitor

func (*Synthetics) SyntheticsCreateWeeklyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsCreateWeeklyMonitorDowntime(
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	maintenanceDays []SyntheticsMonitorDowntimeWeekDays,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsWeeklyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs weekly

func (*Synthetics) SyntheticsCreateWeeklyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsCreateWeeklyMonitorDowntimeWithContext(
	ctx context.Context,
	accountID int,
	endRepeat SyntheticsDateWindowEndConfig,
	endTime NaiveDateTime,
	maintenanceDays []SyntheticsMonitorDowntimeWeekDays,
	monitorGUIDs []EntityGUID,
	name string,
	startTime NaiveDateTime,
	timezone string,
) (*SyntheticsWeeklyMonitorDowntimeMutationResult, error)

Create a monitor downtime that runs weekly

func (*Synthetics) SyntheticsDeleteMonitor 

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

Delete a Synthetic Monitor

func (*Synthetics) SyntheticsDeleteMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsDeleteMonitorDowntime(
	gUID EntityGUID,
) (*SyntheticsMonitorDowntimeDeleteResult, error)

Delete a monitor downtime

func (*Synthetics) SyntheticsDeleteMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsDeleteMonitorDowntimeWithContext(
	ctx context.Context,
	gUID EntityGUID,
) (*SyntheticsMonitorDowntimeDeleteResult, error)

Delete a monitor downtime

func (*Synthetics) SyntheticsDeleteMonitorWithContext 

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

Delete a Synthetic Monitor

func (*Synthetics) SyntheticsDeletePrivateLocation 

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

Delete a Synthetics Private Location

func (*Synthetics) SyntheticsDeletePrivateLocationWithContext 

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

Delete a Synthetics Private Location

func (*Synthetics) SyntheticsDeleteSecureCredential 

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

Queues a request to delete an existing secure credential

func (*Synthetics) SyntheticsDeleteSecureCredentialWithContext 

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

Queues a request to delete an existing secure credential

func (*Synthetics) SyntheticsEditDailyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsEditDailyMonitorDowntime(
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	daily SyntheticsMonitorDowntimeDailyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditDailyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsEditDailyMonitorDowntimeWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	daily SyntheticsMonitorDowntimeDailyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsEditMonitorDowntime(
	daily SyntheticsMonitorDowntimeDailyConfig,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	monthly SyntheticsMonitorDowntimeMonthlyConfig,
	name string,
	once SyntheticsMonitorDowntimeOnceConfig,
	weekly SyntheticsMonitorDowntimeWeeklyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

Edit a monitor downtime

func (*Synthetics) SyntheticsEditMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsEditMonitorDowntimeWithContext(
	ctx context.Context,
	daily SyntheticsMonitorDowntimeDailyConfig,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	monthly SyntheticsMonitorDowntimeMonthlyConfig,
	name string,
	once SyntheticsMonitorDowntimeOnceConfig,
	weekly SyntheticsMonitorDowntimeWeeklyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

Edit a monitor downtime Function generated by Tutone, but currently not being used, replaced by synthetics_api_monitor_downtime.go If Tutone is seen to make changes to the following mutation, they would need to be manually changed in in the above file

func (*Synthetics) SyntheticsEditMonthlyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsEditMonthlyMonitorDowntime(
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	monthly SyntheticsMonitorDowntimeMonthlyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditMonthlyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsEditMonthlyMonitorDowntimeWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	monthly SyntheticsMonitorDowntimeMonthlyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditOneTimeMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsEditOneTimeMonitorDowntime(
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	once SyntheticsMonitorDowntimeOnceConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditOneTimeMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsEditOneTimeMonitorDowntimeWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	once SyntheticsMonitorDowntimeOnceConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditWeeklyMonitorDowntime added in v2.23.0 

func (a *Synthetics) SyntheticsEditWeeklyMonitorDowntime(
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	weekly SyntheticsMonitorDowntimeWeeklyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsEditWeeklyMonitorDowntimeWithContext added in v2.23.0 

func (a *Synthetics) SyntheticsEditWeeklyMonitorDowntimeWithContext(
	ctx context.Context,
	gUID EntityGUID,
	monitorGUIDs []EntityGUID,
	name string,
	weekly SyntheticsMonitorDowntimeWeeklyConfig,
) (*SyntheticsMonitorDowntimeMutationResult, error)

func (*Synthetics) SyntheticsPurgePrivateLocationQueue 

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

Purge the job queue for a specified private location

func (*Synthetics) SyntheticsPurgePrivateLocationQueueWithContext 

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

Purge the job queue for a specified private location

func (*Synthetics) SyntheticsStartAutomatedTest added in v2.21.0 

func (a *Synthetics) SyntheticsStartAutomatedTest(
	config SyntheticsAutomatedTestConfigInput,
	tests []SyntheticsAutomatedTestMonitorInput,
) (*SyntheticsAutomatedTestStartResult, error)

Starts automated testing job

func (*Synthetics) SyntheticsStartAutomatedTestWithContext added in v2.21.0 

func (a *Synthetics) SyntheticsStartAutomatedTestWithContext(
	ctx context.Context,
	config SyntheticsAutomatedTestConfigInput,
	tests []SyntheticsAutomatedTestMonitorInput,
) (*SyntheticsAutomatedTestStartResult, error)

Starts automated testing job

func (*Synthetics) SyntheticsUpdateBrokenLinksMonitor 

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

Update a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsUpdateBrokenLinksMonitorWithContext 

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

Update a Synthetic Broken Links monitor

func (*Synthetics) SyntheticsUpdateCertCheckMonitor 

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

Update a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsUpdateCertCheckMonitorWithContext 

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

Update a Synthetic Cert Check (Certificate check) monitor

func (*Synthetics) SyntheticsUpdatePrivateLocation 

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

Update a Synthetics Private Location

func (*Synthetics) SyntheticsUpdatePrivateLocationWithContext 

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

Update a Synthetics Private Location

func (*Synthetics) SyntheticsUpdateScriptAPIMonitor 

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

Update a Synthetic Script Api monitor

func (*Synthetics) SyntheticsUpdateScriptAPIMonitorWithContext 

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

Update a Synthetic Script Api monitor

func (*Synthetics) SyntheticsUpdateScriptBrowserMonitor 

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

Update a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsUpdateScriptBrowserMonitorWithContext 

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

Update a Synthetic Script Browser Monitor

func (*Synthetics) SyntheticsUpdateSecureCredential 

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 

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 

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

Update a Synthetic Simple Browser monitor

func (*Synthetics) SyntheticsUpdateSimpleBrowserMonitorWithContext 

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

Update a Synthetic Simple Browser monitor

func (*Synthetics) SyntheticsUpdateSimpleMonitor 

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

Update a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsUpdateSimpleMonitorWithContext 

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

Update a Synthetic Simple (Ping) monitor

func (*Synthetics) SyntheticsUpdateStepMonitor 

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

Update a Synthetic Step monitor

func (*Synthetics) SyntheticsUpdateStepMonitorWithContext 

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 

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 

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 

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

Deprecated: Use synthetics.SyntheticsUpdateSecureCredential instead

func (*Synthetics) UpdateSecureCredentialWithContext deprecated 

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

Deprecated: Use synthetics.SyntheticsUpdateSecureCredentialWithContext instead

type SyntheticsAccountStitchedFields 

type SyntheticsAccountStitchedFields struct {
	// Query that fetches results for an automated test
	AutomatedTestResult SyntheticsAutomatedTestResult `json:"automatedTestResult,omitempty"`
	// 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 SyntheticsAutomatedTestConfig added in v2.21.0 

type SyntheticsAutomatedTestConfig struct {
	// An identifier for the automated test run
	BatchName string `json:"batchName,omitempty"`
	// Branch metadata to indicate what triggered the automated test
	Branch string `json:"branch,omitempty"`
	// Commit metadata to indicate what commit triggered the automated test
	Commit string `json:"commit,omitempty"`
	// Metadata for the automated test
	DeepLink string `json:"deepLink,omitempty"`
	// Metadata about the platform target the automated test will run against
	Platform string `json:"platform,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	Repository string `json:"repository,omitempty"`
}

SyntheticsAutomatedTestConfig - Global automated test config

type SyntheticsAutomatedTestConfigInput added in v2.21.0 

type SyntheticsAutomatedTestConfigInput struct {
	// An identifier for the automated test run
	BatchName string `json:"batchName,omitempty" yaml:"batchName,omitempty"`
	// Branch metadata to indicate what triggered the automated test
	Branch string `json:"branch,omitempty" yaml:"branch,omitempty"`
	// Commit metadata to indicate what commit triggered the automated test
	Commit string `json:"commit,omitempty" yaml:"commit,omitempty"`
	// Metadata for the automated test
	DeepLink string `json:"deepLink,omitempty" yaml:"deepLink,omitempty"`
	// Metadata about the platform target the automated test will run against
	Platform string `json:"platform,omitempty" yaml:"platform,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	Repository string `json:"repository,omitempty" yaml:"repository,omitempty"`
}

SyntheticsAutomatedTestConfigInput - Global automated test config

type SyntheticsAutomatedTestJobResult added in v2.21.0 

type SyntheticsAutomatedTestJobResult struct {
	// Test overrides
	AutomatedTestMonitorConfig SyntheticsAutomatedTestMonitorConfig `json:"automatedTestMonitorConfig,omitempty"`
	// Job batch Id
	BatchId string `json:"batchId,omitempty"`
	// Job duration
	Duration int `json:"duration,omitempty"`
	// Job error if any
	Error string `json:"error,omitempty"`
	// Job Id
	ID string `json:"id,omitempty"`
	// Job location
	Location string `json:"location,omitempty"`
	// Job location label
	LocationLabel string `json:"locationLabel,omitempty"`
	// Monitor nr1 entity guid
	MonitorGUID EntityGUID `json:"monitorGuid,omitempty"`
	// Job monitor Id
	MonitorId string `json:"monitorId,omitempty"`
	// Job monitor name
	MonitorName string `json:"monitorName,omitempty"`
	// Job result
	Result SyntheticsJobStatus `json:"result,omitempty"`
	// Link to job results
	ResultsURL string `json:"resultsUrl,omitempty"`
	// Job type
	Type SyntheticsMonitorType `json:"type,omitempty"`
	// Job type label
	TypeLabel string `json:"typeLabel,omitempty"`
}

SyntheticsAutomatedTestJobResult - Information on a job that was apart of a batch of automated test jobs

type SyntheticsAutomatedTestMonitorConfig added in v2.21.0 

type SyntheticsAutomatedTestMonitorConfig struct {
	// Specifies whether a failure of this monitor should fail the entire automated test
	IsBlocking bool `json:"isBlocking"`
	// Specific overrides for the given monitor
	Overrides *SyntheticsAutomatedTestOverrides `json:"overrides"`
}

SyntheticsAutomatedTestMonitorConfig - Monitor specific test config

type SyntheticsAutomatedTestMonitorConfigInput added in v2.21.0 

type SyntheticsAutomatedTestMonitorConfigInput struct {
	// Specifies whether a failure of this monitor should fail the entire automated test
	IsBlocking bool `json:"isBlocking" yaml:"isBlocking"`
	// Specific overrides for the given monitor
	Overrides *SyntheticsAutomatedTestOverridesInput `json:"overrides" yaml:"overrides"`
}

SyntheticsAutomatedTestMonitorConfigInput - Monitor specific test configuration

type SyntheticsAutomatedTestMonitorInput added in v2.21.0 

type SyntheticsAutomatedTestMonitorInput struct {
	// The monitor config for an automated test
	Config SyntheticsAutomatedTestMonitorConfigInput `json:"config,omitempty" yaml:"config,omitempty"`
	// The unique client identifier for the Synthetics Monitor in New Relic
	MonitorGUID EntityGUID `json:"monitorGuid" yaml:"monitorGuid"`
}

SyntheticsAutomatedTestMonitorInput - Monitor test definition to be included in the automated test

type SyntheticsAutomatedTestOverrides added in v2.21.0 

type SyntheticsAutomatedTestOverrides struct {
	// Override a domain throughout a scripted monitor
	Domain []SyntheticsScriptDomainOverride `json:"domain,omitempty"`
	// Override monitor to use a specific location
	Location string `json:"location,omitempty"`
	// Override a script secure credential with another credential value
	SecureCredential []SyntheticsSecureCredentialOverride `json:"secureCredential,omitempty"`
	// Override a browser monitor starting url
	StartingURL string `json:"startingUrl,omitempty"`
}

SyntheticsAutomatedTestOverrides - Automated test monitor overrides

type SyntheticsAutomatedTestOverridesInput added in v2.21.0 

type SyntheticsAutomatedTestOverridesInput struct {
	// Override a domain throughout a scripted monitor
	Domain []SyntheticsScriptDomainOverrideInput `json:"domain,omitempty" yaml:"domain,omitempty"`
	// Override monitor to use a specific location
	Location string `json:"location,omitempty" yaml:"location,omitempty"`
	// Override a script secure credential with another credential value
	SecureCredential []SyntheticsSecureCredentialOverrideInput `json:"secureCredential,omitempty" yaml:"secureCredential,omitempty"`
	// Override a browser monitor starting url
	StartingURL string `json:"startingUrl,omitempty" yaml:"startingUrl,omitempty"`
}

SyntheticsAutomatedTestOverridesInput - Automated test monitor overrides

type SyntheticsAutomatedTestResult added in v2.21.0 

type SyntheticsAutomatedTestResult struct {
	// Automated test config
	Config SyntheticsAutomatedTestConfig `json:"config,omitempty"`
	// Finished time of the automated test batch
	FinishTimestamp *nrtime.EpochMilliseconds `json:"finishTimestamp,omitempty"`
	// Start time of the automated test batch
	StartTimestamp *nrtime.EpochMilliseconds `json:"startTimestamp,omitempty"`
	// Calculated status of automated test as a whole
	Status SyntheticsAutomatedTestStatus `json:"status,omitempty"`
	// List of completed automated test jobs
	Tests []SyntheticsAutomatedTestJobResult `json:"tests,omitempty"`
}

SyntheticsAutomatedTestResult - Results from fetching automated test job

type SyntheticsAutomatedTestStartResult added in v2.21.0 

type SyntheticsAutomatedTestStartResult struct {
	// Job batch Id
	BatchId string `json:"batchId,omitempty"`
}

SyntheticsAutomatedTestStartResult - Results from starting automated test job

type SyntheticsAutomatedTestStatus added in v2.21.0 

type SyntheticsAutomatedTestStatus string

SyntheticsAutomatedTestStatus - Enum of automated test status

type SyntheticsBrokenLinksMonitor 

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 runtime that the monitor will use to run jobs
	Runtime SyntheticsExtendedTypeMonitorRuntime `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"`
}

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

type SyntheticsBrokenLinksMonitorCreateMutationResult 

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 

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 

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 runtime that the monitor will use to run jobs
	Runtime SyntheticsExtendedTypeMonitorRuntime `json:"runtime,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 

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 

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 

type SyntheticsCreateBrokenLinksMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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. The only accepted values are runtimeType: NODE_API & runtimeTypeVersion: 16.10
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `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"`
}

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

type SyntheticsCreateBrokenLinksMonitorQueryResponse 

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

type SyntheticsCreateCertCheckMonitorInput 

type SyntheticsCreateCertCheckMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,omitempty"`
	// 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 runtime that the monitor will use to run jobs. The only accepted values are runtimeType: NODE_API & runtimeTypeVersion: 16.10
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `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"`
}

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

type SyntheticsCreateCertCheckMonitorQueryResponse 

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

type SyntheticsCreateDailyMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsCreateDailyMonitorDowntimeQueryResponse struct {
	SyntheticsDailyMonitorDowntimeMutationResult SyntheticsDailyMonitorDowntimeMutationResult `json:"SyntheticsCreateDailyMonitorDowntime"`
}

type SyntheticsCreateMonthlyMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsCreateMonthlyMonitorDowntimeQueryResponse struct {
	SyntheticsMonthlyMonitorDowntimeMutationResult SyntheticsMonthlyMonitorDowntimeMutationResult `json:"SyntheticsCreateMonthlyMonitorDowntime"`
}

type SyntheticsCreateOnceMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsCreateOnceMonitorDowntimeQueryResponse struct {
	SyntheticsOnceMonitorDowntimeMutationResult SyntheticsOnceMonitorDowntimeMutationResult `json:"SyntheticsCreateOnceMonitorDowntime"`
}

type SyntheticsCreatePrivateLocationQueryResponse 

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

type SyntheticsCreateScriptAPIMonitorInput 

type SyntheticsCreateScriptAPIMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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"`
}

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

type SyntheticsCreateScriptAPIMonitorQueryResponse 

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

type SyntheticsCreateScriptBrowserMonitorInput 

type SyntheticsCreateScriptBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsScriptBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsCreateSecureCredentialQueryResponse 

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

type SyntheticsCreateSimpleBrowserMonitorInput 

type SyntheticsCreateSimpleBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsCreateSimpleMonitorInput 

type SyntheticsCreateSimpleMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsCreateStepMonitorInput 

type SyntheticsCreateStepMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsStepMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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. The only accepted values are runtimeType: CHROME_BROWSER & runtimeTypeVersion: 100
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `json:"runtime,omitempty"`
	// 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 

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

type SyntheticsCreateWeeklyMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsCreateWeeklyMonitorDowntimeQueryResponse struct {
	SyntheticsWeeklyMonitorDowntimeMutationResult SyntheticsWeeklyMonitorDowntimeMutationResult `json:"SyntheticsCreateWeeklyMonitorDowntime"`
}

type SyntheticsCustomHeader 

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

SyntheticsCustomHeader - Custom header for monitor jobs

type SyntheticsCustomHeaderInput 

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

SyntheticsCustomHeaderInput - Custom header input for monitor jobs

type SyntheticsDailyMonitorDowntimeMutationResult added in v2.23.0 

type SyntheticsDailyMonitorDowntimeMutationResult struct {
	// The account ID associated with the monitor downtime
	AccountID int `json:"accountId,omitempty"`
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndOutput `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// The entity GUID associated with the monitor downtime
	GUID EntityGUID `json:"guid,omitempty"`
	// The monitor GUIDs associated with the monitor downtime
	MonitorGUIDs []EntityGUID `json:"monitorGuids,omitempty"`
	// The name of the monitor downtime
	Name string `json:"name,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsDailyMonitorDowntimeMutationResult - Monitor downtime object returned to the customer for a downtime run daily

type SyntheticsDateWindowEndConfig added in v2.23.0 

type SyntheticsDateWindowEndConfig struct {
	// End the monitor downtime on a particular date
	OnDate Date `json:"onDate,omitempty"`
	// End the monitor downtime after a set number of occurrences
	OnRepeat int `json:"onRepeat,omitempty"`
}

SyntheticsDateWindowEndConfig - Configuration options for when a monitor downtime should end

type SyntheticsDateWindowEndOutput added in v2.23.0 

type SyntheticsDateWindowEndOutput struct {
	// End the monitor downtime on a particular date
	OnDate Date `json:"onDate,omitempty"`
	// End the monitor downtime after a set number of occurrences
	OnRepeat int `json:"onRepeat,omitempty"`
}

SyntheticsDateWindowEndOutput - Configuration options for when a monitor downtime should end

type SyntheticsDaysOfWeek added in v2.23.0 

type SyntheticsDaysOfWeek struct {
	// Which occurrence of the day selected within the month
	OrdinalDayOfMonth SyntheticsMonitorDowntimeDayOfMonthOrdinal `json:"ordinalDayOfMonth"`
	// Which day of the week the monitor downtime runs
	WeekDay SyntheticsMonitorDowntimeWeekDays `json:"weekDay"`
}

SyntheticsDaysOfWeek - Configuration options for a monthly monitor downtime that runs on days of the week

type SyntheticsDaysOfWeekOutput added in v2.23.0 

type SyntheticsDaysOfWeekOutput struct {
	// Which occurrence of the day selected within the month
	OrdinalDayOfMonth SyntheticsMonitorDowntimeDayOfMonthOrdinal `json:"ordinalDayOfMonth,omitempty"`
	// Which day of the week the monitor downtime runs
	WeekDay SyntheticsMonitorDowntimeWeekDays `json:"weekDay,omitempty"`
}

SyntheticsDaysOfWeekOutput - Configuration options for a monthly monitor downtime that runs on days of the week

type SyntheticsDeleteMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsDeleteMonitorDowntimeQueryResponse struct {
	SyntheticsMonitorDowntimeDeleteResult SyntheticsMonitorDowntimeDeleteResult `json:"SyntheticsDeleteMonitorDowntime"`
}

type SyntheticsDeleteMonitorQueryResponse 

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

type SyntheticsDeletePrivateLocationQueryResponse 

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

type SyntheticsDeleteSecureCredentialQueryResponse 

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

type SyntheticsDeviceEmulation added in v2.18.0 

type SyntheticsDeviceEmulation struct {
	// The device orientation the user would like to represent
	DeviceOrientation SyntheticsDeviceOrientation `json:"deviceOrientation"`
	// The device type that a user can select
	DeviceType SyntheticsDeviceType `json:"deviceType"`
}

SyntheticsDeviceEmulation - Information related to device emulation

type SyntheticsDeviceEmulationInput added in v2.18.0 

type SyntheticsDeviceEmulationInput struct {
	// The device orientation the user would like to represent
	DeviceOrientation SyntheticsDeviceOrientation `json:"deviceOrientation"`
	// The device type that a user can select
	DeviceType SyntheticsDeviceType `json:"deviceType"`
}

SyntheticsDeviceEmulationInput - Information related to device browser emulation

type SyntheticsDeviceOrientation added in v2.18.0 

type SyntheticsDeviceOrientation string

SyntheticsDeviceOrientation - enum of Orientations that the user can select for their emulated device

type SyntheticsDeviceType added in v2.18.0 

type SyntheticsDeviceType string

SyntheticsDeviceType - enum of DeviceTypes that the user can use for device emulation

type SyntheticsEditMonitorDowntimeQueryResponse added in v2.23.0 

type SyntheticsEditMonitorDowntimeQueryResponse struct {
	SyntheticsMonitorDowntimeMutationResult SyntheticsMonitorDowntimeMutationResult `json:"SyntheticsEditMonitorDowntime"`
}

type SyntheticsError 

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

SyntheticsError - Error object for Synthetics mutations

type SyntheticsExtendedTypeMonitorRuntime added in v2.27.0 

type SyntheticsExtendedTypeMonitorRuntime 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,omitempty"`
}

SyntheticsExtendedTypeMonitorRuntime - The runtime that a step monitor runs

type SyntheticsExtendedTypeMonitorRuntimeInput added in v2.27.0 

type SyntheticsExtendedTypeMonitorRuntimeInput 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"`
}

SyntheticsExtendedTypeMonitorRuntimeInput - Input to determine which runtime the step monitor will run

type SyntheticsJobStatus added in v2.21.0 

type SyntheticsJobStatus string

SyntheticsJobStatus - Enum of job status

type SyntheticsLocations 

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. For formatting tips, see [this link](https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#location-field)
	Public []string `json:"public,omitempty"`
}

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

type SyntheticsLocationsInput 

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. For formatting tips, see [this link](https://docs.newrelic.com/docs/apis/nerdgraph/examples/nerdgraph-synthetics-tutorial/#location-field)
	Public []string `json:"public,omitempty"`
}

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

type SyntheticsMonitorCreateError 

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 

type SyntheticsMonitorCreateErrorType string

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

type SyntheticsMonitorDeleteMutationResult 

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

SyntheticsMonitorDeleteMutationResult - The result of a monitor delete mutation

type SyntheticsMonitorDowntimeDailyConfig added in v2.23.0 

type SyntheticsMonitorDowntimeDailyConfig struct {
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndConfig `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonitorDowntimeDailyConfig - Configuration options for a monitor downtime that runs daily

type SyntheticsMonitorDowntimeDayOfMonthOrdinal added in v2.23.0 

type SyntheticsMonitorDowntimeDayOfMonthOrdinal string

SyntheticsMonitorDowntimeDayOfMonthOrdinal - enum of which day in the month a customer can have a monitor downtime run

type SyntheticsMonitorDowntimeDeleteResult added in v2.23.0 

type SyntheticsMonitorDowntimeDeleteResult struct {
	// The entity guid of the deleted MonitorDowntime
	GUID EntityGUID `json:"guid,omitempty"`
}

SyntheticsMonitorDowntimeDeleteResult - Monitor downtime object returned to the customer once a monitor downtime is deleted

type SyntheticsMonitorDowntimeMonthlyConfig added in v2.23.0 

type SyntheticsMonitorDowntimeMonthlyConfig struct {
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndConfig `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// Configuration options for which days of the month a monitor downtime will occur
	Frequency SyntheticsMonitorDowntimeMonthlyFrequency `json:"frequency,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonitorDowntimeMonthlyConfig - Configuration options for a monitor downtime that runs monthly

type SyntheticsMonitorDowntimeMonthlyFrequency added in v2.23.0 

type SyntheticsMonitorDowntimeMonthlyFrequency struct {
	// Which dates a monitor downtime is run (only 1 of these can be selected)
	DaysOfMonth []int `json:"daysOfMonth,omitempty"`
	// Which weekdays in the month the monitor downtime will run (only 1 of these can be selected)
	DaysOfWeek *SyntheticsDaysOfWeek `json:"daysOfWeek,omitempty"`
}

SyntheticsMonitorDowntimeMonthlyFrequency - Configuration options for when a monthly monitor downtime should run

type SyntheticsMonitorDowntimeMonthlyFrequencyOutput added in v2.23.0 

type SyntheticsMonitorDowntimeMonthlyFrequencyOutput struct {
	// Which dates a monitor downtime is run
	//  (only 1 of these can be selected)
	DaysOfMonth []int `json:"daysOfMonth,omitempty"`
	// Which weekdays in the month the monitor downtime will run
	//  (only 1 of these can be selected)
	DaysOfWeek SyntheticsDaysOfWeekOutput `json:"daysOfWeek,omitempty"`
}

SyntheticsMonitorDowntimeMonthlyFrequencyOutput - Configuration options for when a monthly monitor downtime should run

type SyntheticsMonitorDowntimeMutationResult added in v2.23.0 

type SyntheticsMonitorDowntimeMutationResult struct {
	// The account ID associated with the monitor downtime
	AccountID int `json:"accountId,omitempty"`
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndOutput `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// Configuration options for which days of the month a monitor downtime will occur
	Frequency SyntheticsMonitorDowntimeMonthlyFrequencyOutput `json:"frequency,omitempty"`
	// The entity GUID associated with the monitor downtime
	GUID EntityGUID `json:"guid,omitempty"`
	// Days of the week the monitor downtime will run
	MaintenanceDays []SyntheticsMonitorDowntimeWeekDays `json:"maintenanceDays,omitempty"`
	// The monitor GUIDs associated with the monitor downtime
	MonitorGUIDs []EntityGUID `json:"monitorGuids,omitempty"`
	// The name of the monitor downtime
	Name string `json:"name,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonitorDowntimeMutationResult - Monitor downtime object returned to the customer for an edit mutation

type SyntheticsMonitorDowntimeOnceConfig added in v2.23.0 

type SyntheticsMonitorDowntimeOnceConfig struct {
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonitorDowntimeOnceConfig - Configuration options for a monitor downtime that runs once

type SyntheticsMonitorDowntimeWeekDays added in v2.23.0 

type SyntheticsMonitorDowntimeWeekDays string

SyntheticsMonitorDowntimeWeekDays - enum of weekdays customers can select monitor downtimes to run

type SyntheticsMonitorDowntimeWeeklyConfig added in v2.23.0 

type SyntheticsMonitorDowntimeWeeklyConfig struct {
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndConfig `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// Configuration options if the customer wants the monitor to end at a specific date
	MaintenanceDays []SyntheticsMonitorDowntimeWeekDays `json:"maintenanceDays,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonitorDowntimeWeeklyConfig - Configuration options for a monitor downtime that runs weekly

type SyntheticsMonitorPeriod 

type SyntheticsMonitorPeriod string

SyntheticsMonitorPeriod - Enum of monitor period types

type SyntheticsMonitorScriptQueryResponse 

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

SyntheticsMonitorScriptQueryResponse - The script that a monitor runs

type SyntheticsMonitorStatus 

type SyntheticsMonitorStatus string

SyntheticsMonitorStatus - Run state of the monitor

type SyntheticsMonitorType added in v2.21.0 

type SyntheticsMonitorType string

SyntheticsMonitorType - Enum of monitor types

type SyntheticsMonitorUpdateError 

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 

type SyntheticsMonitorUpdateErrorType string

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

type SyntheticsMonthlyMonitorDowntimeMutationResult added in v2.23.0 

type SyntheticsMonthlyMonitorDowntimeMutationResult struct {
	// The account ID associated with the monitor downtime
	AccountID int `json:"accountId,omitempty"`
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndOutput `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// Configuration options for which days of the month a monitor downtime will occur
	Frequency SyntheticsMonitorDowntimeMonthlyFrequencyOutput `json:"frequency,omitempty"`
	// The entity GUID associated with the monitor downtime
	GUID EntityGUID `json:"guid,omitempty"`
	// The monitor GUIDs associated with the monitor downtime
	MonitorGUIDs []EntityGUID `json:"monitorGuids,omitempty"`
	// The name of the monitor downtime
	Name string `json:"name,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsMonthlyMonitorDowntimeMutationResult - Monitor downtime object returned to the customer for a downtime run monthly

type SyntheticsOnceMonitorDowntimeMutationResult added in v2.23.0 

type SyntheticsOnceMonitorDowntimeMutationResult struct {
	// The account ID associated with the monitor downtime
	AccountID int `json:"accountId,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// The entity GUID associated with the monitor downtime
	GUID EntityGUID `json:"guid,omitempty"`
	// The monitor GUIDs associated with the monitor downtime
	MonitorGUIDs []EntityGUID `json:"monitorGuids,omitempty"`
	// The name of the monitor downtime
	Name string `json:"name,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsOnceMonitorDowntimeMutationResult - Monitor downtime object returned to the customer for a downtime run once

type SyntheticsPrivateLocationDeleteResult 

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 

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 

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 

type SyntheticsPrivateLocationMutationErrorType string

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

type SyntheticsPrivateLocationMutationResult 

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 

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 

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

type SyntheticsRuntime 

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 

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 

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 

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 

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 

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 

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

SyntheticsScriptBrowserMonitorAdvancedOptions - The advanced options available for a Script Browser monitor

type SyntheticsScriptBrowserMonitorAdvancedOptionsInput 

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

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

type SyntheticsScriptBrowserMonitorCreateMutationResult 

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 

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 SyntheticsScriptDomainOverride added in v2.21.0 

type SyntheticsScriptDomainOverride struct {
	// The target domain to override
	Domain string `json:"domain,omitempty"`
	// The override value for the domain
	Override string `json:"override,omitempty"`
}

SyntheticsScriptDomainOverride - Override a script url domain

type SyntheticsScriptDomainOverrideInput added in v2.21.0 

type SyntheticsScriptDomainOverrideInput struct {
	// The target domain to override
	Domain string `json:"domain,omitempty" yaml:"domain,omitempty"`
	// The override value for the domain
	Override string `json:"override,omitempty" yaml:"override,omitempty"`
}

SyntheticsScriptDomainOverrideInput - Override a script url domain

type SyntheticsScriptedMonitorLocationsInput 

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 

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 SyntheticsSecureCredentialOverride added in v2.21.0 

type SyntheticsSecureCredentialOverride struct {
	// The target secure credential key to override
	Key string `json:"key,omitempty"`
	// The secure credential key override
	OverrideKey string `json:"overrideKey,omitempty"`
}

SyntheticsSecureCredentialOverride - Override a monitor scripts secure credential key with a different key

type SyntheticsSecureCredentialOverrideInput added in v2.21.0 

type SyntheticsSecureCredentialOverrideInput struct {
	// The target secure credential key to override
	Key string `json:"key,omitempty" yaml:"key,omitempty"`
	// The secure credential key override
	OverrideKey string `json:"overrideKey,omitempty" yaml:"overrideKey,omitempty"`
}

SyntheticsSecureCredentialOverrideInput - Override a monitor scripts secure credential key with a different key

type SyntheticsSimpleBrowserMonitor 

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 

type SyntheticsSimpleBrowserMonitorAdvancedOptions struct {
	// Custom headers to use in monitor job
	CustomHeaders []SyntheticsCustomHeader `json:"customHeaders,omitempty"`
	// Emulate a device
	DeviceEmulation SyntheticsDeviceEmulation `json:"deviceEmulation,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 

type SyntheticsSimpleBrowserMonitorAdvancedOptionsInput struct {
	// Custom headers to use in monitor job
	CustomHeaders *[]SyntheticsCustomHeaderInput `json:"customHeaders,omitempty"`
	// Emulate a device
	DeviceEmulation *SyntheticsDeviceEmulationInput `json:"deviceEmulation,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 

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 

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 

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 

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 

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 

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 SyntheticsStartAutomatedTestQueryResponse added in v2.21.0 

type SyntheticsStartAutomatedTestQueryResponse struct {
	SyntheticsAutomatedTestStartResult SyntheticsAutomatedTestStartResult `json:"SyntheticsStartAutomatedTest"`
}

type SyntheticsStep 

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 

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 

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 runtime that the monitor will use to run jobs
	Runtime SyntheticsExtendedTypeMonitorRuntime `json:"runtime,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 

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 

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 

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 

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 

type SyntheticsStepType string

SyntheticsStepType - enum of of script step types

type SyntheticsTag 

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 

type SyntheticsUpdateBrokenLinksMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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. The only accepted values are runtimeType: NODE_API & runtimeTypeVersion: 16.10
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `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"`
}

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

type SyntheticsUpdateBrokenLinksMonitorQueryResponse 

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

type SyntheticsUpdateCertCheckMonitorInput 

type SyntheticsUpdateCertCheckMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,omitempty"`
	// 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 runtime that the monitor will use to run jobs. The only accepted values are runtimeType: NODE_API & runtimeTypeVersion: 16.10
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `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"`
}

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

type SyntheticsUpdateCertCheckMonitorQueryResponse 

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

type SyntheticsUpdatePrivateLocationQueryResponse 

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

type SyntheticsUpdateScriptAPIMonitorInput 

type SyntheticsUpdateScriptAPIMonitorInput struct {
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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"`
}

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

type SyntheticsUpdateScriptAPIMonitorQueryResponse 

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

type SyntheticsUpdateScriptBrowserMonitorInput 

type SyntheticsUpdateScriptBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsScriptBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsUpdateSecureCredentialQueryResponse 

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

type SyntheticsUpdateSimpleBrowserMonitorInput 

type SyntheticsUpdateSimpleBrowserMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleBrowserMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsUpdateSimpleMonitorInput 

type SyntheticsUpdateSimpleMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsSimpleMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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 

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

type SyntheticsUpdateStepMonitorInput 

type SyntheticsUpdateStepMonitorInput struct {
	// The monitor advanced options
	AdvancedOptions SyntheticsStepMonitorAdvancedOptionsInput `json:"advancedOptions,omitempty"`
	// The monitor's Apdex target used to populate SLA reports
	ApdexTarget float64 `json:"apdexTarget,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. The only accepted values are runtimeType: CHROME_BROWSER & runtimeTypeVersion: 100
	Runtime *SyntheticsExtendedTypeMonitorRuntimeInput `json:"runtime,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 

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

type SyntheticsWeeklyMonitorDowntimeMutationResult added in v2.23.0 

type SyntheticsWeeklyMonitorDowntimeMutationResult struct {
	// The account ID associated with the monitor downtime
	AccountID int `json:"accountId,omitempty"`
	// Configuration options if the customer wants the monitor to end at a specific date
	EndRepeat SyntheticsDateWindowEndOutput `json:"endRepeat,omitempty"`
	// The date and time in which the monitor downtime will end
	EndTime NaiveDateTime `json:"endTime,omitempty"`
	// The entity GUID associated with the monitor downtime
	GUID EntityGUID `json:"guid,omitempty"`
	// Days of the week the monitor downtime will run
	MaintenanceDays []SyntheticsMonitorDowntimeWeekDays `json:"maintenanceDays,omitempty"`
	// The monitor GUIDs associated with the monitor downtime
	MonitorGUIDs []EntityGUID `json:"monitorGuids,omitempty"`
	// The name of the monitor downtime
	Name string `json:"name,omitempty"`
	// The date and time in which the monitor downtime will begin
	StartTime NaiveDateTime `json:"startTime,omitempty"`
	// The timezone the time values will be in
	Timezone string `json:"timezone,omitempty"`
}

SyntheticsWeeklyMonitorDowntimeMutationResult - Monitor downtime object returned to the customer for a downtime run weekly

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.