vsphere-automation-vapi 0.1.0

data/docs/VapiMetadataMetamodelType.md

@@ -0,0 +1,11 @@
+# VSphereAutomation::VAPI::VapiMetadataMetamodelType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**category** | [**VapiMetadataMetamodelTypeCategory**](VapiMetadataMetamodelTypeCategory.md) |  | 
+**builtin_type** | [**VapiMetadataMetamodelTypeBuiltinType**](VapiMetadataMetamodelTypeBuiltinType.md) |  | [optional] 
+**user_defined_type** | [**VapiMetadataMetamodelUserDefinedType**](VapiMetadataMetamodelUserDefinedType.md) |  | [optional] 
+**generic_instantiation** | [**VapiMetadataMetamodelGenericInstantiation**](VapiMetadataMetamodelGenericInstantiation.md) |  | [optional] 
+
+

data/docs/VapiMetadataMetamodelTypeBuiltinType.md

@@ -0,0 +1,7 @@
+# VSphereAutomation::VAPI::VapiMetadataMetamodelTypeBuiltinType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/VapiMetadataMetamodelTypeCategory.md

@@ -0,0 +1,7 @@
+# VSphereAutomation::VAPI::VapiMetadataMetamodelTypeCategory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/VapiMetadataMetamodelUserDefinedType.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataMetamodelUserDefinedType
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource_type** | **String** | Category of the user defined named type. The named type could be a structure element or an enumeration element. | 
+**resource_id** | **String** | Identifier of the user defined named type. | 
+
+

data/docs/VapiMetadataPrivilegeComponentData.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**info** | [**VapiMetadataPrivilegeComponentInfo**](VapiMetadataPrivilegeComponentInfo.md) |  | 
+**fingerprint** | **String** | Fingerprint of the metadata of the component. <p> Privilege information could change when there is an infrastructure update. Since the data present in {@link ComponentData#info} could be quite large, {@name #fingerprint} provides a convenient way to check if the data for a particular component is updated. <p> You should store the fingerprint associated with a component. After an update, by invoking the {@link vapi.metadata.privilege.Component#fingerprint} {@term operation}, you can retrieve the new fingerprint for the component. If the new fingerprint and the previously stored fingerprint do not match, clients can then use the {@link vapi.metadata.privilege.Component#get} to retrieve the new privilege information for the component. | 
+
+

data/docs/VapiMetadataPrivilegeComponentFingerprintResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentFingerprintResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+
+

data/docs/VapiMetadataPrivilegeComponentInfo.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**packages** | **Array<Object>** | Privilege information of all the package elements. The key in the {@term map} is the identifier of the package element and the value in the {@term map} is the privilege information for the package element. <p> For an explanation of privilege information containment within package elements, see {@link vapi.metadata.privilege.Package}. | 
+
+

data/docs/VapiMetadataPrivilegeComponentInfoPackages.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentInfoPackages
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegePackageInfo**](VapiMetadataPrivilegePackageInfo.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+
+

data/docs/VapiMetadataPrivilegeComponentListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Array<String>** |  | 
+
+

data/docs/VapiMetadataPrivilegeComponentResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeComponentResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegeComponentData**](VapiMetadataPrivilegeComponentData.md) |  | 
+
+

data/docs/VapiMetadataPrivilegeOperationInfo.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeOperationInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**privileges** | **Array<String>** | List of all privileges assigned to the operation element. | 
+**privilege_info** | [**Array<VapiMetadataPrivilegePrivilegeInfo>**](VapiMetadataPrivilegePrivilegeInfo.md) | Privilege information of all the parameter elements of the operation element. For an explanation of containment of privilege information within parameter elements, see {@link vapi.metadata.privilege.PrivilegeInfo}. | 
+
+

data/docs/VapiMetadataPrivilegePackageInfo.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegePackageInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**privileges** | **Array<String>** | List of default privileges to be used for all the operations present in this package. If a particular operation element has no explicit privileges defined in the privilege definition file, these privileges are used for enforcing authorization. | 
+**services** | **Array<Object>** | Information about all service elements contained in this package element that contain privilege information. The key in the {@term map} is the identifier of the service element and the value in the {@term map} is the privilege information for the service element. For an explanation of privilege information containment within service elements, see {@link vapi.metadata.privilege.Service}. | 
+
+

