Class: Com::Vmware::Cis::Tagging::Category::UpdateSpec

Inherits:
VAPI::Bindings::VapiStruct
  • Object
show all
Defined in:
/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb

Overview

The ``Com::Vmware::Cis::Tagging::Category::UpdateSpec`` class describes the updates to be made to an existing category. 


 Use the   :func:`Com::Vmware::Cis::Tagging::Category.update`    method  to modify a category. When you call the  method , specify the category identifier. You obtain the category identifier when you call the   :func:`Com::Vmware::Cis::Tagging::Category.create`    method . You can also retrieve an identifier by using the   :func:`Com::Vmware::Cis::Tagging::Category.list`    method .

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (UpdateSpec) initialize(ruby_values = nil, struct_value = nil)

Constructs a new instance.

Parameters:

  • ruby_values (Hash) (defaults to: nil) —

    a map of initial property values (optional)

  • struct_value (VAPI::Data::StructValue) (defaults to: nil) —

    a raw StructValue from the wire (optional) 



418
419
420
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 418

def initialize(ruby_values=nil, struct_value=nil)
    super(self.class.binding_type, ruby_values, struct_value)
end

Instance Attribute Details

- (Set<String>?) associable_types

Object types to which this category’s tags can be attached. 


 The  set  of associable types cannot be updated incrementally. For example, if   :attr:`Com::Vmware::Cis::Tagging::Category::UpdateSpec.associable_types`   originally contains {A,B,C} and you want to add D, then you need to pass {A,B,C,D} in your update specification. You also cannot remove any item from this  set . For example, if you have {A,B,C}, then you cannot remove say {A} from it. Similarly, if you start with an empty  set , then that implies that you can tag any object and hence you cannot later pass say {A}, because that would be restricting the type of objects you want to tag. Thus, associable types can only grow and not shrink.

If nil the associable types will not be modified.

Returns:

  • (Set<String>, nil) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 389

class UpdateSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.cis.tagging.category.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'cardinality' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Cis::Tagging::CategoryModel::Cardinality')),
                    'associable_types' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance)),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :cardinality,
                  :associable_types

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (Com::Vmware::Cis::Tagging::CategoryModel::Cardinality?) cardinality

The associated cardinality ( ``SINGLE``, ``MULTIPLE`` ) of the category. If nil the cardinality will not be modified.

Returns:



389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 389

class UpdateSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.cis.tagging.category.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'cardinality' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Cis::Tagging::CategoryModel::Cardinality')),
                    'associable_types' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance)),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :cardinality,
                  :associable_types

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String?) description

The description of the category. If nil the description will not be modified.

Returns:

  • (String, nil) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 389

class UpdateSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.cis.tagging.category.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'cardinality' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Cis::Tagging::CategoryModel::Cardinality')),
                    'associable_types' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance)),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :cardinality,
                  :associable_types

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

- (String?) name

The display name of the category. If nil the name will not be modified.

Returns:

  • (String, nil) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 389

class UpdateSpec < VAPI::Bindings::VapiStruct

    class << self
        # Holds (gets or creates) the binding type metadata for this structure type.
        # @scope class
        # @return [VAPI::Bindings::StructType] the binding type
        def binding_type
            @binding_type ||= VAPI::Bindings::StructType.new(
                'com.vmware.cis.tagging.category.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'cardinality' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Cis::Tagging::CategoryModel::Cardinality')),
                    'associable_types' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance)),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :cardinality,
                  :associable_types

    # Constructs a new instance.
    # @param ruby_values [Hash] a map of initial property values (optional)
    # @param struct_value [VAPI::Data::StructValue] a raw StructValue from the wire (optional)
    def initialize(ruby_values=nil, struct_value=nil)
        super(self.class.binding_type, ruby_values, struct_value)
    end
end

Class Method Details

+ (VAPI::Bindings::StructType) binding_type

Holds (gets or creates) the binding type metadata for this structure type.

Returns:

  • (VAPI::Bindings::StructType) —

    the binding type 



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 395

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.cis.tagging.category.update_spec',
        {
            'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'cardinality' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Cis::Tagging::CategoryModel::Cardinality')),
            'associable_types' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance)),
        },
        UpdateSpec,
        false,
        nil)
end