### Navigation

- index
- modules |
- vSphere Automation SDK for Python 6.5.0 documentation »
- Module code »

# Source code for com.vmware.vapi.metadata.privilege.service_client

    # -*- coding: utf-8 -*-
    #---------------------------------------------------------------------------
    # Copyright 2016 VMware, Inc.  All rights reserved.

    # AUTO GENERATED FILE -- DO NOT MODIFY!
    #
    # vAPI stub file for package com.vmware.vapi.metadata.privilege.service.
    #---------------------------------------------------------------------------

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

    """

    __author__ = 'VMware, Inc.'
    __docformat__ = 'restructuredtext en'

    import sys

    from vmware.vapi.bindings import type
    from vmware.vapi.bindings.converter import TypeConverter
    from vmware.vapi.bindings.enum import Enum
    from vmware.vapi.bindings.error import VapiError
    from vmware.vapi.bindings.struct import VapiStruct
    from vmware.vapi.bindings.stub import VapiInterface, ApiInterfaceStub
    from vmware.vapi.bindings.common import raise_core_exception
    from vmware.vapi.data.validator import UnionValidator, HasFieldsOfValidator
    from vmware.vapi.exception import CoreException
    import com.vmware.vapi.std.errors_client
    import com.vmware.vapi.metadata.privilege_client

    class Operation(VapiInterface):
        """
        The ``Operation`` class provides methods to retrieve privilege information
        of an operation element.

        An operation element is said to contain privilege information if there are
        any privileges assigned to the operation element or if one of the parameter
        elements contained in it has privileges assigned in privilege definition
        file.
        """
        RESOURCE_TYPE = "com.vmware.vapi.operation"
        """
        Resource type for operation.

        """

        def __init__(self, config):
            """
            :type  config: :class:`vmware.vapi.bindings.stub.StubConfiguration`
            :param config: Configuration to be used for creating the stub.
            """
            VapiInterface.__init__(self, config, _OperationStub)

        def list(self,
                 service_id,
                 ):
            """
            Returns the identifiers for the operation elements contained in the
            service element corresponding to ``service_id`` that have privilege
            information.

            :type  service_id: :class:`str`
            :param service_id: Identifier of the service element.
                The parameter must be an identifier for the resource type:
                ``com.vmware.vapi.service``.
            :rtype: :class:`list` of :class:`str`
            :return: List of identifiers for the operation elements contained in the
                service element that have privilege information.
                The return value will contain identifiers for the resource type:
                ``com.vmware.vapi.operation``.
            :raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
                if the service element associated with ``service_id`` does not have
                any operation elements that have privilege information.
            """
            return self._invoke('list',
                                {
                                'service_id': service_id,
                                })

        def get(self,
                service_id,
                operation_id,
                ):
            """
            Retrieves the privilege information about an operation element
            corresponding to ``operation_id`` contained in the service element
            corresponding to ``service_id``.

            :type  service_id: :class:`str`
            :param service_id: Identifier of the service element.
                The parameter must be an identifier for the resource type:
                ``com.vmware.vapi.service``.
            :type  operation_id: :class:`str`
            :param operation_id: Identifier of the operation element.
                The parameter must be an identifier for the resource type:
                ``com.vmware.vapi.operation``.
            :rtype: :class:`com.vmware.vapi.metadata.privilege_client.OperationInfo`
            :return: The
                :class:`com.vmware.vapi.metadata.privilege_client.OperationInfo`
                instance that corresponds to ``operation_id``.
            :raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
                if the service element associated with ``service_id`` does not
                exist.
            :raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
                if the operation element associated with ``operation_id`` does not
                exist.
            :raise: :class:`com.vmware.vapi.std.errors_client.NotFound`
                if the operation element associated with ``operation_id`` does not
                have any privilege information.
            """
            return self._invoke('get',
                                {
                                'service_id': service_id,
                                'operation_id': operation_id,
                                })

    class _OperationStub(ApiInterfaceStub):
        def __init__(self, config):
            # properties for list operation
            list_input_type = type.StructType('operation-input', {
                'service_id': type.IdType(resource_types='com.vmware.vapi.service'),
            })
            list_error_dict = {
                'com.vmware.vapi.std.errors.not_found':
                    type.ReferenceType(com.vmware.vapi.std.errors_client, 'NotFound'),

            }
            list_input_validator_list = [
            ]
            list_output_validator_list = [
            ]

            # properties for get operation
            get_input_type = type.StructType('operation-input', {
                'service_id': type.IdType(resource_types='com.vmware.vapi.service'),
                'operation_id': type.IdType(resource_types='com.vmware.vapi.operation'),
            })
            get_error_dict = {
                'com.vmware.vapi.std.errors.not_found':
                    type.ReferenceType(com.vmware.vapi.std.errors_client, 'NotFound'),

            }
            get_input_validator_list = [
            ]
            get_output_validator_list = [
            ]

            operations = {
                'list': {
                    'input_type': list_input_type,
                    'output_type': type.ListType(type.IdType()),
                    'errors': list_error_dict,
                    'input_validator_list': list_input_validator_list,
                    'output_validator_list': list_output_validator_list,
                },
                'get': {
                    'input_type': get_input_type,
                    'output_type': type.ReferenceType(com.vmware.vapi.metadata.privilege_client, 'OperationInfo'),
                    'errors': get_error_dict,
                    'input_validator_list': get_input_validator_list,
                    'output_validator_list': get_output_validator_list,
                },
            }
            ApiInterfaceStub.__init__(self, iface_name='com.vmware.vapi.metadata.privilege.service.operation',
                                      config=config,
                                      operations=operations)

### Navigation

- index
- modules |
- vSphere Automation SDK for Python 6.5.0 documentation »
- Module code »