ParameterDefinitionsValue Class

Package:

com.azure.resourcemanager.resources.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-resources:2.53.5

• java.lang.Object
• • com.azure.resourcemanager.resources.models.ParameterDefinitionsValue

Implements

JsonSerializable<ParameterDefinitionsValue>

public final class ParameterDefinitionsValue
implements JsonSerializable<ParameterDefinitionsValue>

The definition of a parameter that can be provided to the policy.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
List<Object>	allowedValues() Get the allowedValues property: The allowed values for the parameter.
Object	defaultValue() Get the defaultValue property: The default value for the parameter if no value is provided.
static ParameterDefinitionsValue	fromJson(JsonReader jsonReader) Reads an instance of ParameterDefinitionsValue from the JsonReader.
ParameterDefinitionsValueMetadata	metadata() Get the metadata property: General metadata for the parameter.
Object	schema() Get the schema property: Provides validation of parameter inputs during assignment using a self-defined JSON schema.
JsonWriter	toJson(JsonWriter jsonWriter)
ParameterType	type() Get the type property: The data type of the parameter.
void	validate() Validates the instance.
ParameterDefinitionsValue	withAllowedValues(List<Object> allowedValues) Set the allowedValues property: The allowed values for the parameter.
ParameterDefinitionsValue	withDefaultValue(Object defaultValue) Set the defaultValue property: The default value for the parameter if no value is provided.
ParameterDefinitionsValue	withMetadata(ParameterDefinitionsValueMetadata metadata) Set the metadata property: General metadata for the parameter.
ParameterDefinitionsValue	withSchema(Object schema) Set the schema property: Provides validation of parameter inputs during assignment using a self-defined JSON schema.
ParameterDefinitionsValue	withType(ParameterType type) Set the type property: The data type of the parameter.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ParameterDefinitionsValue

public ParameterDefinitionsValue()

Creates an instance of ParameterDefinitionsValue class.

Method Details

allowedValues

public List<Object> allowedValues()

Get the allowedValues property: The allowed values for the parameter.

Returns:

the allowedValues value.

defaultValue

public Object defaultValue()

Get the defaultValue property: The default value for the parameter if no value is provided.

Returns:

the defaultValue value.

fromJson

public static ParameterDefinitionsValue fromJson(JsonReader jsonReader)

Reads an instance of ParameterDefinitionsValue from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

metadata

public ParameterDefinitionsValueMetadata metadata()

Get the metadata property: General metadata for the parameter.

Returns:

the metadata value.

schema

public Object schema()

Get the schema property: Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.

Returns:

the schema value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public ParameterType type()

Get the type property: The data type of the parameter.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAllowedValues

public ParameterDefinitionsValue withAllowedValues(List<Object> allowedValues)

Set the allowedValues property: The allowed values for the parameter.

Parameters:

allowedValues - the allowedValues value to set.

Returns:

the ParameterDefinitionsValue object itself.

withDefaultValue

public ParameterDefinitionsValue withDefaultValue(Object defaultValue)

Set the defaultValue property: The default value for the parameter if no value is provided.

Parameters:

defaultValue - the defaultValue value to set.

Returns:

the ParameterDefinitionsValue object itself.

withMetadata

public ParameterDefinitionsValue withMetadata(ParameterDefinitionsValueMetadata metadata)

Set the metadata property: General metadata for the parameter.

Parameters:

metadata - the metadata value to set.

Returns:

the ParameterDefinitionsValue object itself.

withSchema

public ParameterDefinitionsValue withSchema(Object schema)

Set the schema property: Provides validation of parameter inputs during assignment using a self-defined JSON schema. This property is only supported for object-type parameters and follows the Json.NET Schema 2019-09 implementation. You can learn more about using schemas at https://json-schema.org/ and test draft schemas at https://www.jsonschemavalidator.net/.

Parameters:

schema - the schema value to set.

Returns:

the ParameterDefinitionsValue object itself.

withType

public ParameterDefinitionsValue withType(ParameterType type)

Set the type property: The data type of the parameter.

Parameters:

type - the type value to set.

Returns:

the ParameterDefinitionsValue object itself.