GalleryScriptParameter Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.56.0

• java.lang.Object
• • com.azure.resourcemanager.compute.models.GenericGalleryParameter
  • • com.azure.resourcemanager.compute.models.GalleryScriptParameter

public final class GalleryScriptParameter
extends GenericGalleryParameter

The definition of a parameter that can be passed to a script of a Gallery Script Version.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
List<String>	enumValues() Get the enumValues property: A list of permissible values.
static GalleryScriptParameter	fromJson(JsonReader jsonReader) Reads an instance of GalleryScriptParameter from the JsonReader.
String	maxValue() Get the maxValue property: The minimum value of parameter.
String	minValue() Get the minValue property: The minimum value of parameter.
JsonWriter	toJson(JsonWriter jsonWriter)
GalleryScriptParameterType	type() Get the type property: Specifies the type of the Gallery Script parameter.
void	validate() Validates the instance.
GalleryScriptParameter	withDefaultValue(String defaultValue) Set the defaultValue property: The default value of the parameter, only applies to string types.
GalleryScriptParameter	withDescription(String description) Set the description property: A description to help users understand what this parameter means.
GalleryScriptParameter	withEnumValues(List<String> enumValues) Set the enumValues property: A list of permissible values.
GalleryScriptParameter	withMaxValue(String maxValue) Set the maxValue property: The minimum value of parameter.
GalleryScriptParameter	withMinValue(String minValue) Set the minValue property: The minimum value of parameter.
GalleryScriptParameter	withName(String name) Set the name property: The name of the parameter.
GalleryScriptParameter	withRequired(Boolean required) Set the required property: Indicates whether this parameter must be passed.
GalleryScriptParameter	withType(GalleryScriptParameterType type) Set the type property: Specifies the type of the Gallery Script parameter.

Methods inherited from GenericGalleryParameter

defaultValue description fromJson name required toJson validate withDefaultValue withDescription withName withRequired

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GalleryScriptParameter

public GalleryScriptParameter()

Creates an instance of GalleryScriptParameter class.

Method Details

enumValues

public List<String> enumValues()

Get the enumValues property: A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'.

Returns:

the enumValues value.

fromJson

public static GalleryScriptParameter fromJson(JsonReader jsonReader)

Reads an instance of GalleryScriptParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GalleryScriptParameter 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.

maxValue

public String maxValue()

Get the maxValue property: The minimum value of parameter.

Returns:

the maxValue value.

minValue

public String minValue()

Get the minValue property: The minimum value of parameter.

Returns:

the minValue value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

GalleryScriptParameter.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public GalleryScriptParameterType type()

Get the type property: Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum.

Returns:

the type value.

validate

public void validate()

Validates the instance.

Overrides:

GalleryScriptParameter.validate()

withDefaultValue

public GalleryScriptParameter withDefaultValue(String defaultValue)

Set the defaultValue property: The default value of the parameter, only applies to string types.

Overrides:

GalleryScriptParameter.withDefaultValue(String defaultValue)

Parameters:

defaultValue

withDescription

public GalleryScriptParameter withDescription(String description)

Set the description property: A description to help users understand what this parameter means.

Overrides:

GalleryScriptParameter.withDescription(String description)

Parameters:

description

withEnumValues

public GalleryScriptParameter withEnumValues(List<String> enumValues)

Set the enumValues property: A list of permissible values. Only applicable values are from 'enum' values defined in 'GalleryScriptParameter'.

Parameters:

enumValues - the enumValues value to set.

Returns:

the GalleryScriptParameter object itself.

withMaxValue

public GalleryScriptParameter withMaxValue(String maxValue)

Set the maxValue property: The minimum value of parameter.

Parameters:

maxValue - the maxValue value to set.

Returns:

the GalleryScriptParameter object itself.

withMinValue

public GalleryScriptParameter withMinValue(String minValue)

Set the minValue property: The minimum value of parameter.

Parameters:

minValue - the minValue value to set.

Returns:

the GalleryScriptParameter object itself.

withName

public GalleryScriptParameter withName(String name)

Set the name property: The name of the parameter.

Overrides:

GalleryScriptParameter.withName(String name)

Parameters:

name

withRequired

public GalleryScriptParameter withRequired(Boolean required)

Set the required property: Indicates whether this parameter must be passed.

Overrides:

GalleryScriptParameter.withRequired(Boolean required)

Parameters:

required

withType

public GalleryScriptParameter withType(GalleryScriptParameterType type)

Set the type property: Specifies the type of the Gallery Script parameter. Possible values are: String, Int, Double, Boolean, Enum.

Parameters:

type - the type value to set.

Returns:

the GalleryScriptParameter object itself.