ScriptParameter Class

Package:
com.azure.resourcemanager.avs.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-avs:1.4.0
  • java.lang.Object
    • com.azure.resourcemanager.avs.models.ScriptParameter

Implements

JsonSerializable<ScriptParameter>

public final class ScriptParameter
implements JsonSerializable<ScriptParameter>

An parameter that the script will accept.

Method Summary

Modifier and Type Method and Description
String description()

Get the description property: User friendly description of the parameter.
static ScriptParameter fromJson(JsonReader jsonReader)

Reads an instance of ScriptParameter from the JsonReader.
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.
JsonWriter toJson(JsonWriter jsonWriter)
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.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

description

public String description()

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

Returns:

the description value.

fromJson

public static ScriptParameter fromJson(JsonReader jsonReader)

Reads an instance of ScriptParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the ScriptParameter.

name

public String name()

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

Returns:

the name value.

optional

public OptionalParamEnum optional()

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

Returns:

the optional value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public ScriptParameterTypes type()

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

Returns:

the type value.

validate

public void validate()

Validates the instance.

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.

Applies to