Class List Method List File List

# Class: Com::Vmware::Appliance::Monitoring

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Appliance::Monitoring
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb

## Overview

``Com::Vmware::Appliance::Monitoring`` class provides methods Get and list monitoring data for requested item.

## Defined Under Namespace

Classes: FunctionType, IntervalType, MonitoredItem, MonitoredItemData, MonitoredItemDataRequest

## Instance Method Summary (collapse)

- - (Com::Vmware::Appliance::Monitoring::MonitoredItem) get(stat_id)

  Get monitored item info.

- - (Monitoring) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Appliance::Monitoring::MonitoredItem>) list

  Get monitored items list.

- - (Array<Com::Vmware::Appliance::Monitoring::MonitoredItemData>) query(item)

  Get monitoring data.

## Constructor Details

### - (`Monitoring`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    73
    74
    75
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 73

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Com::Vmware::Appliance::Monitoring::MonitoredItem`) get(stat_id)

Get monitored item info

Parameters:

- stat_id (`String`) —

  statistic item id

Returns:

- (`Com::Vmware::Appliance::Monitoring::MonitoredItem`) —

  MonitoredItem structure

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    112
    113
    114
    115
    116
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 112

    def get(stat_id)
        invoke_with_info(@@get_info, {
            'stat_id' => stat_id,
        })
    end

### - (`Array<Com::Vmware::Appliance::Monitoring::MonitoredItem>`) list

Get monitored items list

Returns:

- (`Array<Com::Vmware::Appliance::Monitoring::MonitoredItem>`) —

  list of names

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    99
    100
    101
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 99

    def list()
        invoke_with_info(@@list_info)
    end

### - (`Array<Com::Vmware::Appliance::Monitoring::MonitoredItemData>`) query(item)

Get monitoring data.

Parameters:

- item (`Com::Vmware::Appliance::Monitoring::MonitoredItemDataRequest`) —

  MonitoredItemDataRequest Structure

Returns:

- (`Array<Com::Vmware::Appliance::Monitoring::MonitoredItemData>`) —

  list of MonitoredItemData structure

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  Generic error

    86
    87
    88
    89
    90
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance.rb', line 86

    def query(item)
        invoke_with_info(@@query_info, {
            'item' => item,
        })
    end