module OneviewSDK

Module for interacting with the HPE OneView API

Contains all the custom Exception classes

Module for interacting with the HPE OneView API

OneviewSDK Resources

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Licensed under the Apache License, Version 2.0 (the “License”); You may not use this file except in compliance with the License. You may obtain a copy of the License at www.apache.org/licenses/LICENSE-2.0

Gem version defined here

Constants

DEFAULT_API_VERSION
ENV_VARS
SUPPORTED_API_VERSIONS
VERSION

Public Class Methods

api_version() click to toggle source

Get the current API version

# File lib/oneview-sdk.rb, line 35
def self.api_version
  @api_version
end

api_version=(version) click to toggle source

Set the default API version

# File lib/oneview-sdk.rb, line 40
def self.api_version=(version)
  version = version.to_i rescue version
  raise UnsupportedVersion, "API version #{version} is not supported!"\
    unless SUPPORTED_API_VERSIONS.include?(version)
  raise UnsupportedVariant, "The module for API version #{@api_version} is undefined"\
    unless constants.include?("API#{@api_version}".to_sym)
  @api_version_updated = true
  @api_version = version
end

api_version_updated?() click to toggle source

Has the API version been set by the user? @return [TrueClass, FalseClass]

# File lib/oneview-sdk.rb, line 52
def self.api_version_updated?
  @api_version_updated
end

const_missing(const) click to toggle source

This method will help redirect to resources within the API module that is currently in use. It should NOT be called directly. For example, if @@api_version is set to 200, then accessing OneviewSDK::EthernetNetwork will redirect to OneviewSDK::API200::EthernetNetwork

# File lib/oneview-sdk.rb, line 59
def self.const_missing(const)
  api_module = OneviewSDK.const_get("API#{@api_version}")
  api_module.const_get(const)
rescue NameError
  raise NameError, "The #{const} method or resource does not exist for OneView API version #{@api_version}."
end

resource_named(type, api_ver = @api_version, variant = nil) click to toggle source

Get resource class that matches the type given @param [String] type Name of the desired class type @param [Fixnum] api_ver API module version to fetch resource from @param [String] variant API module variant to fetch resource from @return [Class] Resource class or nil if not found

# File lib/oneview-sdk/resource.rb, line 425
def self.resource_named(type, api_ver = @api_version, variant = nil)
  raise UnsupportedVersion, "API version #{api_ver} is not supported! Try one of: #{SUPPORTED_API_VERSIONS}"\
    unless SUPPORTED_API_VERSIONS.include?(api_ver)
  api_module = OneviewSDK.const_get("API#{api_ver}")
  variant ? api_module.resource_named(type, variant) : api_module.resource_named(type)
end