The com.vmware.vapi.metadata_client module provides metadata classes. These are classes that provide different facets of API information. Clients can use these classes to:
Bases: vmware.vapi.bindings.struct.VapiStruct
The SourceCreateSpec class contains the registration information for a metadata source.
Tip
The arguments are used to initialize data attributes with the same names.
| Parameters: |
|
|---|
Bases: vmware.vapi.bindings.struct.VapiStruct
Metadata source info
Tip
The arguments are used to initialize data attributes with the same names.
| Parameters: |
|
|---|
Bases: vmware.vapi.bindings.enum.Enum
The SourceType class defines the types of sources for API metadata. You specify the type of source when adding a metadata source to a metadata service.
Note
This class represents an enumerated type in the interface language definition. The class contains class attributes which represent the values in the current version of the enumerated type. Newer versions of the enumerated type may contain new values. To use new values of the enumerated type in communication with a server that supports the newer version of the API, you instantiate this class. See enumerated type description page.
| Parameters: | string (str) – String value for the SourceType instance. |
|---|
Indicates the metadata source is a JSON file.
Indicates the metadata source is a remote server.
The com.vmware.vapi.std_client module provides standard types that can be used in the interface specification of any class.
Bases: vmware.vapi.bindings.struct.VapiStruct
The AuthenticationScheme class defines constants for authentication scheme identifiers for authentication mechanisms present in the vAPI infrastructure shipped by VMware.
A third party extension can define and implements it’s own authentication mechanism and define a constant in a different IDL file.
Tip
The arguments are used to initialize data attributes with the same names.
Indicates that the request doesn’t need any authentication.
Indicates that the security context in a request is using OAuth2 based authentication scheme.
In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
Sample security context in JSON format that matches the specification: ``{
‘schemeId’: ‘com.vmware.vapi.std.security.oauth’, ‘accesstoken’: .... }`` vAPI runtime provides convenient factory methods that takes OAuth2 access token as input parameter and creates a security context that conforms to the above format.
Indicates that the security context in a request is using a SAML bearer token based authentication scheme.
In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
Sample security context in JSON format that matches the specification: ``{
‘schemeId’: ‘com.vmware.vapi.std.security.saml_bearer_token’, ‘token’: ‘the token itself’ }`` vAPI runtime provide convenient factory methods that take SAML bearer token and to create the security context that conforms to the above mentioned format.
Indicates that the security context in a request is using a SAML holder-of-key token based authentication scheme.
In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
Sample security context in JSON format that matches the specification: ``{
‘schemeId’: ‘com.vmware.vapi.std.security.saml_hok_token’, ‘signature’: { ‘alg’: ‘RS256’, ‘samlToken’: ..., ‘value’: ...,``, ‘timestamp’: { ‘created’: ‘2012-10-26T12:24:18.941Z’, ‘expires’: ‘2012-10-26T12:44:18.941Z’, } } } vAPI runtime provide convenient factory methods that take SAML holder of key token and private key to create the security context that conforms to the above mentioned format.
Indicates that the security context in a request is using a session identifier based authentication scheme.
In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
Sample security context in JSON format that matches the specification: ``{
‘schemeId’: ‘com.vmware.vapi.std.security.session_id’, ‘sessionId’: ...., }`` vAPI runtime provides convenient factory methods that take session identifier as input parameter and create a security context that conforms to the above format.
Indicates that the security context in a request is using username/password based authentication scheme.
In this scheme, the following pieces of information has to be passed in the SecurityContext structure in the execution context of the request:
Sample security context in JSON format that matches the specification: ``{
‘schemeId’: ‘com.vmware.vapi.std.security.user_pass’, ‘userName’: ...., ‘password’: ... }`` vAPI runtime provides convenient factory methods that take username and password as input parameters and create a security context that conforms to the above format.
Bases: vmware.vapi.bindings.struct.VapiStruct
The DynamicID class represents an identifier for a resource of an arbitrary type.
Tip
The arguments are used to initialize data attributes with the same names.
| Parameters: |
|
|---|
Bases: vmware.vapi.bindings.struct.VapiStruct
The LocalizableMessage class represents a localizable string or message template. Classes include one or more localizable message templates in the exceptions they report so that clients can display diagnostic messages in the native language of the user. Classes can include localizable strings in the data returned from methods to allow clients to display localized status information in the native language of the user.
Tip
The arguments are used to initialize data attributes with the same names.
| Parameters: |
|
|---|
Bases: vmware.vapi.bindings.stub.VapiInterface
The Activation class provides methods for tasks cancelation.
| Parameters: | config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub. |
|---|
Sends a request to cancel the task associated with the provided activation_id.
| Parameters: | activation_id (str) – the activation_id associated with a vCenter Server task to be canceled. The parameter must be an identifier for the resource type: com.vmware.Activation. |
|---|---|
| Raise : | com.vmware.vapi.std.errors_client.NotFound if a vCenter Server task with the given activation_id was not found. |
| Raise : | com.vmware.vapi.std.errors_client.NotAllowedInCurrentState if the vCenter Server task associated with the given activation_id is not cancelable. |
| Raise : | com.vmware.vapi.std.errors_client.Unauthorized if the user is not authorized to cancel the task. |
| Raise : | com.vmware.vapi.std.errors_client.Unauthenticated if the user is not authenticated. |
| Raise : | com.vmware.vapi.std.errors_client.ServiceUnavailable if the task cancelation cannot be performed due to vCenter server is unreachable or it is not properly configured. |