Package com.azure.resourcemanager.automation.models

Class ActivityParameter

java.lang.Object
com.azure.resourcemanager.automation.models.ActivityParameter
All Implemented Interfaces:
com.azure.json.JsonSerializable<ActivityParameter>
public final class ActivityParameter extends Object implements com.azure.json.JsonSerializable<ActivityParameter>
Definition of the activity parameter.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ActivityParameter()
    Creates an instance of ActivityParameter class.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    description()
    Get the description property: Gets or sets the description of the activity parameter.
    static ActivityParameter
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ActivityParameter from the JsonReader.
    Boolean
    isDynamic()
    Get the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
    Boolean
    isMandatory()
    Get the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required.
    String
    name()
    Get the name property: Gets or sets the name of the activity parameter.
    Long
    position()
    Get the position property: Gets or sets the position of the activity parameter.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    String
    type()
    Get the type property: Gets or sets the type of the activity parameter.
    void
    validate()
    Validates the instance.
    List<ActivityParameterValidationSet>
    validationSet()
    Get the validationSet property: Gets or sets the validation set of activity parameter.
    Boolean
    valueFromPipeline()
    Get the valueFromPipeline property: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects.
    Boolean
    valueFromPipelineByPropertyName()
    Get the valueFromPipelineByPropertyName property: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter.
    Boolean
    valueFromRemainingArguments()
    Get the valueFromRemainingArguments property: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.
    ActivityParameter
    withDescription(String description)
    Set the description property: Gets or sets the description of the activity parameter.
    ActivityParameter
    withIsDynamic(Boolean isDynamic)
    Set the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
    ActivityParameter
    withIsMandatory(Boolean isMandatory)
    Set the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required.
    ActivityParameter
    withName(String name)
    Set the name property: Gets or sets the name of the activity parameter.
    ActivityParameter
    withPosition(Long position)
    Set the position property: Gets or sets the position of the activity parameter.
    ActivityParameter
    withType(String type)
    Set the type property: Gets or sets the type of the activity parameter.
    ActivityParameter
    withValidationSet(List<ActivityParameterValidationSet> validationSet)
    Set the validationSet property: Gets or sets the validation set of activity parameter.
    ActivityParameter
    withValueFromPipeline(Boolean valueFromPipeline)
    Set the valueFromPipeline property: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects.
    ActivityParameter
    withValueFromPipelineByPropertyName(Boolean valueFromPipelineByPropertyName)
    Set the valueFromPipelineByPropertyName property: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter.
    ActivityParameter
    withValueFromRemainingArguments(Boolean valueFromRemainingArguments)
    Set the valueFromRemainingArguments property: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ActivityParameter

      public ActivityParameter()
      Creates an instance of ActivityParameter class.

  • Method Details

    • name

      public String name()
      Get the name property: Gets or sets the name of the activity parameter.
      Returns:
      the name value.

    • withName

      public ActivityParameter withName(String name)
      Set the name property: Gets or sets the name of the activity parameter.
      Parameters:
      name - the name value to set.
      Returns:
      the ActivityParameter object itself.

    • type

      public String type()
      Get the type property: Gets or sets the type of the activity parameter.
      Returns:
      the type value.

    • withType

      public ActivityParameter withType(String type)
      Set the type property: Gets or sets the type of the activity parameter.
      Parameters:
      type - the type value to set.
      Returns:
      the ActivityParameter object itself.

    • isMandatory

      public Boolean isMandatory()
      Get the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
      Returns:
      the isMandatory value.

    • withIsMandatory

      public ActivityParameter withIsMandatory(Boolean isMandatory)
      Set the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.
      Parameters:
      isMandatory - the isMandatory value to set.
      Returns:
      the ActivityParameter object itself.

    • isDynamic

      public Boolean isDynamic()
      Get the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
      Returns:
      the isDynamic value.

    • withIsDynamic

      public ActivityParameter withIsDynamic(Boolean isDynamic)
      Set the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.
      Parameters:
      isDynamic - the isDynamic value to set.
      Returns:
      the ActivityParameter object itself.

    • position

      public Long position()
      Get the position property: Gets or sets the position of the activity parameter.
      Returns:
      the position value.

    • withPosition

      public ActivityParameter withPosition(Long position)
      Set the position property: Gets or sets the position of the activity parameter.
      Parameters:
      position - the position value to set.
      Returns:
      the ActivityParameter object itself.

    • valueFromPipeline

      public Boolean valueFromPipeline()
      Get the valueFromPipeline property: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
      Returns:
      the valueFromPipeline value.

    • withValueFromPipeline

      public ActivityParameter withValueFromPipeline(Boolean valueFromPipeline)
      Set the valueFromPipeline property: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects. This setting is used if the cmdlet must access the complete input object. false indicates that the parameter cannot take values from the complete input object.
      Parameters:
      valueFromPipeline - the valueFromPipeline value to set.
      Returns:
      the ActivityParameter object itself.

    • valueFromPipelineByPropertyName

      public Boolean valueFromPipelineByPropertyName()
      Get the valueFromPipelineByPropertyName property: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
      Returns:
      the valueFromPipelineByPropertyName value.

    • withValueFromPipelineByPropertyName

      public ActivityParameter withValueFromPipelineByPropertyName(Boolean valueFromPipelineByPropertyName)
      Set the valueFromPipelineByPropertyName property: Gets or sets a Boolean value that indicates true if the parameter can be filled from a property of the incoming pipeline object that has the same name as this parameter. false indicates that the parameter cannot be filled from the incoming pipeline object property with the same name.
      Parameters:
      valueFromPipelineByPropertyName - the valueFromPipelineByPropertyName value to set.
      Returns:
      the ActivityParameter object itself.

    • valueFromRemainingArguments

      public Boolean valueFromRemainingArguments()
      Get the valueFromRemainingArguments property: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.
      Returns:
      the valueFromRemainingArguments value.

    • withValueFromRemainingArguments

      public ActivityParameter withValueFromRemainingArguments(Boolean valueFromRemainingArguments)
      Set the valueFromRemainingArguments property: Gets or sets a Boolean value that indicates true if the cmdlet parameter accepts all the remaining command-line arguments that are associated with this parameter in the form of an array. false if the cmdlet parameter does not accept all the remaining argument values.
      Parameters:
      valueFromRemainingArguments - the valueFromRemainingArguments value to set.
      Returns:
      the ActivityParameter object itself.

    • description

      public String description()
      Get the description property: Gets or sets the description of the activity parameter.
      Returns:
      the description value.

    • withDescription

      public ActivityParameter withDescription(String description)
      Set the description property: Gets or sets the description of the activity parameter.
      Parameters:
      description - the description value to set.
      Returns:
      the ActivityParameter object itself.

    • validationSet

      public List<ActivityParameterValidationSet> validationSet()
      Get the validationSet property: Gets or sets the validation set of activity parameter.
      Returns:
      the validationSet value.

    • withValidationSet

      public ActivityParameter withValidationSet(List<ActivityParameterValidationSet> validationSet)
      Set the validationSet property: Gets or sets the validation set of activity parameter.
      Parameters:
      validationSet - the validationSet value to set.
      Returns:
      the ActivityParameter 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<ActivityParameter>
      Throws:
      IOException

    • fromJson

      public static ActivityParameter fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ActivityParameter from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ActivityParameter 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 ActivityParameter.