Class List Method List File List

# Class: Com::Vmware::Cis::Session::Info

Inherits:
  VAPI::Bindings::VapiStruct
  - Object
  - VAPI::Bindings::VapiStruct
  - Com::Vmware::Cis::Session::Info
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb

## Overview

Represents data associated with an API session.

## Instance Attribute Summary (collapse)

- - (DateTime) created_time

  Time when the session was created.

- - (DateTime) last_accessed_time

  Last time this session was used by passing the session key for invoking an API.

- - (String) user

  Fully qualified name of the end user that created the session, for example Administrator\@vsphere.local.

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

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

  Constructs a new instance.

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

    216
    217
    218
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb', line 216

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

## Instance Attribute Details

### - (`DateTime`) created_time

Time when the session was created.

Returns:

- (`DateTime`)

    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
    218
    219
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb', line 189

    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.cis.session.info',
                    {
                        'user' => VAPI::Bindings::StringType.instance,
                        'created_time' => VAPI::Bindings::DateTimeType.instance,
                        'last_accessed_time' => VAPI::Bindings::DateTimeType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :user,
                      :created_time,
                      :last_accessed_time

        # 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

### - (`DateTime`) last_accessed_time

Last time this session was used by passing the session key for invoking an API.

Returns:

- (`DateTime`)

    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
    218
    219
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb', line 189

    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.cis.session.info',
                    {
                        'user' => VAPI::Bindings::StringType.instance,
                        'created_time' => VAPI::Bindings::DateTimeType.instance,
                        'last_accessed_time' => VAPI::Bindings::DateTimeType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :user,
                      :created_time,
                      :last_accessed_time

        # 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`) user

Fully qualified name of the end user that created the session, for example Administrator\@vsphere.local. A typical use case for this information is in Graphical User Interfaces (GUI) or logging systems to visualize the identity of the current user.

Returns:

- (`String`)

    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
    218
    219
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb', line 189

    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.cis.session.info',
                    {
                        'user' => VAPI::Bindings::StringType.instance,
                        'created_time' => VAPI::Bindings::DateTimeType.instance,
                        'last_accessed_time' => VAPI::Bindings::DateTimeType.instance,
                    },
                    Info,
                    false,
                    nil)
            end
        end

        attr_accessor :user,
                      :created_time,
                      :last_accessed_time

        # 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

    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/cis.rb', line 195

    def binding_type
        @binding_type ||= VAPI::Bindings::StructType.new(
            'com.vmware.cis.session.info',
            {
                'user' => VAPI::Bindings::StringType.instance,
                'created_time' => VAPI::Bindings::DateTimeType.instance,
                'last_accessed_time' => VAPI::Bindings::DateTimeType.instance,
            },
            Info,
            false,
            nil)
    end