Class: Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownGetConfig

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

Overview

``Com::Vmware::Appliance::Techpreview::Shutdown::ShutdownGetConfig`` class Structure that defines shutdown configuration returned by Shutdown.get operation

Instance Attribute Summary (collapse)

Class Method Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

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



818
819
820
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 818

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

Instance Attribute Details

- (String) action

Contains a string that describes the pending shutdown operation. The string values for pending operations can be ‘poweroff’, ‘reboot’ or ’’

Returns:

  • (String) 


791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 791

class ShutdownGetConfig < 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.techpreview.shutdown.shutdown_get_config',
                {
                    'shutdown_time' => VAPI::Bindings::StringType.instance,
                    'action' => VAPI::Bindings::StringType.instance,
                    'reason' => VAPI::Bindings::StringType.instance,
                },
                ShutdownGetConfig,
                false,
                nil)
        end
    end

    attr_accessor :shutdown_time,
                  :action,
                  :reason

    # 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) reason

This will contain string explaining the reason behind the shutdown action

Returns:

  • (String) 


791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 791

class ShutdownGetConfig < 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.techpreview.shutdown.shutdown_get_config',
                {
                    'shutdown_time' => VAPI::Bindings::StringType.instance,
                    'action' => VAPI::Bindings::StringType.instance,
                    'reason' => VAPI::Bindings::StringType.instance,
                },
                ShutdownGetConfig,
                false,
                nil)
        end
    end

    attr_accessor :shutdown_time,
                  :action,
                  :reason

    # 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) shutdown_time

(UTC) time of shutdown represented in “YYYY-MM-DD HH:MM:SS” format.

Returns:

  • (String) 


791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 791

class ShutdownGetConfig < 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.techpreview.shutdown.shutdown_get_config',
                {
                    'shutdown_time' => VAPI::Bindings::StringType.instance,
                    'action' => VAPI::Bindings::StringType.instance,
                    'reason' => VAPI::Bindings::StringType.instance,
                },
                ShutdownGetConfig,
                false,
                nil)
        end
    end

    attr_accessor :shutdown_time,
                  :action,
                  :reason

    # 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 



797
798
799
800
801
802
803
804
805
806
807
808
 
# File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/appliance/techpreview.rb', line 797

def binding_type
    @binding_type ||= VAPI::Bindings::StructType.new(
        'com.vmware.appliance.techpreview.shutdown.shutdown_get_config',
        {
            'shutdown_time' => VAPI::Bindings::StringType.instance,
            'action' => VAPI::Bindings::StringType.instance,
            'reason' => VAPI::Bindings::StringType.instance,
        },
        ShutdownGetConfig,
        false,
        nil)
end