Share via


GenericGalleryParameter Class

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

Implements

public class GenericGalleryParameter
implements JsonSerializable<GenericGalleryParameter>

The definition of a generic gallery parameter.

Constructor Summary

Constructor Description
GenericGalleryParameter()

Creates an instance of GenericGalleryParameter class.

Method Summary

Modifier and Type Method and Description
String defaultValue()

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

String description()

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

static GenericGalleryParameter fromJson(JsonReader jsonReader)

Reads an instance of GenericGalleryParameter from the JsonReader.

String name()

Get the name property: The name of the parameter.

Boolean required()

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

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

GenericGalleryParameter withDefaultValue(String defaultValue)

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

GenericGalleryParameter withDescription(String description)

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

GenericGalleryParameter withName(String name)

Set the name property: The name of the parameter.

GenericGalleryParameter withRequired(Boolean required)

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

Methods inherited from java.lang.Object

Constructor Details

GenericGalleryParameter

public GenericGalleryParameter()

Creates an instance of GenericGalleryParameter class.

Method Details

defaultValue

public String defaultValue()

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

Returns:

the defaultValue value.

description

public String description()

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

Returns:

the description value.

fromJson

public static GenericGalleryParameter fromJson(JsonReader jsonReader)

Reads an instance of GenericGalleryParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

name

public String name()

Get the name property: The name of the parameter.

Returns:

the name value.

required

public Boolean required()

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

Returns:

the required value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

withDefaultValue

public GenericGalleryParameter withDefaultValue(String defaultValue)

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

Parameters:

defaultValue - the defaultValue value to set.

Returns:

the GenericGalleryParameter object itself.

withDescription

public GenericGalleryParameter withDescription(String description)

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

Parameters:

description - the description value to set.

Returns:

the GenericGalleryParameter object itself.

withName

public GenericGalleryParameter withName(String name)

Set the name property: The name of the parameter.

Parameters:

name - the name value to set.

Returns:

the GenericGalleryParameter object itself.

withRequired

public GenericGalleryParameter withRequired(Boolean required)

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

Parameters:

required - the required value to set.

Returns:

the GenericGalleryParameter object itself.

Applies to