data/docs/VapiMetadataPrivilegePackageInfoServices.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegePackageInfoServices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegeServiceInfo**](VapiMetadataPrivilegeServiceInfo.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+
+

data/docs/VapiMetadataPrivilegePackageListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegePackageListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Array<String>** |  | 
+
+

data/docs/VapiMetadataPrivilegePackageResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegePackageResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegePackageInfo**](VapiMetadataPrivilegePackageInfo.md) |  | 
+
+

data/docs/VapiMetadataPrivilegePrivilegeInfo.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegePrivilegeInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**property_path** | **String** | The {@name #propertyPath} points to an entity that is used in the operation element. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements. <p> If the privilege is assigned to an entity used in the parameter, {@name #propertyPath} will just contain the name of the parameter field. If the privilege is assigned to an entity in one of the field elements of a parameter element that is a structure element, then {@name #propertyPath} will contain a path to the field element starting from the parameter name. | 
+**privileges** | **Array<String>** | List of privileges assigned to the entity that is being referred by {@link #propertyPath}. | 
+
+

data/docs/VapiMetadataPrivilegeServiceInfo.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operations** | **Array<Object>** | Information about all operation elements contained in this service element that contain privilege information. The key in the {@term map} is the identifier of the operation element and the value in the {@term map} is the privilege information for the operation element. <p> For an explanation of containment of privilege information within operation elements, see {@link vapi.metadata.privilege.service.Operation}. | 
+
+

data/docs/VapiMetadataPrivilegeServiceInfoOperations.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceInfoOperations
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegeOperationInfo**](VapiMetadataPrivilegeOperationInfo.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+
+

data/docs/VapiMetadataPrivilegeServiceListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Array<String>** |  | 
+
+

data/docs/VapiMetadataPrivilegeServiceOperationGet.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceOperationGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operation_id** | **String** | Identifier of the operation element. | 
+
+

data/docs/VapiMetadataPrivilegeServiceOperationListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceOperationListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **Array<String>** |  | 
+
+

data/docs/VapiMetadataPrivilegeServiceOperationResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceOperationResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegeOperationInfo**](VapiMetadataPrivilegeOperationInfo.md) |  | 
+
+

data/docs/VapiMetadataPrivilegeServiceResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiMetadataPrivilegeServiceResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiMetadataPrivilegeServiceInfo**](VapiMetadataPrivilegeServiceInfo.md) |  | 
+
+

data/docs/VapiRestNavigationComponentInfo.md

@@ -0,0 +1,10 @@
+# VSphereAutomation::VAPI::VapiRestNavigationComponentInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the component. | 
+**services** | [**VapiRestNavigationLink**](VapiRestNavigationLink.md) |  | 
+**documentation** | **String** | Component documentation. | 
+
+

data/docs/VapiRestNavigationComponentListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationComponentListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VapiRestNavigationComponentInfo>**](VapiRestNavigationComponentInfo.md) |  | 
+
+

data/docs/VapiRestNavigationHttpMethod.md

@@ -0,0 +1,7 @@
+# VSphereAutomation::VAPI::VapiRestNavigationHttpMethod
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+

data/docs/VapiRestNavigationLink.md

@@ -0,0 +1,10 @@
+# VSphereAutomation::VAPI::VapiRestNavigationLink
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method** | [**VapiRestNavigationHttpMethod**](VapiRestNavigationHttpMethod.md) |  | 
+**href** | **String** | URL that should be called. | 
+**metadata** | [**VapiRestNavigationReference**](VapiRestNavigationReference.md) |  | 
+
+

data/docs/VapiRestNavigationOperation.md

@@ -0,0 +1,12 @@
+# VSphereAutomation::VAPI::VapiRestNavigationOperation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the operation. | 
+**service** | **String** | Name of the service where the operations belongs to. | 
+**documentation** | **String** | Documentation of the operation. | 
+**links** | [**Array<VapiRestNavigationReference>**](VapiRestNavigationReference.md) | {@link List} of {@link Reference}s to execute the operation. | 
+**metadata** | [**VapiRestNavigationReference**](VapiRestNavigationReference.md) |  | 
+
+

data/docs/VapiRestNavigationOptionsGet.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiRestNavigationOptionsGet
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**url** | **String** | URL for which operations are retrieved. | 
+**base_url** | **String** | Base URL. | [optional] 
+
+

data/docs/VapiRestNavigationOptionsResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationOptionsResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VapiRestNavigationOperation>**](VapiRestNavigationOperation.md) |  | 
+
+

data/docs/VapiRestNavigationReference.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiRestNavigationReference
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**method** | [**VapiRestNavigationHttpMethod**](VapiRestNavigationHttpMethod.md) |  | 
+**href** | **String** | URL to be called. | 
+
+

data/docs/VapiRestNavigationResourceInfo.md

@@ -0,0 +1,11 @@
+# VSphereAutomation::VAPI::VapiRestNavigationResourceInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | Name of the resource. | 
+**method** | [**VapiRestNavigationHttpMethod**](VapiRestNavigationHttpMethod.md) |  | 
+**href** | **String** | URL to get resource information. | 
+**metadata** | [**VapiRestNavigationReference**](VapiRestNavigationReference.md) |  | 
+
+

data/docs/VapiRestNavigationResourceListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationResourceListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VapiRestNavigationResourceInfo>**](VapiRestNavigationResourceInfo.md) |  | 
+
+

data/docs/VapiRestNavigationResourceResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationResourceResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VapiRestNavigationOperation>**](VapiRestNavigationOperation.md) |  | 
+
+

data/docs/VapiRestNavigationRootInfo.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiRestNavigationRootInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**components** | [**VapiRestNavigationLink**](VapiRestNavigationLink.md) |  | 
+**resources** | [**VapiRestNavigationLink**](VapiRestNavigationLink.md) |  | 
+
+

data/docs/VapiRestNavigationRootResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationRootResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**VapiRestNavigationRootInfo**](VapiRestNavigationRootInfo.md) |  | 
+
+

data/docs/VapiRestNavigationServiceInfo.md

@@ -0,0 +1,12 @@
+# VSphereAutomation::VAPI::VapiRestNavigationServiceInfo
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**documentation** | **String** | Documentation of the service. | 
+**name** | **String** | Name of the service. | 
+**method** | [**VapiRestNavigationHttpMethod**](VapiRestNavigationHttpMethod.md) |  | 
+**href** | **String** | URL to get service information. | 
+**metadata** | [**VapiRestNavigationReference**](VapiRestNavigationReference.md) |  | 
+
+

data/docs/VapiRestNavigationServiceListResult.md

@@ -0,0 +1,8 @@
+# VSphereAutomation::VAPI::VapiRestNavigationServiceListResult
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | [**Array<VapiRestNavigationServiceInfo>**](VapiRestNavigationServiceInfo.md) |  | 
+
+

data/docs/VapiStdErrorsNotAllowedInCurrentState.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiStdErrorsNotAllowedInCurrentState
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+

data/docs/VapiStdErrorsNotAllowedInCurrentStateError.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiStdErrorsNotAllowedInCurrentStateError
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | **String** |  | [optional] 
+**value** | [**VapiStdErrorsNotAllowedInCurrentState**](VapiStdErrorsNotAllowedInCurrentState.md) |  | [optional] 
+
+

data/docs/VapiStdErrorsNotFound.md

@@ -0,0 +1,9 @@
+# VSphereAutomation::VAPI::VapiStdErrorsNotFound
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**messages** | [**Array<VapiStdLocalizableMessage>**](VapiStdLocalizableMessage.md) | Stack of one or more localizable messages for human {@term error} consumers. <p> The message at the top of the stack (first in the list) describes the {@term error} from the perspective of the {@term operation} the client invoked. Each subsequent message in the stack describes the \"cause\" of the prior message. | 
+**data** | [**Object**](.md) | Data to facilitate clients responding to the {@term operation} reporting a standard {@term error} to indicating that it was unable to complete successfully. <p> {@term Operations} may provide data that clients can use when responding to {@term errors}.  Since the data that clients need may be specific to the context of the {@term operation} reporting the {@term error}, different {@term operations} that report the same {@term error} may provide different data in the {@term error}.  The documentation for each each {@term operation} will describe what, if any, data it provides for each {@term error} it reports. The {@link ArgumentLocations}, {@link FileLocations}, and {@link TransientIndication} {@term structures} are intended as possible values for this {@term field}.  {@link vapi.std.DynamicID} may also be useful as a value for this {@term field} (although that is not its primary purpose).  Some {@term services} may provide their own specific {@term structures} for use as the value of this {@term field} when reporting {@term errors} from their {@term operations}. | [optional] 
+
+