vsphere-automation-vapi 0.1.0

data/docs/MetadataMetamodelServiceOperationApi.md

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

data/docs/MetadataMetamodelStructureApi.md

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

data/docs/MetadataPrivilegeComponentApi.md

@@ -0,0 +1,136 @@
+# VSphereAutomation::VAPI::MetadataPrivilegeComponentApi
+
+All URIs are relative to *https://<vcenter>/rest*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**fingerprint**](MetadataPrivilegeComponentApi.md#fingerprint) | **POST** /com/vmware/vapi/metadata/privilege/component/id:{component_id}?~action=fingerprint | 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}.
+[**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}. <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.
+[**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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **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'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+
+# **list**
+> VapiMetadataPrivilegeComponentListResult list
+
+Returns the identifiers for the component elements that have privilege information.
+
+### Example
+```ruby
+# load the gem
+require 'vsphere-automation-vapi'
+
+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
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+

data/docs/MetadataPrivilegePackageApi.md

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

data/docs/MetadataPrivilegeServiceApi.md

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