Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Script

The information about the script.

Properties

Optional content

content: undefined | string

The content of the script. It may contain custom-defined tags that can be used for setting dynamic parameters. The format to set dynamic parameters is: {@code param nameparam valueisParamValueSecret(true/false)}. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : {@code param name} With parameter name and value : {@code param nameparam value} Note that the content is valid if it matches the given content type. For example, if the content type is SIDE, then the content should be in Side script format. If the content type is JS, then the content should be in JavaScript format.

Optional contentFileName

contentFileName: undefined | string

File name of the uploaded script content.

Optional contentSizeInBytes

contentSizeInBytes: undefined | number

Size of the script content. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

contentType

contentType: ContentTypes

Content type of the script.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

displayName

displayName: string

Unique name that can be edited. The name should not contain any confidential information.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

id

id: string

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

monitorStatusCountMap

monitorStatusCountMap: MonitorStatusCountMap

Optional parameters

List of script parameters. Example: {@code [{"scriptParameter": {"paramName": "userid", "paramValue":"testuser", "isSecret": false}, "isOverwritten": false}]}

Optional timeCreated

timeCreated: Date

The time the resource was created, expressed in RFC 3339 timestamp format. Example: {@code 2020-02-12T22:47:12.613Z}

Optional timeUpdated

timeUpdated: Date

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: {@code 2020-02-13T22:47:12.613Z}

Optional timeUploaded

timeUploaded: Date

The time the script was uploaded.

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Script): object

getJsonObj

  • getJsonObj(obj: Script): object