Design Center V1 API - Class Google::Cloud::DesignCenter::V1::ParameterSpec (v0.1.0)

Reference documentation and code samples for the Design Center V1 API class Google::Cloud::DesignCenter::V1::ParameterSpec.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#default_value

def default_value() -> ::Google::Protobuf::Value
Returns

#default_value=

def default_value=(value) -> ::Google::Protobuf::Value
Parameter
  • value (::Google::Protobuf::Value) — Optional. The default value of the parameter, used when the user does not provide one.
Returns

#description

def description() -> ::String
Returns
  • (::String) — Optional. The parameter description.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — Optional. The parameter description.
Returns
  • (::String) — Optional. The parameter description.

#display_name

def display_name() -> ::String
Returns
  • (::String) — Optional. The parameter display name, which is a user friendly name used for UI.

#display_name=

def display_name=(value) -> ::String
Parameter
  • value (::String) — Optional. The parameter display name, which is a user friendly name used for UI.
Returns
  • (::String) — Optional. The parameter display name, which is a user friendly name used for UI.

#key

def key() -> ::String
Returns
  • (::String) — Required. The key of the parameter, matching Parameter.key of the value supplied for it.

#key=

def key=(value) -> ::String
Parameter
  • value (::String) — Required. The key of the parameter, matching Parameter.key of the value supplied for it.
Returns
  • (::String) — Required. The key of the parameter, matching Parameter.key of the value supplied for it.

#required

def required() -> ::Boolean
Returns
  • (::Boolean) — Optional. Whether a value must be provided for the parameter.

#required=

def required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Whether a value must be provided for the parameter.
Returns
  • (::Boolean) — Optional. Whether a value must be provided for the parameter.

#sub_parameter_specs

def sub_parameter_specs() -> ::Array<::Google::Cloud::DesignCenter::V1::ParameterSpec>
Returns

#sub_parameter_specs=

def sub_parameter_specs=(value) -> ::Array<::Google::Cloud::DesignCenter::V1::ParameterSpec>
Parameter
Returns

#value_type

def value_type() -> ::Google::Cloud::DesignCenter::V1::ParameterSpec::ValueType
Returns

#value_type=

def value_type=(value) -> ::Google::Cloud::DesignCenter::V1::ParameterSpec::ValueType
Parameter
Returns