class Azure::Automation::Mgmt::V2015_10_31::Models::ActivityParameter

Definition of the activity parameter.

Attributes

description[RW]

@return [String] Gets or sets the description of the activity parameter.

is_dynamic[RW]

@return [Boolean] Gets or sets a Boolean value that indicates true if the parameter is dynamic.

is_mandatory[RW]

@return [Boolean] Gets or sets a Boolean value that indicates true if the parameter is required. If the value is false, the parameter is optional.

name[RW]

@return [String] Gets or sets the name of the activity parameter.

position[RW]

@return [Integer] Gets or sets the position of the activity parameter.

type[RW]

@return [String] Gets or sets the type of the activity parameter.

validation_set[RW]

@return [Array<ActivityParameterValidationSet>] Gets or sets the validation set of activity parameter.

value_from_pipeline[RW]

@return [Boolean] 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.

value_from_pipeline_by_property_name[RW]

@return [Boolean] 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.

value_from_remaining_arguments[RW]

@return [Boolean] 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.

Private Class Methods

mapper() click to toggle source

Mapper for ActivityParameter class as Ruby Hash. This will be used for serialization/deserialization.

# File lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb, line 67
def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ActivityParameter',
    type: {
      name: 'Composite',
      class_name: 'ActivityParameter',
      model_properties: {
        name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        is_mandatory: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isMandatory',
          type: {
            name: 'Boolean'
          }
        },
        is_dynamic: {
          client_side_validation: true,
          required: false,
          serialized_name: 'isDynamic',
          type: {
            name: 'Boolean'
          }
        },
        position: {
          client_side_validation: true,
          required: false,
          serialized_name: 'position',
          type: {
            name: 'Number'
          }
        },
        value_from_pipeline: {
          client_side_validation: true,
          required: false,
          serialized_name: 'valueFromPipeline',
          type: {
            name: 'Boolean'
          }
        },
        value_from_pipeline_by_property_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'valueFromPipelineByPropertyName',
          type: {
            name: 'Boolean'
          }
        },
        value_from_remaining_arguments: {
          client_side_validation: true,
          required: false,
          serialized_name: 'valueFromRemainingArguments',
          type: {
            name: 'Boolean'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        validation_set: {
          client_side_validation: true,
          required: false,
          serialized_name: 'validationSet',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ActivityParameterValidationSetElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ActivityParameterValidationSet'
                }
            }
          }
        }
      }
    }
  }
end