Class: Com::Vmware::Cis::Tagging::Tag::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::Tag::UpdateSpec`` class describes the updates to be made to an existing tag. 


 Use the   :func:`Com::Vmware::Cis::Tagging::Tag.update`    method  to modify a tag. When you call the  method , you specify the tag identifier. You obtain the tag identifier when you call the   :func:`Com::Vmware::Cis::Tagging::Tag.create`    method . You can also retrieve an identifier by using the   :func:`Com::Vmware::Cis::Tagging::Tag.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) 



838
839
840
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 838

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

Instance Attribute Details

- (String?) description

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

Returns:

  • (String, nil) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 813

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.tag.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description

    # 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. If nil the name will not be modified.

Returns:

  • (String, nil) 


813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 813

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.tag.update_spec',
                {
                    'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                    'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
                },
                UpdateSpec,
                false,
                nil)
        end
    end

    attr_accessor :name,
                  :description

    # 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 



819
820
821
822
823
824
825
826
827
828
829
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis/tagging.rb', line 819

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.cis.tagging.tag.update_spec',
        {
            'name' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
            'description' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::StringType.instance),
        },
        UpdateSpec,
        false,
        nil)
end