Class RolesStub

  • All Implemented Interfaces:
    Roles, RolesTypes, com.vmware.vapi.bindings.Service

    public class RolesStub
    extends com.vmware.vapi.internal.bindings.Stub
    implements Roles
    Remote stub implementation of the Roles API service.

    WARNING: Internal class, subject to change in future versions.

    • Constructor Summary

      Constructors 
      Constructor Description
      RolesStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.bindings.StubConfigurationBase config)  
      RolesStub​(com.vmware.vapi.core.ApiProvider apiProvider, com.vmware.vapi.internal.bindings.TypeConverter typeConverter, com.vmware.vapi.bindings.StubConfigurationBase config)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      RoleListResult list​(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy)
      Get information about all roles
      void list​(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback)
      Get information about all roles
      void list​(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get information about all roles
      RoleListResult list​(java.lang.String orgId, java.lang.String projectId, java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
      Get information about all roles
      • Methods inherited from class com.vmware.vapi.internal.bindings.Stub

        invokeMethod, invokeMethodAsync, invokeStreamMethod, toString
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • RolesStub

        public RolesStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                         com.vmware.vapi.internal.bindings.TypeConverter typeConverter,
                         com.vmware.vapi.bindings.StubConfigurationBase config)
      • RolesStub

        public RolesStub​(com.vmware.vapi.core.ApiProvider apiProvider,
                         com.vmware.vapi.bindings.StubConfigurationBase config)
    • Method Detail

      • list

        public RoleListResult list​(java.lang.String orgId,
                                   java.lang.String projectId,
                                   java.lang.String cursor,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String scope,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy)
        Description copied from interface: Roles
        Get information about all roles

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

        Specified by:
        list in interface Roles
        Parameters:
        orgId - (required)
        projectId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        scope - List only the roles which are applicable for this scope. (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        Returns:
        com.vmware.nsx_policy.model.RoleListResult
      • list

        public RoleListResult list​(java.lang.String orgId,
                                   java.lang.String projectId,
                                   java.lang.String cursor,
                                   java.lang.String includedFields,
                                   java.lang.Long pageSize,
                                   java.lang.String scope,
                                   java.lang.Boolean sortAscending,
                                   java.lang.String sortBy,
                                   com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Roles
        Get information about all roles

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

        Specified by:
        list in interface Roles
        Parameters:
        orgId - (required)
        projectId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        scope - List only the roles which are applicable for this scope. (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        invocationConfig - Configuration for the method invocation.
        Returns:
        com.vmware.nsx_policy.model.RoleListResult
      • list

        public void list​(java.lang.String orgId,
                         java.lang.String projectId,
                         java.lang.String cursor,
                         java.lang.String includedFields,
                         java.lang.Long pageSize,
                         java.lang.String scope,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback)
        Description copied from interface: Roles
        Get information about all roles

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

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

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

        Specified by:
        list in interface Roles
        Parameters:
        orgId - (required)
        projectId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        scope - List only the roles which are applicable for this scope. (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
      • list

        public void list​(java.lang.String orgId,
                         java.lang.String projectId,
                         java.lang.String cursor,
                         java.lang.String includedFields,
                         java.lang.Long pageSize,
                         java.lang.String scope,
                         java.lang.Boolean sortAscending,
                         java.lang.String sortBy,
                         com.vmware.vapi.bindings.client.AsyncCallback<RoleListResult> asyncCallback,
                         com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
        Description copied from interface: Roles
        Get information about all roles

        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.RoleListResult

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

        Specified by:
        list in interface Roles
        Parameters:
        orgId - (required)
        projectId - (required)
        cursor - Opaque cursor to be used for getting next page of records (supplied by current result page) (optional)
        includedFields - Comma separated list of fields that should be included in query result (optional)
        pageSize - Maximum number of results to return in this page (server may return fewer) (optional, default to 1000)
        scope - List only the roles which are applicable for this scope. (optional)
        sortAscending - (optional)
        sortBy - Field by which records are sorted (optional)
        asyncCallback - Receives the status (progress, result or error) of the operation invocation.
        invocationConfig - Configuration for the method invocation.