public final class ActivityParameter extends Object
Constructor and Description |
---|
ActivityParameter() |
Modifier and Type | Method and Description |
---|---|
String |
description()
Get the description property: Gets or sets the description of the activity parameter.
|
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.
|
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.
|
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.
|
public String name()
public ActivityParameter withName(String name)
name
- the name value to set.public String type()
public ActivityParameter withType(String type)
type
- the type value to set.public Boolean isMandatory()
public ActivityParameter withIsMandatory(Boolean isMandatory)
isMandatory
- the isMandatory value to set.public Boolean isDynamic()
public ActivityParameter withIsDynamic(Boolean isDynamic)
isDynamic
- the isDynamic value to set.public Long position()
public ActivityParameter withPosition(Long position)
position
- the position value to set.public Boolean valueFromPipeline()
public ActivityParameter withValueFromPipeline(Boolean valueFromPipeline)
valueFromPipeline
- the valueFromPipeline value to set.public Boolean valueFromPipelineByPropertyName()
public ActivityParameter withValueFromPipelineByPropertyName(Boolean valueFromPipelineByPropertyName)
valueFromPipelineByPropertyName
- the valueFromPipelineByPropertyName value to set.public Boolean valueFromRemainingArguments()
public ActivityParameter withValueFromRemainingArguments(Boolean valueFromRemainingArguments)
valueFromRemainingArguments
- the valueFromRemainingArguments value to set.public String description()
public ActivityParameter withDescription(String description)
description
- the description value to set.public List<ActivityParameterValidationSet> validationSet()
public ActivityParameter withValidationSet(List<ActivityParameterValidationSet> validationSet)
validationSet
- the validationSet value to set.public void validate()
IllegalArgumentException
- thrown if the instance is not valid.Copyright © 2021 Microsoft Corporation. All rights reserved.