Class GalleryApplicationCustomActionParameter

java.lang.Object
com.azure.resourcemanager.compute.models.GalleryApplicationCustomActionParameter
All Implemented Interfaces:
com.azure.json.JsonSerializable<GalleryApplicationCustomActionParameter>
public final class GalleryApplicationCustomActionParameter extends Object implements com.azure.json.JsonSerializable<GalleryApplicationCustomActionParameter>
The definition of a parameter that can be passed to a custom action of a Gallery Application Version.

  • Constructor Details

    • GalleryApplicationCustomActionParameter

      public GalleryApplicationCustomActionParameter()
      Creates an instance of GalleryApplicationCustomActionParameter class.

  • Method Details

    • 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.

    • 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.

    • required

      public Boolean required()
      Get the required property: Indicates whether this parameter must be passed when running the custom action.
      Returns:
      the required value.

    • 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.

    • 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.

    • 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.

    • defaultValue

      public String defaultValue()
      Get the defaultValue property: The default value of the parameter. Only applies to string types.
      Returns:
      the defaultValue value.

    • 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.

    • description

      public String description()
      Get the description property: A description to help users understand what this parameter means.
      Returns:
      the description value.

    • 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<GalleryApplicationCustomActionParameter>
      Throws:
      IOException

    • fromJson

      public static GalleryApplicationCustomActionParameter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the GalleryApplicationCustomActionParameter.