Design Center v1 API - Class ParameterSpec (1.0.0-beta01) 

public sealed class ParameterSpec : IMessage<ParameterSpec>, IEquatable<ParameterSpec>, IDeepCloneable<ParameterSpec>, IBufferMessage, IMessage

Reference documentation and code samples for the Design Center v1 API class ParameterSpec.

The specification of a parameter that can be configured on a cloud control or a framework.

Inheritance

object > ParameterSpec

Namespace

Google.Cloud.DesignCenter.V1

Assembly

Google.Cloud.DesignCenter.V1.dll

Constructors

ParameterSpec()

public ParameterSpec()

ParameterSpec(ParameterSpec)

public ParameterSpec(ParameterSpec other)
Parameter
Name Description
other ParameterSpec

Properties

DefaultValue

public Value DefaultValue { get; set; }

Optional. The default value of the parameter, used when the user does not provide one.

Property Value
Type Description
Value

Description

public string Description { get; set; }

Optional. The parameter description.

Property Value
Type Description
string

DisplayName

public string DisplayName { get; set; }

Optional. The parameter display name, which is a user friendly name used for UI.

Property Value
Type Description
string

Key

public string Key { get; set; }

Required. The key of the parameter, matching [Parameter.key][google.cloud.designcenter.v1.Parameter.key] of the value supplied for it.

Property Value
Type Description
string

Required

public bool Required { get; set; }

Optional. Whether a value must be provided for the parameter.

Property Value
Type Description
bool

SubParameterSpecs

public RepeatedField<ParameterSpec> SubParameterSpecs { get; }

Optional. The specifications of the sub-parameters. Only set when value_type is ONEOF.

Property Value
Type Description
RepeatedFieldParameterSpec

ValueType

public ParameterSpec.Types.ValueType ValueType { get; set; }

Optional. The type of value that the parameter accepts.

Property Value
Type Description
ParameterSpecTypesValueType