RubyGems - vsphere-automation-vapi - Versions diffs - 0.4.5 → 0.4.6 - Mend

vsphere-automation-vapi 0.4.5 → 0.4.6

Files changed (330) hide show

data/docs/MetadataMetamodelResourceApi.md DELETED

@@ -1,55 +0,0 @@
-# VSphereAutomation::VAPI::MetadataMetamodelResourceApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](MetadataMetamodelResourceApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/resource | Returns the set of resource types present across all the service elements contained in all the package elements.
-# **list**
-> VapiMetadataMetamodelResourceListResult list
-Returns the set of resource types present across all the service elements contained in all the package elements.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelResourceApi.new
-begin
-  #Returns the set of resource types present across all the service elements contained in all the package elements.
-  result = api_instance.list
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelResourceApi->list: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**VapiMetadataMetamodelResourceListResult**](VapiMetadataMetamodelResourceListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataMetamodelResourceModelApi.md DELETED

@@ -1,59 +0,0 @@
-# VSphereAutomation::VAPI::MetadataMetamodelResourceModelApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list**](MetadataMetamodelResourceModelApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/resource/model | Returns the set of identifiers for the structure elements that are models for the resource type corresponding to {@param.name resourceId}. &lt;p&gt; The {@link vapi.metadata.metamodel.Structure} {@term service} provides {@term operations} to retrieve more details about the structure elements corresponding to the identifiers returned by this {@term operation}.
-# **list**
-> VapiMetadataMetamodelResourceModelListResult list(resource_id)
-Returns the set of identifiers for the structure elements that are models for the resource type corresponding to {@param.name resourceId}. <p> The {@link vapi.metadata.metamodel.Structure} {@term service} provides {@term operations} to retrieve more details about the structure elements corresponding to the identifiers returned by this {@term operation}.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelResourceModelApi.new
-resource_id = 'resource_id_example' # String | Identifier of the resource type.
-begin
-  #Returns the set of identifiers for the structure elements that are models for the resource type corresponding to {@param.name resourceId}. <p> The {@link vapi.metadata.metamodel.Structure} {@term service} provides {@term operations} to retrieve more details about the structure elements corresponding to the identifiers returned by this {@term operation}.
-  result = api_instance.list(resource_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelResourceModelApi->list: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **resource_id** | **String**| Identifier of the resource type. |
-### Return type
-[**VapiMetadataMetamodelResourceModelListResult**](VapiMetadataMetamodelResourceModelListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataMetamodelServiceApi.md DELETED

@@ -1,106 +0,0 @@
-# VSphereAutomation::VAPI::MetadataMetamodelServiceApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](MetadataMetamodelServiceApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/service/id:{service_id} | Retrieves information about the service element corresponding to {@param.name serviceId}. &lt;p&gt; The {@link ServiceInfo} contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
-[**list**](MetadataMetamodelServiceApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/service | Returns the identifiers for the service elements that are currently registered with the infrastructure. &lt;p&gt; The list of service elements is an aggregate list of all the service elements contained in all the package elements.
-# **get**
-> VapiMetadataMetamodelServiceResult get(service_id)
-Retrieves information about the service element corresponding to {@param.name serviceId}. <p> The {@link ServiceInfo} contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelServiceApi.new
-service_id = 'service_id_example' # String | Identifier of the service element.
-begin
-  #Retrieves information about the service element corresponding to {@param.name serviceId}. <p> The {@link ServiceInfo} contains the metamodel information for the operation elements, structure elements and enumeration elements contained in the service element.
-  result = api_instance.get(service_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelServiceApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service_id** | **String**| Identifier of the service element. |
-### Return type
-[**VapiMetadataMetamodelServiceResult**](VapiMetadataMetamodelServiceResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataMetamodelServiceListResult list
-Returns the identifiers for the service elements that are currently registered with the infrastructure. <p> The list of service elements is an aggregate list of all the service elements contained in all the package elements.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelServiceApi.new
-begin
-  #Returns the identifiers for the service elements that are currently registered with the infrastructure. <p> The list of service elements is an aggregate list of all the service elements contained in all the package elements.
-  result = api_instance.list
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelServiceApi->list: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**VapiMetadataMetamodelServiceListResult**](VapiMetadataMetamodelServiceListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataMetamodelServiceOperationApi.md DELETED

@@ -1,112 +0,0 @@
-# VSphereAutomation::VAPI::MetadataMetamodelServiceOperationApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](MetadataMetamodelServiceOperationApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/service/operation/id:{service_id}/id:{operation_id} | Retrieves the metamodel information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
-[**list**](MetadataMetamodelServiceOperationApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/service/operation | Returns the identifiers for the operation elements that are defined in the scope of {@param.name serviceId}.
-# **get**
-> VapiMetadataMetamodelServiceOperationResult get(service_id, operation_id)
-Retrieves the metamodel information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelServiceOperationApi.new
-service_id = 'service_id_example' # String | Identifier of the service element.
-operation_id = 'operation_id_example' # String | Identifier of the operation element.
-begin
-  #Retrieves the metamodel information about an operation element corresponding to {@param.name operationId} contained in the service element corresponding to {@param.name serviceId}.
-  result = api_instance.get(service_id, operation_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelServiceOperationApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service_id** | **String**| Identifier of the service element. |
- **operation_id** | **String**| Identifier of the operation element. |
-### Return type
-[**VapiMetadataMetamodelServiceOperationResult**](VapiMetadataMetamodelServiceOperationResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataMetamodelServiceOperationListResult list(service_id)
-Returns the identifiers for the operation elements that are defined in the scope of {@param.name serviceId}.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelServiceOperationApi.new
-service_id = 'service_id_example' # String | Identifier of the service element.
-begin
-  #Returns the identifiers for the operation elements that are defined in the scope of {@param.name serviceId}.
-  result = api_instance.list(service_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelServiceOperationApi->list: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **service_id** | **String**| Identifier of the service element. |
-### Return type
-[**VapiMetadataMetamodelServiceOperationListResult**](VapiMetadataMetamodelServiceOperationListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataMetamodelStructureApi.md DELETED

@@ -1,106 +0,0 @@
-# VSphereAutomation::VAPI::MetadataMetamodelStructureApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**get**](MetadataMetamodelStructureApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/structure/id:{structure_id} | Retrieves information about the structure element corresponding to {@param.name structureId}. &lt;p&gt; The {@link StructureInfo} contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
-[**list**](MetadataMetamodelStructureApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/structure | Returns the identifiers for the structure elements that are contained in all the package elements and service elements.
-# **get**
-> VapiMetadataMetamodelStructureResult get(structure_id)
-Retrieves information about the structure element corresponding to {@param.name structureId}. <p> The {@link StructureInfo} contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelStructureApi.new
-structure_id = 'structure_id_example' # String | Identifier of the structure element.
-begin
-  #Retrieves information about the structure element corresponding to {@param.name structureId}. <p> The {@link StructureInfo} contains the metamodel information about the structure element. It contains information about all the field elements and enumeration elements contained in this structure element.
-  result = api_instance.get(structure_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelStructureApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **structure_id** | **String**| Identifier of the structure element. |
-### Return type
-[**VapiMetadataMetamodelStructureResult**](VapiMetadataMetamodelStructureResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataMetamodelStructureListResult list
-Returns the identifiers for the structure elements that are contained in all the package elements and service elements.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataMetamodelStructureApi.new
-begin
-  #Returns the identifiers for the structure elements that are contained in all the package elements and service elements.
-  result = api_instance.list
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataMetamodelStructureApi->list: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**VapiMetadataMetamodelStructureListResult**](VapiMetadataMetamodelStructureListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json

data/docs/MetadataPrivilegeComponentApi.md DELETED

@@ -1,157 +0,0 @@
-# VSphereAutomation::VAPI::MetadataPrivilegeComponentApi
-All URIs are relative to *https://&lt;vcenter&gt;/rest*
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**fingerprint**](MetadataPrivilegeComponentApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/privilege/component/id:{component_id}?~action&#x3D;fingerprint | Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to {@param.name componentId}. &lt;p&gt; The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.privilege.Component#get}.
-[**get**](MetadataPrivilegeComponentApi.md#get) | **GET** /com/vmware/vapi/metadata/privilege/component/id:{component_id} | Retrieves privilege information about the component element corresponding to {@param.name componentId}. &lt;p&gt; The {@link ComponentData} contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.
-[**list**](MetadataPrivilegeComponentApi.md#list) | **GET** /com/vmware/vapi/metadata/privilege/component | Returns the identifiers for the component elements that have privilege information.
-# **fingerprint**
-> VapiMetadataPrivilegeComponentFingerprintResult fingerprint(component_id)
-Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to {@param.name componentId}. <p> The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.privilege.Component#get}.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataPrivilegeComponentApi.new
-component_id = 'component_id_example' # String | Identifier of the component element.
-begin
-  #Retrieves the fingerprint computed from the privilege metadata of the component element corresponding to {@param.name componentId}. <p> The fingerprint provides clients an efficient way to check if the metadata for a particular component has been modified on the server. The client can do this by comparing the result of this operation with the fingerprint returned in the result of {@link vapi.metadata.privilege.Component#get}.
-  result = api_instance.fingerprint(component_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataPrivilegeComponentApi->fingerprint: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **component_id** | **String**| Identifier of the component element. |
-### Return type
-[**VapiMetadataPrivilegeComponentFingerprintResult**](VapiMetadataPrivilegeComponentFingerprintResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **get**
-> VapiMetadataPrivilegeComponentResult get(component_id)
-Retrieves privilege information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataPrivilegeComponentApi.new
-component_id = 'component_id_example' # String | Identifier of the component element.
-begin
-  #Retrieves privilege information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.
-  result = api_instance.get(component_id)
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataPrivilegeComponentApi->get: #{e}"
-end
-```
-### Parameters
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **component_id** | **String**| Identifier of the component element. |
-### Return type
-[**VapiMetadataPrivilegeComponentResult**](VapiMetadataPrivilegeComponentResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json
-# **list**
-> VapiMetadataPrivilegeComponentListResult list
-Returns the identifiers for the component elements that have privilege information.
-### Example
-```ruby
-# load the gem
-require 'vsphere-automation-vapi'
-# setup authorization
-VSphereAutomation::Configuration.new.tap do |config|
-  # Configure API key authorization: api_key
-  config.api_key['vmware-api-session-id'] = 'YOUR API KEY'
-  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
-  #config.api_key_prefix['vmware-api-session-id'] = 'Bearer'
-end
-api_instance = VSphereAutomation::VAPI::MetadataPrivilegeComponentApi.new
-begin
-  #Returns the identifiers for the component elements that have privilege information.
-  result = api_instance.list
-  p result
-rescue VSphereAutomation::ApiError => e
-  puts "Exception when calling MetadataPrivilegeComponentApi->list: #{e}"
-end
-```
-### Parameters
-This endpoint does not need any parameter.
-### Return type
-[**VapiMetadataPrivilegeComponentListResult**](VapiMetadataPrivilegeComponentListResult.md)
-### Authorization
-[api_key](../README.md#api_key)
-### HTTP request headers
- - **Content-Type**: Not defined
- - **Accept**: application/json