Class CreateScriptDetails

Details of the request body used to create a new script. Only Side, JavaScript and Playwright TypeScript content types are supported and content should be in Side, JavaScript and TypeScript formats only.

Inheritance

object

CreateScriptDetails

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.ApmsyntheticsService.Models

Assembly: OCI.DotNetSDK.Apmsynthetics.dll

Syntax

public class CreateScriptDetails

Properties

Content

Declaration

[Required(ErrorMessage = "Content is required.")]
[JsonProperty(PropertyName = "content")]
public string Content { get; set; }

Property Value

Type Description

Type	Description
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: `<ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>`. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : `<ORAP><ON>param name</ON></ORAP>` With parameter name and value : `<ORAP><ON>param name</ON><OV>param value</OV></ORAP>` 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. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format.

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: <ORAP><ON>param name</ON><OV>param value</OV><OS>isParamValueSecret(true/false)</OS></ORAP>. Param value and isParamValueSecret are optional, the default value for isParamValueSecret is false. Examples: With mandatory param name : <ORAP><ON>param name</ON></ORAP> With parameter name and value : <ORAP><ON>param name</ON><OV>param value</OV></ORAP> 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. If the content type is PLAYWRIGHT_TS, then the content should be in TypeScript format.

Remarks

Required

ContentFileName

Declaration

[JsonProperty(PropertyName = "contentFileName")]
public string ContentFileName { get; set; }

Property Value

Type	Description
string	File name of uploaded script content.

ContentType

Declaration

[Required(ErrorMessage = "ContentType is required.")]
[JsonProperty(PropertyName = "contentType")]
[JsonConverter(typeof(StringEnumConverter))]
public ContentTypes? ContentType { get; set; }

Property Value

Type	Description
ContentTypes?	Content type of script.

Remarks

Required

DefinedTags

Declaration

[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }

Property Value

Type	Description
Dictionary<string, Dictionary<string, object>>	Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}

DisplayName

Declaration

[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }

Property Value

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

Remarks

Required

FreeformTags

Declaration

[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }

Property Value

Type	Description
Dictionary<string, string>	Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Parameters

Declaration

[JsonProperty(PropertyName = "parameters")]
public List<ScriptParameter> Parameters { get; set; }

Property Value

Type	Description
List<ScriptParameter>	List of script parameters. Example: [{"paramName": "userid", "paramValue":"testuser", "isSecret": false}]