Class List Method List File List

# Class: Com::Vmware::Appliance::Techpreview::Services::Status

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

## Overview

``Com::Vmware::Appliance::Techpreview::Services::Status`` class provides methods Get status of a service.

## Defined Under Namespace

Classes: ServiceStatus

## Instance Method Summary (collapse)

- - (Com::Vmware::Appliance::Techpreview::Services::Status::ServiceStatus) get(name, timeout)

  Get status of a service.

- - (Status) initialize(config) constructor

  Constructs a new instance.

## Constructor Details

### - (`Status`) initialize(config)

Constructs a new instance.

Parameters:

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

  A hash with the api provider details.

    54
    55
    56
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/services.rb', line 54

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

## Instance Method Details

### - (`Com::Vmware::Appliance::Techpreview::Services::Status::ServiceStatus`) get(name, timeout)

Get status of a service.

Parameters:

- name (`String`) —

  Name of a service.

- timeout (`Fixnum`) —

  Timeout in seconds. Zero (0) means no timeout.

Returns:

- (`Com::Vmware::Appliance::Techpreview::Services::Status::ServiceStatus`) —

  Status of the service.

Raises:

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

  Generic error

    69
    70
    71
    72
    73
    74
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview/services.rb', line 69

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