Class: Azure::Automation::Mgmt::V2015_10_31::Models::ActivityParameter

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb

Overview

Definition of the activity parameter.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#description ⇒ String

parameter.

Returns:

  • (String) —

    Gets or sets the description of the activity



56
57
58
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 56

def description
  @description
end

#is_dynamic ⇒ Boolean

the parameter is dynamic.

Returns:

  • (Boolean) —

    Gets or sets a Boolean value that indicates true if



28
29
30
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 28

def is_dynamic
  @is_dynamic
end

#is_mandatory ⇒ Boolean

the parameter is required. If the value is false, the parameter is optional.

Returns:

  • (Boolean) —

    Gets or sets a Boolean value that indicates true if



24
25
26
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 24

def is_mandatory
  @is_mandatory
end

#name ⇒ String

Returns Gets or sets the name of the activity parameter.

Returns:

  • (String) —

    Gets or sets the name of the activity parameter.



16
17
18
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 16

def name
  @name
end

#position ⇒ Integer

Returns Gets or sets the position of the activity parameter.

Returns:

  • (Integer) —

    Gets or sets the position of the activity parameter.



31
32
33
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 31

def position
  @position
end

#type ⇒ String

Returns Gets or sets the type of the activity parameter.

Returns:

  • (String) —

    Gets or sets the type of the activity parameter.



19
20
21
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 19

def type
  @type
end

#validation_set ⇒ Array<ActivityParameterValidationSet>

validation set of activity parameter.

Returns:



60
61
62
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 60

def validation_set
  @validation_set
end

#value_from_pipeline ⇒ Boolean

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:

  • (Boolean) —

    Gets or sets a Boolean value that indicates true if



38
39
40
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 38

def value_from_pipeline
  @value_from_pipeline
end

#value_from_pipeline_by_property_name ⇒ Boolean

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:

  • (Boolean) —

    Gets or sets a Boolean value that indicates true if



45
46
47
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 45

def value_from_pipeline_by_property_name
  @value_from_pipeline_by_property_name
end

#value_from_remaining_arguments ⇒ Boolean

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:

  • (Boolean) —

    Gets or sets a Boolean value that indicates true if



52
53
54
 
# File 'lib/2015-10-31/generated/azure_mgmt_automation/models/activity_parameter.rb', line 52

def value_from_remaining_arguments
  @value_from_remaining_arguments
end

Class Method Details

.mapper ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# 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