Class: Com::Vmware::Cis::Tagging::Tag::CreateSpec

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::Tag::CreateSpec`` class describes a tag.


 Use the   :func:`Com::Vmware::Cis::Tagging::Tag.create`    method  to create a tag defined by the create specification.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



796
797
798
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 796

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 unique identifier of the parent category in which this tag will be created.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 769

class CreateSpec < 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.create_spec',
                {
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :category_id

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


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 769

class CreateSpec < 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.create_spec',
                {
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :category_id

    # 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. The name must be unique within its category.

Returns:

  • (String)


769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 769

class CreateSpec < 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.create_spec',
                {
                    'name' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                    'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
                },
                CreateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description,
                  :category_id

    # 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



775
776
777
778
779
780
781
782
783
784
785
786
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 775

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.cis.tagging.tag.create_spec',
        {
            'name' => VAPI::Bindings::StringType.instance,
            'description' => VAPI::Bindings::StringType.instance,
            'category_id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.cis.tagging.Category'),
        },
        CreateSpec,
        false,
        nil)
end