Class ParameterDefinition
A parameter to a resource.
Inherited Members
Namespace: Oci.OdaService.Models
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ParameterDefinition
Properties
DefaultValue
Declaration
[JsonProperty(PropertyName = "defaultValue")]
public string DefaultValue { get; set; }
Property Value
Type | Description |
---|---|
string | Default value for the parameter. |
Description
Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type | Description |
---|---|
string | Description of the parameter. |
Direction
Declaration
[JsonProperty(PropertyName = "direction")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ParameterDefinition.DirectionEnum? Direction { get; set; }
Property Value
Type | Description |
---|---|
ParameterDefinition.DirectionEnum? | Is this parameter an input parameter, output parameter, or both? |
IsRequired
Declaration
[JsonProperty(PropertyName = "isRequired")]
public bool? IsRequired { get; set; }
Property Value
Type | Description |
---|---|
bool? | Is this parameter required. Ignored for parameters with direction = OUTPUT. |
IsSensitive
Declaration
[JsonProperty(PropertyName = "isSensitive")]
public bool? IsSensitive { get; set; }
Property Value
Type | Description |
---|---|
bool? | Is the data for this parameter sensitive (e.g. should the data be hidden in UI, encrypted if stored, etc.) |
MaxLength
Declaration
[JsonProperty(PropertyName = "maxLength")]
public int? MaxLength { get; set; }
Property Value
Type | Description |
---|---|
int? | Used for character string types such as STRING to constrain the length of the value |
MinLength
Declaration
[JsonProperty(PropertyName = "minLength")]
public int? MinLength { get; set; }
Property Value
Type | Description |
---|---|
int? | Used for character string types such as STRING to constrain the length of the value |
Name
Declaration
[Required(ErrorMessage = "Name is required.")]
[JsonProperty(PropertyName = "name")]
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the parameter |
Remarks
Required
Pattern
Declaration
[JsonProperty(PropertyName = "pattern")]
public string Pattern { get; set; }
Property Value
Type | Description |
---|---|
string | Regular expression used to validate the value of a string type such as STRING |
ResourceTypeMetadata
Declaration
[JsonProperty(PropertyName = "resourceTypeMetadata")]
public object ResourceTypeMetadata { get; set; }
Property Value
Type | Description |
---|---|
object | Any configuration needed to help the resource type process this parameter (e.g. link to manifest, etc.). |
Type
Declaration
[Required(ErrorMessage = "Type is required.")]
[JsonProperty(PropertyName = "type")]
[JsonConverter(typeof(ResponseEnumConverter))]
public ParameterDefinition.TypeEnum? Type { get; set; }
Property Value
Type | Description |
---|---|
ParameterDefinition.TypeEnum? | Enumerated parameter type. |
Remarks
Required
UiPlacementHint
Declaration
[JsonProperty(PropertyName = "uiPlacementHint")]
public string UiPlacementHint { get; set; }
Property Value
Type | Description |
---|---|
string | A forward-slash-delimited 'path' in an imaginary hierarchy, at which this parameter's UI widgets should be placed |