Class: Com::Vmware::Cis::Tagging::TagModel

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::TagModel`` class defines a tag that can be attached to vSphere objects.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (TagModel) 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) 



1490
1491
1492
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1490

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

Instance Attribute Details

- (String) category_id

The identifier of the parent category in which this tag will be created.

Returns:

  • (String) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1459

class TagModel < 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.tag_model',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
                },
                TagModel,
                true,
                ["id"])
        end
    end

    attr_accessor :id,
                  :category_id,
                  :name,
                  :description,
                  :used_by

    # 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 tag.

Returns:

  • (String) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1459

class TagModel < 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.tag_model',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
                },
                TagModel,
                true,
                ["id"])
        end
    end

    attr_accessor :id,
                  :category_id,
                  :name,
                  :description,
                  :used_by

    # 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) id

The unique identifier of the tag.

Returns:

  • (String) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1459

class TagModel < 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.tag_model',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
                },
                TagModel,
                true,
                ["id"])
        end
    end

    attr_accessor :id,
                  :category_id,
                  :name,
                  :description,
                  :used_by

    # 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 tag.

Returns:

  • (String) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1459

class TagModel < 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.tag_model',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
                },
                TagModel,
                true,
                ["id"])
        end
    end

    attr_accessor :id,
                  :category_id,
                  :name,
                  :description,
                  :used_by

    # 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

- (Set<String>) used_by

The set of users that can use this tag. To add users to this, you need to have the edit privilege on the tag. Similarly, to unsubscribe from this tag, you need the edit privilege on the tag. You should not modify other users subscription from this set .

Returns:

  • (Set<String>) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1459

class TagModel < 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.tag_model',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
                },
                TagModel,
                true,
                ["id"])
        end
    end

    attr_accessor :id,
                  :category_id,
                  :name,
                  :description,
                  :used_by

    # 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 



1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 1465

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.cis.tagging.tag_model',
        {
            'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Tag'),
            'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
            'name' => VAPI::Bindings::StringType.instance,
            'description' => VAPI::Bindings::StringType.instance,
            'used_by' => VAPI::Bindings::SetType.new(VAPI::Bindings::StringType.instance),
        },
        TagModel,
        true,
        ["id"])
end