Class: Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb

Overview

The parameter specification for the cloud control.

Defined Under Namespace

Modules: ValueType

Instance Attribute Summary collapse

Instance Attribute Details

#default_value ⇒ ::Google::Cloud::CloudSecurityCompliance::V1::ParamValue

Returns Optional. The default value of the parameter.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#description ⇒ ::String

Returns Optional. The description of the parameter. The maximum length is 2000 characters.

Returns:

  • (::String) —

    Optional. The description of the parameter. The maximum length is 2000 characters.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#display_name ⇒ ::String

Returns Optional. The friendly name of the parameter. The maximum length is 200 characters.

Returns:

  • (::String) —

    Optional. The friendly name of the parameter. The maximum length is 200 characters.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#is_required ⇒ ::Boolean

Returns Required. Whether the parameter is required.

Returns:

  • (::Boolean) —

    Required. Whether the parameter is required.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#name ⇒ ::String

Returns Required. The name of the parameter.

Returns:

  • (::String) —

    Required. The name of the parameter.



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#sub_parameters ⇒ ::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec>

Returns Optional. The parameter specification for oneOf attributes.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#substitution_rules ⇒ ::Array<::Google::Cloud::CloudSecurityCompliance::V1::ParameterSubstitutionRule>

Returns Optional. The list of parameter substitutions.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#validation ⇒ ::Google::Cloud::CloudSecurityCompliance::V1::Validation

Returns Optional. The permitted set of values for the parameter.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end

#value_type ⇒ ::Google::Cloud::CloudSecurityCompliance::V1::ParameterSpec::ValueType

Returns Required. The parameter value type.

Returns:



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'proto_docs/google/cloud/cloudsecuritycompliance/v1/common.rb', line 249

class ParameterSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The type of parameter value.
  module ValueType
    # Default value. This value is unused.
    VALUE_TYPE_UNSPECIFIED = 0

    # A string value.
    STRING = 3

    # A boolean value.
    BOOLEAN = 4

    # A string list value.
    STRINGLIST = 5

    # A numeric value.
    NUMBER = 6

    # A oneOf value.
    ONEOF = 7
  end
end