vsphere-automation-vapi 0.1.0

data/docs/MetadataMetamodelComponentApi.md

@@ -0,0 +1,136 @@
+# VSphereAutomation::VAPI::MetadataMetamodelComponentApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fingerprint**](MetadataMetamodelComponentApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/metamodel/component/id:{component_id}?~action=fingerprint | Retrieves the fingerprint computed from the metamodel 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 element 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.metamodel.Component#get}.
+[**get**](MetadataMetamodelComponentApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/component/id:{component_id} | Retrieves metamodel information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.
+[**list**](MetadataMetamodelComponentApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/component | Returns the identifiers for the component elements that are registered with the infrastructure.
+
+
+# **fingerprint**
+> VapiMetadataMetamodelComponentFingerprintResult fingerprint(component_id)
+
+Retrieves the fingerprint computed from the metamodel 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 element 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.metamodel.Component#get}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelComponentApi.new
+component_id = 'component_id_example' # String | Identifier of the component element.
+
+begin
+  #Retrieves the fingerprint computed from the metamodel 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 element 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.metamodel.Component#get}.
+  result = api_instance.fingerprint(component_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelComponentApi->fingerprint: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **component_id** | **String**| Identifier of the component element. | 
+
+### Return type
+
+[**VapiMetadataMetamodelComponentFingerprintResult**](VapiMetadataMetamodelComponentFingerprintResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **get**
+> VapiMetadataMetamodelComponentResult get(component_id)
+
+Retrieves metamodel information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelComponentApi.new
+component_id = 'component_id_example' # String | Identifier of the component element.
+
+begin
+  #Retrieves metamodel information about the component element corresponding to {@param.name componentId}. <p> The {@link ComponentData} contains the metamodel information about the component and it's fingerprint. It contains information about all the package elements that are contained in this component element.
+  result = api_instance.get(component_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelComponentApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **component_id** | **String**| Identifier of the component element. | 
+
+### Return type
+
+[**VapiMetadataMetamodelComponentResult**](VapiMetadataMetamodelComponentResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataMetamodelComponentListResult list
+
+Returns the identifiers for the component elements that are registered with the infrastructure.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelComponentApi.new
+
+begin
+  #Returns the identifiers for the component elements that are registered with the infrastructure.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelComponentApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataMetamodelComponentListResult**](VapiMetadataMetamodelComponentListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataMetamodelEnumerationApi.md

@@ -0,0 +1,92 @@
+# VSphereAutomation::VAPI::MetadataMetamodelEnumerationApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataMetamodelEnumerationApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/enumeration/id:{enumeration_id} | Retrieves information about the enumeration element corresponding to {@param.name enumerationId}. <p> The {@link EnumerationInfo} contains the metamodel information about the enumeration value element contained in the enumeration element.
+[**list**](MetadataMetamodelEnumerationApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/enumeration | Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
+
+
+# **get**
+> VapiMetadataMetamodelEnumerationResult get(enumeration_id)
+
+Retrieves information about the enumeration element corresponding to {@param.name enumerationId}. <p> The {@link EnumerationInfo} contains the metamodel information about the enumeration value element contained in the enumeration element.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelEnumerationApi.new
+enumeration_id = 'enumeration_id_example' # String | Identifier of the enumeration element.
+
+begin
+  #Retrieves information about the enumeration element corresponding to {@param.name enumerationId}. <p> The {@link EnumerationInfo} contains the metamodel information about the enumeration value element contained in the enumeration element.
+  result = api_instance.get(enumeration_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelEnumerationApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **enumeration_id** | **String**| Identifier of the enumeration element. | 
+
+### Return type
+
+[**VapiMetadataMetamodelEnumerationResult**](VapiMetadataMetamodelEnumerationResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataMetamodelEnumerationListResult list
+
+Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelEnumerationApi.new
+
+begin
+  #Returns the identifiers for the enumeration elements that are contained in all the package elements, service elements and structure elements.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelEnumerationApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataMetamodelEnumerationListResult**](VapiMetadataMetamodelEnumerationListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataMetamodelPackageApi.md

@@ -0,0 +1,92 @@
+# VSphereAutomation::VAPI::MetadataMetamodelPackageApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get**](MetadataMetamodelPackageApi.md#get) | **GET** /com/vmware/vapi/metadata/metamodel/package/id:{package_id} | Retrieves information about the package element corresponding to {@param.name packageId}.
+[**list**](MetadataMetamodelPackageApi.md#list) | **GET** /com/vmware/vapi/metadata/metamodel/package | Returns the identifiers for the packages elements that are contained in all the registered component elements.
+
+
+# **get**
+> VapiMetadataMetamodelPackageResult get(package_id)
+
+Retrieves information about the package element corresponding to {@param.name packageId}.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelPackageApi.new
+package_id = 'package_id_example' # String | Identifier of the package element.
+
+begin
+  #Retrieves information about the package element corresponding to {@param.name packageId}.
+  result = api_instance.get(package_id)
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelPackageApi->get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **package_id** | **String**| Identifier of the package element. | 
+
+### Return type
+
+[**VapiMetadataMetamodelPackageResult**](VapiMetadataMetamodelPackageResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataMetamodelPackageListResult list
+
+Returns the identifiers for the packages elements that are contained in all the registered component elements.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+api_instance = VSphereAutomation::VAPI::MetadataMetamodelPackageApi.new
+
+begin
+  #Returns the identifiers for the packages elements that are contained in all the registered component elements.
+  result = api_instance.list
+  p result
+rescue VSphereAutomation::ApiError => e
+  puts "Exception when calling MetadataMetamodelPackageApi->list: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+[**VapiMetadataMetamodelPackageListResult**](VapiMetadataMetamodelPackageListResult.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataMetamodelResourceApi.md

@@ -0,0 +1,48 @@
+# VSphereAutomation::VAPI::MetadataMetamodelResourceApi
+
+All URIs are relative to *https://<vcenter>/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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataMetamodelResourceModelApi.md

@@ -0,0 +1,52 @@
+# VSphereAutomation::VAPI::MetadataMetamodelResourceModelApi
+
+All URIs are relative to *https://<vcenter>/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}. <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}.
+
+
+# **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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataMetamodelServiceApi.md

@@ -0,0 +1,92 @@
+# VSphereAutomation::VAPI::MetadataMetamodelServiceApi
+
+All URIs are relative to *https://<vcenter>/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}. <p> 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. <p> 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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+