Class: Com::Vmware::Appliance::Monitoring::MonitoredItem

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

Overview

``Com::Vmware::Appliance::Monitoring::MonitoredItem`` class Structure representing requested monitored item data.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



283
284
285
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 283

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

Instance Attribute Details

- (String) category

category Ex: network, storage etc

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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) description

monitored item description Ex: com.vmware.applmgmt.mon.descr.net.rx.packetRate.eth0

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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) id

monitored item ID Ex: CPU, MEMORY

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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) instance

instance name Ex: eth0

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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

monitored item name Ex: “Network write speed“

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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) units

Y-axis label EX: “Mbps”, “%“

Returns:

  • (String) 


250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 250

class MonitoredItem < 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.appliance.monitoring.monitored_item',
                {
                    'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
                    'name' => VAPI::Bindings::StringType.instance,
                    'units' => VAPI::Bindings::StringType.instance,
                    'category' => VAPI::Bindings::StringType.instance,
                    'instance' => VAPI::Bindings::StringType.instance,
                    'description' => VAPI::Bindings::StringType.instance,
                },
                MonitoredItem,
                false,
                nil)
        end
    end

    attr_accessor :id,
                  :name,
                  :units,
                  :category,
                  :instance,
                  :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 



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 256

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.monitoring.monitored_item',
        {
            'id' => VAPI::Bindings::IdType.new(resource_types='com.vmware.appliance.monitoring'),
            'name' => VAPI::Bindings::StringType.instance,
            'units' => VAPI::Bindings::StringType.instance,
            'category' => VAPI::Bindings::StringType.instance,
            'instance' => VAPI::Bindings::StringType.instance,
            'description' => VAPI::Bindings::StringType.instance,
        },
        MonitoredItem,
        false,
        nil)
end