com.vmware.vapi.metadata.authentication package

Submodules

com.vmware.vapi.metadata.authentication.service_client module

The com.vmware.vapi.metadata.authentication.service_client module provides classes to retrieve authentication information for operation elements.

class com.vmware.vapi.metadata.authentication.service_client.Operation(config)

Bases: VapiInterface

The Operation class provides methods to retrieve authentication information of an operation element.

An operation element is said to contain authentication information if authentication schemes are specified in the authentication definition file.

Parameters:

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

RESOURCE_TYPE = 'com.vmware.vapi.operation'

Resource type for operation.

get(service_id, operation_id)

Retrieves the authentication information about an operation element corresponding to operation_id contained in the service element corresponding to service_id.

Parameters:

• service_id (str) – Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

• operation_id (str) – Identifier of the operation element. The parameter must be an identifier for the resource type: com.vmware.vapi.operation.

Return type:

com.vmware.vapi.metadata.authentication_client.OperationInfo

Returns:

The com.vmware.vapi.metadata.authentication_client.OperationInfo instance that corresponds to operation_id.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the service element associated with service_id does not exist.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the operation element associated with operation_id does not exist.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the operation element associated with operation_id does not have any authentication information.

list(service_id)

Returns the identifiers for the operation elements contained in the service element corresponding to service_id that have authentication information.

Parameters:

service_id (str) – Identifier of the service element. The parameter must be an identifier for the resource type: com.vmware.vapi.service.

Return type:

list of str

Returns:

List of identifiers for the operation elements contained in the service element that have authentication information. The return value will contain identifiers for the resource type: com.vmware.vapi.operation.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the service element associated with service_id does not have any operation elements that have authentication information.

class com.vmware.vapi.metadata.authentication.service_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance