GalleryApplicationCustomActionParameter Class

Package:

com.azure.resourcemanager.compute.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-compute:2.46.0

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

Implements

JsonSerializable<GalleryApplicationCustomActionParameter>

public final class GalleryApplicationCustomActionParameter
implements JsonSerializable<GalleryApplicationCustomActionParameter>

The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	defaultValue() Get the defaultValue property: The default value of the parameter.
String	description() Get the description property: A description to help users understand what this parameter means.
static GalleryApplicationCustomActionParameter	fromJson(JsonReader jsonReader) Reads an instance of GalleryApplicationCustomActionParameter from the JsonReader.
String	name() Get the name property: The name of the custom action.
Boolean	required() Get the required property: Indicates whether this parameter must be passed when running the custom action.
JsonWriter	toJson(JsonWriter jsonWriter)
GalleryApplicationCustomActionParameterType	type() Get the type property: Specifies the type of the custom action parameter.
void	validate() Validates the instance.
GalleryApplicationCustomActionParameter	withDefaultValue(String defaultValue) Set the defaultValue property: The default value of the parameter.
GalleryApplicationCustomActionParameter	withDescription(String description) Set the description property: A description to help users understand what this parameter means.
GalleryApplicationCustomActionParameter	withName(String name) Set the name property: The name of the custom action.
GalleryApplicationCustomActionParameter	withRequired(Boolean required) Set the required property: Indicates whether this parameter must be passed when running the custom action.
GalleryApplicationCustomActionParameter	withType(GalleryApplicationCustomActionParameterType type) Set the type property: Specifies the type of the custom action parameter.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

GalleryApplicationCustomActionParameter

public GalleryApplicationCustomActionParameter()

Creates an instance of GalleryApplicationCustomActionParameter 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 GalleryApplicationCustomActionParameter fromJson(JsonReader jsonReader)

Reads an instance of GalleryApplicationCustomActionParameter from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of GalleryApplicationCustomActionParameter 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 custom action. Must be unique within the Gallery Application Version.

Returns:

the name value.

required

public Boolean required()

Get the required property: Indicates whether this parameter must be passed when running the custom action.

Returns:

the required value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public GalleryApplicationCustomActionParameterType type()

Get the type property: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withDefaultValue

public GalleryApplicationCustomActionParameter 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 GalleryApplicationCustomActionParameter object itself.

withDescription

public GalleryApplicationCustomActionParameter 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 GalleryApplicationCustomActionParameter object itself.

withName

public GalleryApplicationCustomActionParameter withName(String name)

Set the name property: The name of the custom action. Must be unique within the Gallery Application Version.

Parameters:

name - the name value to set.

Returns:

the GalleryApplicationCustomActionParameter object itself.

withRequired

public GalleryApplicationCustomActionParameter withRequired(Boolean required)

Set the required property: Indicates whether this parameter must be passed when running the custom action.

Parameters:

required - the required value to set.

Returns:

the GalleryApplicationCustomActionParameter object itself.

withType

public GalleryApplicationCustomActionParameter withType(GalleryApplicationCustomActionParameterType type)

Set the type property: Specifies the type of the custom action parameter. Possible values are: String, ConfigurationDataBlob or LogOutputBlob.

Parameters:

type - the type value to set.

Returns:

the GalleryApplicationCustomActionParameter object itself.