ScriptExecutionProperties Class

Package:

com.azure.resourcemanager.avs.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-avs:1.2.0-beta.1

• java.lang.Object
• • com.azure.resourcemanager.avs.fluent.models.ScriptExecutionProperties

Implements

JsonSerializable<ScriptExecutionProperties>

public final class ScriptExecutionProperties
implements JsonSerializable<ScriptExecutionProperties>

Properties of a user-invoked script.

Constructor Summary

Constructor	Description
ScriptExecutionProperties()	Creates an instance of ScriptExecutionProperties 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 ScriptExecutionProperties	fromJson(JsonReader jsonReader) Reads an instance of ScriptExecutionProperties from the JsonReader.
List<ScriptExecutionParameter>	hiddenParameters() Get the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.
List<String>	information() Get the information property: Standard information out stream from the powershell execution.
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.
String	timeout() Get the timeout property: Time limit for execution.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
List<String>	warnings() Get the warnings property: Standard warning out stream from the powershell execution.
ScriptExecutionProperties	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.
ScriptExecutionProperties	withHiddenParameters(List<ScriptExecutionParameter> hiddenParameters) Set the hiddenParameters property: Parameters that will be hidden/not visible to ARM, such as passwords and credentials.
ScriptExecutionProperties	withNamedOutputs(Map<String,Object> namedOutputs) Set the namedOutputs property: User-defined dictionary.
ScriptExecutionProperties	withOutput(List<String> output) Set the output property: Standard output stream from the powershell execution.
ScriptExecutionProperties	withParameters(List<ScriptExecutionParameter> parameters) Set the parameters property: Parameters the script will accept.
ScriptExecutionProperties	withRetention(String retention) Set the retention property: Time to live for the resource.
ScriptExecutionProperties	withScriptCmdletId(String scriptCmdletId) Set the scriptCmdletId property: A reference to the script cmdlet resource if user is running a AVS script.
ScriptExecutionProperties	withTimeout(String timeout) Set the timeout property: Time limit for execution.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ScriptExecutionProperties

public ScriptExecutionProperties()

Creates an instance of ScriptExecutionProperties class.

Method Details

errors

public List 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 ScriptExecutionProperties fromJson(JsonReader jsonReader)

Reads an instance of ScriptExecutionProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ScriptExecutionProperties 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 hiddenParameters()

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

Returns:

the hiddenParameters value.

information

public List information()

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

Returns:

the information value.

namedOutputs

public Map namedOutputs()

Get the namedOutputs property: User-defined dictionary.

Returns:

the namedOutputs value.

output

public List output()

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

Returns:

the output value.

parameters

public List 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.

timeout

public String timeout()

Get the timeout property: Time limit for execution.

Returns:

the timeout value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

warnings

public List warnings()

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

Returns:

the warnings value.

withFailureReason

public ScriptExecutionProperties 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 ScriptExecutionProperties object itself.

withHiddenParameters

public ScriptExecutionProperties withHiddenParameters(List 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 ScriptExecutionProperties object itself.

withNamedOutputs

public ScriptExecutionProperties withNamedOutputs(Map namedOutputs)

Set the namedOutputs property: User-defined dictionary.

Parameters:

namedOutputs - the namedOutputs value to set.

Returns:

the ScriptExecutionProperties object itself.

withOutput

public ScriptExecutionProperties withOutput(List output)

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

Parameters:

output - the output value to set.

Returns:

the ScriptExecutionProperties object itself.

withParameters

public ScriptExecutionProperties withParameters(List parameters)

Set the parameters property: Parameters the script will accept.

Parameters:

parameters - the parameters value to set.

Returns:

the ScriptExecutionProperties object itself.

withRetention

public ScriptExecutionProperties 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 ScriptExecutionProperties object itself.

withScriptCmdletId

public ScriptExecutionProperties 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 ScriptExecutionProperties object itself.

withTimeout

public ScriptExecutionProperties withTimeout(String timeout)

Set the timeout property: Time limit for execution.

Parameters:

timeout - the timeout value to set.

Returns:

the ScriptExecutionProperties object itself.

Azure SDK for Java

Preview