Class List Method List File List

# Class: Com::Vmware::Vcenter::Cluster::Summary

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Vcenter::Cluster::Summary
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb

## Overview

The ``Com::Vmware::Vcenter::Cluster::Summary`` class contains commonly used information about a cluster in vCenter Server.

## Instance Attribute Summary (collapse)

- - (String) cluster

  Identifier of the cluster.

- - (Boolean) drs_enabled

  Flag indicating whether the vSphere DRS service is enabled for the cluster.

- - (Boolean) ha_enabled

  Flag indicating whether the vSphere HA feature is enabled for the cluster.

- - (String) name

  Name of the cluster.

## Class Method Summary (collapse)

- + (VAPI::Bindings::StructType) binding_type

  Holds (gets or creates) the binding type metadata for this structure type.

## Instance Method Summary (collapse)

- - (Summary) initialize(ruby_values = nil, struct_value = nil) constructor

  Constructs a new instance.

## Constructor Details

### - (`Summary`) 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)

    214
    215
    216
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 214

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

## Instance Attribute Details

### - (`String`) cluster

Identifier of the cluster.

Returns:

- (`String`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 185

    class Summary < 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.vcenter.cluster.summary',
                    {
                        'cluster' => VAPI::Bindings::IdType.new(resource_types='ClusterComputeResource'),
                        'name' => VAPI::Bindings::StringType.instance,
                        'ha_enabled' => VAPI::Bindings::BooleanType.instance,
                        'drs_enabled' => VAPI::Bindings::BooleanType.instance,
                    },
                    Summary,
                    false,
                    nil)
            end
        end

        attr_accessor :cluster,
                      :name,
                      :ha_enabled,
                      :drs_enabled

        # 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

### - (`Boolean`) drs_enabled

Flag indicating whether the vSphere DRS service is enabled for the cluster.

Returns:

- (`Boolean`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 185

    class Summary < 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.vcenter.cluster.summary',
                    {
                        'cluster' => VAPI::Bindings::IdType.new(resource_types='ClusterComputeResource'),
                        'name' => VAPI::Bindings::StringType.instance,
                        'ha_enabled' => VAPI::Bindings::BooleanType.instance,
                        'drs_enabled' => VAPI::Bindings::BooleanType.instance,
                    },
                    Summary,
                    false,
                    nil)
            end
        end

        attr_accessor :cluster,
                      :name,
                      :ha_enabled,
                      :drs_enabled

        # 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

### - (`Boolean`) ha_enabled

Flag indicating whether the vSphere HA feature is enabled for the cluster.

Returns:

- (`Boolean`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 185

    class Summary < 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.vcenter.cluster.summary',
                    {
                        'cluster' => VAPI::Bindings::IdType.new(resource_types='ClusterComputeResource'),
                        'name' => VAPI::Bindings::StringType.instance,
                        'ha_enabled' => VAPI::Bindings::BooleanType.instance,
                        'drs_enabled' => VAPI::Bindings::BooleanType.instance,
                    },
                    Summary,
                    false,
                    nil)
            end
        end

        attr_accessor :cluster,
                      :name,
                      :ha_enabled,
                      :drs_enabled

        # 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

Name of the cluster.

Returns:

- (`String`)

    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 185

    class Summary < 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.vcenter.cluster.summary',
                    {
                        'cluster' => VAPI::Bindings::IdType.new(resource_types='ClusterComputeResource'),
                        'name' => VAPI::Bindings::StringType.instance,
                        'ha_enabled' => VAPI::Bindings::BooleanType.instance,
                        'drs_enabled' => VAPI::Bindings::BooleanType.instance,
                    },
                    Summary,
                    false,
                    nil)
            end
        end

        attr_accessor :cluster,
                      :name,
                      :ha_enabled,
                      :drs_enabled

        # 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

    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter.rb', line 191

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.vcenter.cluster.summary',
            {
                'cluster' => VAPI::Bindings::IdType.new(resource_types='ClusterComputeResource'),
                'name' => VAPI::Bindings::StringType.instance,
                'ha_enabled' => VAPI::Bindings::BooleanType.instance,
                'drs_enabled' => VAPI::Bindings::BooleanType.instance,
            },
            Summary,
            false,
            nil)
    end