Interface UserInfo

  • All Superinterfaces:
    com.vmware.vapi.bindings.Service, UserInfoTypes
    All Known Implementing Classes:
    UserInfoStub

    public interface UserInfo
    extends com.vmware.vapi.bindings.Service, UserInfoTypes
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      UserInfo get​(java.lang.String orgId, java.lang.String projectId)
      This API will return the name and role information of the user invoking this API request on the particular project.
      void get​(java.lang.String orgId, java.lang.String projectId, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback)
      This API will return the name and role information of the user invoking this API request on the particular project.
      void get​(java.lang.String orgId, java.lang.String projectId, com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This API will return the name and role information of the user invoking this API request on the particular project.
      UserInfo get​(java.lang.String orgId, java.lang.String projectId, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      This API will return the name and role information of the user invoking this API request on the particular project.
    • Method Detail

      • get

        UserInfo get​(java.lang.String orgId,
                     java.lang.String projectId)
        This API will return the name and role information of the user invoking this API request on the particular project. The permissions parameter of the NsxRole has been deprecated. The response will contain the roles_for_paths to indicate roles of the user at various paths .

        Synchronous method overload. Result of the invocation will be reported as a method return value.

        Parameters:
        orgId - (required)
        projectId - (required)
        Returns:
        com.vmware.nsx_policy.model.UserInfo
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found
      • get

        UserInfo get​(java.lang.String orgId,
                     java.lang.String projectId,
                     com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        This API will return the name and role information of the user invoking this API request on the particular project. The permissions parameter of the NsxRole has been deprecated. The response will contain the roles_for_paths to indicate roles of the user at various paths .

        Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

        Parameters:
        orgId - (required)
        projectId - (required)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.UserInfo
        Throws:
        com.vmware.vapi.std.errors.InvalidRequest - Bad Request, Precondition Failed
        com.vmware.vapi.std.errors.Unauthorized - Forbidden
        com.vmware.vapi.std.errors.ServiceUnavailable - Service Unavailable
        com.vmware.vapi.std.errors.InternalServerError - Internal Server Error
        com.vmware.vapi.std.errors.NotFound - Not Found
      • get

        void get​(java.lang.String orgId,
                 java.lang.String projectId,
                 com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback)
        This API will return the name and role information of the user invoking this API request on the particular project. The permissions parameter of the NsxRole has been deprecated. The response will contain the roles_for_paths to indicate roles of the user at various paths .

        Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

        Invocation Result:
        com.vmware.nsx_policy.model.UserInfo

        Operation Errors:
        InvalidRequest - Bad Request, Precondition Failed
        Unauthorized - Forbidden
        ServiceUnavailable - Service Unavailable
        InternalServerError - Internal Server Error
        NotFound - Not Found

        Parameters:
        orgId - (required)
        projectId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • get

        void get​(java.lang.String orgId,
                 java.lang.String projectId,
                 com.vmware.vapi.bindings.client.AsyncCallback<UserInfo> asyncCallback,
                 com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        This API will return the name and role information of the user invoking this API request on the particular project. The permissions parameter of the NsxRole has been deprecated. The response will contain the roles_for_paths to indicate roles of the user at various paths .

        Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

        Invocation Result:
        com.vmware.nsx_policy.model.UserInfo

        Operation Errors:
        InvalidRequest - Bad Request, Precondition Failed
        Unauthorized - Forbidden
        ServiceUnavailable - Service Unavailable
        InternalServerError - Internal Server Error
        NotFound - Not Found

        Parameters:
        orgId - (required)
        projectId - (required)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.