Class ScriptExecutionProperties


  • public final class ScriptExecutionProperties
    extends Object
    Properties of a user-invoked script.
    • Constructor Detail

      • ScriptExecutionProperties

        public ScriptExecutionProperties()
    • Method Detail

      • 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.
      • 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.
      • parameters

        public List<ScriptExecutionParameter> parameters()
        Get the parameters property: Parameters the script will accept.
        Returns:
        the parameters value.
      • withParameters

        public ScriptExecutionProperties withParameters​(List<ScriptExecutionParameter> parameters)
        Set the parameters property: Parameters the script will accept.
        Parameters:
        parameters - the parameters value to set.
        Returns:
        the ScriptExecutionProperties object itself.
      • 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.
      • withHiddenParameters

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

        public String timeout()
        Get the timeout property: Time limit for execution.
        Returns:
        the timeout value.
      • 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.
      • 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.
      • 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.
      • submittedAt

        public OffsetDateTime submittedAt()
        Get the submittedAt property: Time the script execution was submitted.
        Returns:
        the submittedAt value.
      • startedAt

        public OffsetDateTime startedAt()
        Get the startedAt property: Time the script execution was started.
        Returns:
        the startedAt value.
      • finishedAt

        public OffsetDateTime finishedAt()
        Get the finishedAt property: Time the script execution was finished.
        Returns:
        the finishedAt value.
      • provisioningState

        public ScriptExecutionProvisioningState provisioningState()
        Get the provisioningState property: The state of the script execution resource.
        Returns:
        the provisioningState value.
      • output

        public List<String> output()
        Get the output property: Standard output stream from the powershell execution.
        Returns:
        the output value.
      • withOutput

        public ScriptExecutionProperties withOutput​(List<String> output)
        Set the output property: Standard output stream from the powershell execution.
        Parameters:
        output - the output value to set.
        Returns:
        the ScriptExecutionProperties object itself.
      • namedOutputs

        public Map<String,​Object> namedOutputs()
        Get the namedOutputs property: User-defined dictionary.
        Returns:
        the namedOutputs value.
      • withNamedOutputs

        public ScriptExecutionProperties withNamedOutputs​(Map<String,​Object> namedOutputs)
        Set the namedOutputs property: User-defined dictionary.
        Parameters:
        namedOutputs - the namedOutputs value to set.
        Returns:
        the ScriptExecutionProperties object itself.
      • information

        public List<String> information()
        Get the information property: Standard information out stream from the powershell execution.
        Returns:
        the information value.
      • warnings

        public List<String> warnings()
        Get the warnings property: Standard warning out stream from the powershell execution.
        Returns:
        the warnings value.
      • errors

        public List<String> errors()
        Get the errors property: Standard error output stream from the powershell execution.
        Returns:
        the errors value.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.