ScriptExecutionInner Class

Package:

com.azure.resourcemanager.avs.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-avs:1.4.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.resourcemanager.avs.fluent.models.ScriptExecutionInner

public final class ScriptExecutionInner
extends ProxyResource

An instance of a script executed by a user - custom or AVS.

Constructor Summary

Constructor	Description
ScriptExecutionInner()	Creates an instance of ScriptExecutionInner class.

Method Summary

Modifier and Type	Method and Description
List<String>	errors() Get the errors property: Standard error output stream from the powershell execution.
String	failureReason() Get the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.
OffsetDateTime	finishedAt() Get the finishedAt property: Time the script execution was finished.
static ScriptExecutionInner	fromJson(JsonReader jsonReader) Reads an instance of ScriptExecutionInner from the JsonReader.
List<ScriptExecutionParameter>	hiddenParameters() Get the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.
String	id() Get the id property: Fully qualified resource Id for the resource.
List<String>	information() Get the information property: Standard information out stream from the powershell execution.
String	name() Get the name property: The name of the resource.
Map<String,Object>	namedOutputs() Get the namedOutputs property: User-defined dictionary.
List<String>	output() Get the output property: Standard output stream from the powershell execution.
List<ScriptExecutionParameter>	parameters() Get the parameters property: Parameters the script will accept.
ScriptExecutionProvisioningState	provisioningState() Get the provisioningState property: The state of the script execution resource.
String	retention() Get the retention property: Time to live for the resource.
String	scriptCmdletId() Get the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.
OffsetDateTime	startedAt() Get the startedAt property: Time the script execution was started.
OffsetDateTime	submittedAt() Get the submittedAt property: Time the script execution was submitted.
SystemData	systemData() Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
String	timeout() Get the timeout property: Time limit for execution.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
void	validate() Validates the instance.
List<String>	warnings() Get the warnings property: Standard warning out stream from the powershell execution.
ScriptExecutionInner	withFailureReason(String failureReason) Set the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.
ScriptExecutionInner	withHiddenParameters(List<ScriptExecutionParameter> hiddenParameters) Set the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.
ScriptExecutionInner	withNamedOutputs(Map<String,Object> namedOutputs) Set the namedOutputs property: User-defined dictionary.
ScriptExecutionInner	withOutput(List<String> output) Set the output property: Standard output stream from the powershell execution.
ScriptExecutionInner	withParameters(List<ScriptExecutionParameter> parameters) Set the parameters property: Parameters the script will accept.
ScriptExecutionInner	withRetention(String retention) Set the retention property: Time to live for the resource.
ScriptExecutionInner	withScriptCmdletId(String scriptCmdletId) Set the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.
ScriptExecutionInner	withTimeout(String timeout) Set the timeout property: Time limit for execution.

Methods inherited from ProxyResource

fromJson id name toJson type

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScriptExecutionInner

public ScriptExecutionInner()

Creates an instance of ScriptExecutionInner class.

Method Details

errors

public List<String> errors()

Get the errors property: Standard error output stream from the powershell execution.

Returns:

the errors value.

failureReason

public String failureReason()

Get the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.

Returns:

the failureReason value.

finishedAt

public OffsetDateTime finishedAt()

Get the finishedAt property: Time the script execution was finished.

Returns:

the finishedAt value.

fromJson

public static ScriptExecutionInner fromJson(JsonReader jsonReader)

Reads an instance of ScriptExecutionInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScriptExecutionInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

hiddenParameters

public List<ScriptExecutionParameter> hiddenParameters()

Get the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.

Returns:

the hiddenParameters value.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

ScriptExecutionInner.id()

Returns:

the id value.

information

public List<String> information()

Get the information property: Standard information out stream from the powershell execution.

Returns:

the information value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

ScriptExecutionInner.name()

Returns:

the name value.

namedOutputs

public Map<String,Object> namedOutputs()

Get the namedOutputs property: User-defined dictionary.

Returns:

the namedOutputs value.

output

public List<String> output()

Get the output property: Standard output stream from the powershell execution.

Returns:

the output value.

parameters

public List<ScriptExecutionParameter> parameters()

Get the parameters property: Parameters the script will accept.

Returns:

the parameters value.

provisioningState

public ScriptExecutionProvisioningState provisioningState()

Get the provisioningState property: The state of the script execution resource.

Returns:

the provisioningState value.

retention

public String retention()

Get the retention property: Time to live for the resource. If not provided, will be available for 60 days.

Returns:

the retention value.

scriptCmdletId

public String scriptCmdletId()

Get the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.

Returns:

the scriptCmdletId value.

startedAt

public OffsetDateTime startedAt()

Get the startedAt property: Time the script execution was started.

Returns:

the startedAt value.

submittedAt

public OffsetDateTime submittedAt()

Get the submittedAt property: Time the script execution was submitted.

Returns:

the submittedAt value.

systemData

public SystemData systemData()

Get the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.

Returns:

the systemData value.

timeout

public String timeout()

Get the timeout property: Time limit for execution.

Returns:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ScriptExecutionInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

ScriptExecutionInner.type()

Returns:

the type value.

validate

public void validate()

Validates the instance.

warnings

public List<String> warnings()

Get the warnings property: Standard warning out stream from the powershell execution.

Returns:

the warnings value.

withFailureReason

public ScriptExecutionInner withFailureReason(String failureReason)

Set the failureReason property: Error message if the script was able to run, but if the script itself had errors or powershell threw an exception.

Parameters:

failureReason - the failureReason value to set.

Returns:

the ScriptExecutionInner object itself.

withHiddenParameters

public ScriptExecutionInner withHiddenParameters(List<ScriptExecutionParameter> hiddenParameters)

Set the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.

Parameters:

hiddenParameters - the hiddenParameters value to set.

Returns:

the ScriptExecutionInner object itself.

withNamedOutputs

public ScriptExecutionInner withNamedOutputs(Map<String,Object> namedOutputs)

Set the namedOutputs property: User-defined dictionary.

Parameters:

namedOutputs - the namedOutputs value to set.

Returns:

the ScriptExecutionInner object itself.

withOutput

public ScriptExecutionInner withOutput(List<String> output)

Set the output property: Standard output stream from the powershell execution.

Parameters:

output - the output value to set.

Returns:

the ScriptExecutionInner object itself.

withParameters

public ScriptExecutionInner withParameters(List<ScriptExecutionParameter> parameters)

Set the parameters property: Parameters the script will accept.

Parameters:

parameters - the parameters value to set.

Returns:

the ScriptExecutionInner object itself.

withRetention

public ScriptExecutionInner withRetention(String retention)

Set the retention property: Time to live for the resource. If not provided, will be available for 60 days.

Parameters:

retention - the retention value to set.

Returns:

the ScriptExecutionInner object itself.

withScriptCmdletId

public ScriptExecutionInner withScriptCmdletId(String scriptCmdletId)

Set the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.

Parameters:

scriptCmdletId - the scriptCmdletId value to set.

Returns:

the ScriptExecutionInner object itself.

withTimeout

public ScriptExecutionInner withTimeout(String timeout)

Set the timeout property: Time limit for execution.

Parameters:

timeout - the timeout value to set.

Returns:

the ScriptExecutionInner object itself.