Package com.azure.resourcemanager.avs.models

Class ScriptParameter

java.lang.Object

com.azure.resourcemanager.avs.models.ScriptParameter

public final class ScriptParameter
extends Object

An parameter that the script will accept.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	description()	Get the description property: User friendly description of the parameter.
String	name()	Get the name property: The parameter name that the script will expect a parameter value for.
OptionalParamEnum	optional()	Get the optional property: Is this parameter required or optional.
ScriptParameterTypes	type()	Get the type property: The type of parameter the script is expecting.
void	validate()	Validates the instance.
VisibilityParameterEnum	visibility()	Get the visibility property: Should this parameter be visible to arm and passed in the parameters argument when executing.
ScriptParameter	withName(String name)	Set the name property: The parameter name that the script will expect a parameter value for.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ScriptParameter

public ScriptParameter()

Creates an instance of ScriptParameter class.

Method Details

type

public ScriptParameterTypes type()

Get the type property: The type of parameter the script is expecting. psCredential is a PSCredentialObject.

Returns:

the type value.

name

public String name()

Get the name property: The parameter name that the script will expect a parameter value for.

Returns:

the name value.

withName

public ScriptParameter withName(String name)

Set the name property: The parameter name that the script will expect a parameter value for.

Parameters:

name - the name value to set.

Returns:

the ScriptParameter object itself.

description

public String description()

Get the description property: User friendly description of the parameter.

Returns:

the description value.

visibility

public VisibilityParameterEnum visibility()

Get the visibility property: Should this parameter be visible to arm and passed in the parameters argument when executing.

Returns:

the visibility value.

optional

public OptionalParamEnum optional()

Get the optional property: Is this parameter required or optional.

Returns:

the optional value.

validate

public void validate()

Validates the instance.

Throws:

IllegalArgumentException - thrown if the instance is not valid.