Class: Com::Vmware::Appliance::Vmon::Service::Info

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

Overview

The ``Com::Vmware::Appliance::Vmon::Service::Info`` class contains information about a service.

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



300
301
302
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 300

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

Instance Attribute Details

- (String) description_key

Service description key. Can be used to lookup resource bundle

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

    # 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

- (Com::Vmware::Appliance::Vmon::Service::Health) health

Health of service. This field is optional and it is only relevant when the value of ``state`` is :attr:`Com::Vmware::Appliance::Vmon::Service::State.STARTED` .

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

    # 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

- (Array<Com::Vmware::Vapi::Std::LocalizableMessage>) health_messages

Localizable messages associated with the health of the service This field is optional and it is only relevant when the value of ``state`` is :attr:`Com::Vmware::Appliance::Vmon::Service::State.STARTED` .

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

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

Service name key. Can be used to lookup resource bundle

Returns:

  • (String) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

    # 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

- (Com::Vmware::Appliance::Vmon::Service::StartupType) startup_type

Startup Type.

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

    # 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

- (Com::Vmware::Appliance::Vmon::Service::State) state

Running State.

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 267

class Info < 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.vmon.service.info',
                {
                    'name_key' => VAPI::Bindings::StringType.instance,
                    'description_key' => VAPI::Bindings::StringType.instance,
                    'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
                    'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
                    'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
                    'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
                },
                Info,
                false,
                nil)
        end
    end

    attr_accessor :name_key,
                  :description_key,
                  :startup_type,
                  :state,
                  :health,
                  :health_messages

    # 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 



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/vmon.rb', line 273

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.vmon.service.info',
        {
            'name_key' => VAPI::Bindings::StringType.instance,
            'description_key' => VAPI::Bindings::StringType.instance,
            'startup_type' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::StartupType'),
            'state' => VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::State'),
            'health' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Appliance::Vmon::Service::Health')),
            'health_messages' => VAPI::Bindings::OptionalType.new(VAPI::Bindings::ListType.new(VAPI::Bindings::ReferenceType.new('Com::Vmware::Vapi::Std::LocalizableMessage'))),
        },
        Info,
        false,
        nil)
end