CreateScriptDetails¶

class oci.apm_synthetics.models.CreateScriptDetails(**kwargs)¶

Bases: object

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

Attributes

`CONTENT_TYPE_JS`	A constant which can be used with the content_type property of a CreateScriptDetails.
`CONTENT_TYPE_SIDE`	A constant which can be used with the content_type property of a CreateScriptDetails.
`content`	[Required] Gets the content of this CreateScriptDetails.
`content_file_name`	Gets the content_file_name of this CreateScriptDetails.
`content_type`	[Required] Gets the content_type of this CreateScriptDetails.
`defined_tags`	Gets the defined_tags of this CreateScriptDetails.
`display_name`	[Required] Gets the display_name of this CreateScriptDetails.
`freeform_tags`	Gets the freeform_tags of this CreateScriptDetails.
`parameters`	Gets the parameters of this CreateScriptDetails.

Methods

__init__(**kwargs) Initializes a new CreateScriptDetails object with values from keyword arguments.

CONTENT_TYPE_JS = 'JS'¶: A constant which can be used with the content_type property of a CreateScriptDetails. This constant has a value of “JS”

CONTENT_TYPE_SIDE = 'SIDE'¶: A constant which can be used with the content_type property of a CreateScriptDetails. This constant has a value of “SIDE”

__init__(**kwargs)¶

Initializes a new CreateScriptDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

display_name (str) – The value to assign to the display_name property of this CreateScriptDetails.
content_type (str) – The value to assign to the content_type property of this CreateScriptDetails. Allowed values for this property are: “SIDE”, “JS”
content (str) – The value to assign to the content property of this CreateScriptDetails.
content_file_name (str) – The value to assign to the content_file_name property of this CreateScriptDetails.
parameters (list[oci.apm_synthetics.models.ScriptParameter]) – The value to assign to the parameters property of this CreateScriptDetails.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateScriptDetails.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateScriptDetails.

content¶

[Required] Gets the content of this CreateScriptDetails. 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.

Returns:	The content of this CreateScriptDetails.
Return type:	str

content_file_name¶

Gets the content_file_name of this CreateScriptDetails. File name of uploaded script content.

Returns:	The content_file_name of this CreateScriptDetails.
Return type:	str

content_type¶

[Required] Gets the content_type of this CreateScriptDetails. Content type of script.

Allowed values for this property are: “SIDE”, “JS”

Returns:	The content_type of this CreateScriptDetails.
Return type:	str

defined_tags¶

Gets the defined_tags of this CreateScriptDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this CreateScriptDetails.
Return type:	dict(str, dict(str, object))

display_name¶

[Required] Gets the display_name of this CreateScriptDetails. Unique name that can be edited. The name should not contain any confidential information.

Returns:	The display_name of this CreateScriptDetails.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this CreateScriptDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this CreateScriptDetails.
Return type:	dict(str, str)

parameters¶

Gets the parameters of this CreateScriptDetails. List of script parameters. Example: [{“paramName”: “userid”, “paramValue”:”testuser”, “isSecret”: false}]

Returns:	The parameters of this CreateScriptDetails.
Return type:	list[oci.apm_synthetics.models.ScriptParameter]