Class ActivityParameter
java.lang.Object
com.azure.resourcemanager.automation.models.ActivityParameter
Definition of the activity parameter.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionGet the description property: Gets or sets the description of the activity parameter.Get the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.Get the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required.name()
Get the name property: Gets or sets the name of the activity parameter.position()
Get the position property: Gets or sets the position of the activity parameter.type()
Get the type property: Gets or sets the type of the activity parameter.void
validate()
Validates the instance.Get the validationSet property: Gets or sets the validation set of activity parameter.Get the valueFromPipeline property: Gets or sets a Boolean value that indicates true if the parameter can take values from the incoming pipeline objects.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.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.withDescription
(String description) Set the description property: Gets or sets the description of the activity parameter.withIsDynamic
(Boolean isDynamic) Set the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.withIsMandatory
(Boolean isMandatory) Set the isMandatory property: Gets or sets a Boolean value that indicates true if the parameter is required.Set the name property: Gets or sets the name of the activity parameter.withPosition
(Long position) Set the position property: Gets or sets the position of the activity parameter.Set the type property: Gets or sets the type of the activity parameter.withValidationSet
(List<ActivityParameterValidationSet> validationSet) Set the validationSet property: Gets or sets the validation set of activity parameter.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.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.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.
-
Constructor Details
-
ActivityParameter
public ActivityParameter()
-
-
Method Details
-
name
Get the name property: Gets or sets the name of the activity parameter.- Returns:
- the name value.
-
withName
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
Get the type property: Gets or sets the type of the activity parameter.- Returns:
- the type value.
-
withType
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
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
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
Get the isDynamic property: Gets or sets a Boolean value that indicates true if the parameter is dynamic.- Returns:
- the isDynamic value.
-
withIsDynamic
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
Get the position property: Gets or sets the position of the activity parameter.- Returns:
- the position value.
-
withPosition
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
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
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
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
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
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
Get the description property: Gets or sets the description of the activity parameter.- Returns:
- the description value.
-
withDescription
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
Get the validationSet property: Gets or sets the validation set of activity parameter.- Returns:
- the validationSet value.
-
withValidationSet
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.
-