com.vmware.nsx_policy.aaa

Interface Roles

All Superinterfaces:

RolesTypes, com.vmware.vapi.bindings.Service

All Known Implementing Classes:

RolesStub

public interface Roles
extends com.vmware.vapi.bindings.Service, RolesTypes

Field Summary

Fields inherited from interface com.vmware.nsx_policy.aaa.RolesTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
NewRole	clone(java.lang.String role, NewRole newRole) The role with id is cloned and the new id, name and description are the ones provided in the request body.
void	clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback) The role with id is cloned and the new id, name and description are the ones provided in the request body.
void	clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) The role with id is cloned and the new id, name and description are the ones provided in the request body.
NewRole	clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) The role with id is cloned and the new id, name and description are the ones provided in the request body.
RoleWithFeatures	update(java.lang.String role, RoleWithFeatures roleWithFeatures) Creates a new role with id as if there does not exist any role with id , else updates the existing role.
void	update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback) Creates a new role with id as if there does not exist any role with id , else updates the existing role.
void	update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new role with id as if there does not exist any role with id , else updates the existing role.
RoleWithFeatures	update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Creates a new role with id as if there does not exist any role with id , else updates the existing role.
RecommendedFeaturePermissionListResult	validate(FeaturePermissionArray featurePermissionArray) Validate the permissions of an incoming role.
void	validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback) Validate the permissions of an incoming role.
void	validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Validate the permissions of an incoming role.
RecommendedFeaturePermissionListResult	validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig) Validate the permissions of an incoming role.

Method Detail

clone

NewRole clone(java.lang.String role,
              NewRole newRole)

The role with id is cloned and the new id, name and description are the ones provided in the request body.

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

Parameters:

role - Role id (required)

newRole - (required)

Returns:

com.vmware.nsx_policy.model.NewRole

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

clone

NewRole clone(java.lang.String role,
              NewRole newRole,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

The role with id is cloned and the new id, name and description are the ones provided in the request body.

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:

role - Role id (required)

newRole - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.NewRole

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

clone

void clone(java.lang.String role,
           NewRole newRole,
           com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback)

The role with id is cloned and the new id, name and description are the ones provided in the request body.

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

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

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

Parameters:

role - Role id (required)

newRole - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

clone

void clone(java.lang.String role,
           NewRole newRole,
           com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback,
           com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

The role with id is cloned and the new id, name and description are the ones provided in the request body.

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

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

Parameters:

role - Role id (required)

newRole - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

update

RoleWithFeatures update(java.lang.String role,
                        RoleWithFeatures roleWithFeatures)

Creates a new role with id as if there does not exist any role with id , else updates the existing role. Permissions for features marked is_internal as true will be ignored if provided in request payload. These features' permission are set internally.

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

Parameters:

role - Custom role id (required)

roleWithFeatures - (required)

Returns:

com.vmware.nsx_policy.model.RoleWithFeatures

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

update

RoleWithFeatures update(java.lang.String role,
                        RoleWithFeatures roleWithFeatures,
                        com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new role with id as if there does not exist any role with id , else updates the existing role. Permissions for features marked is_internal as true will be ignored if provided in request payload. These features' permission are set internally.

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:

role - Custom role id (required)

roleWithFeatures - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.RoleWithFeatures

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

update

void update(java.lang.String role,
            RoleWithFeatures roleWithFeatures,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback)

Creates a new role with id as if there does not exist any role with id , else updates the existing role. Permissions for features marked is_internal as true will be ignored if provided in request payload. These features' permission are set internally.

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

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

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

Parameters:

role - Custom role id (required)

roleWithFeatures - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

update

void update(java.lang.String role,
            RoleWithFeatures roleWithFeatures,
            com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback,
            com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Creates a new role with id as if there does not exist any role with id , else updates the existing role. Permissions for features marked is_internal as true will be ignored if provided in request payload. These features' permission are set internally.

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

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

Parameters:

role - Custom role id (required)

roleWithFeatures - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

validate

RecommendedFeaturePermissionListResult validate(FeaturePermissionArray featurePermissionArray)

Validate the permissions of an incoming role. Also, recommend the permissions which need to be corrected.

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

Parameters:

featurePermissionArray - (required)

Returns:

com.vmware.nsx_policy.model.RecommendedFeaturePermissionListResult

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

validate

RecommendedFeaturePermissionListResult validate(FeaturePermissionArray featurePermissionArray,
                                                com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Validate the permissions of an incoming role. Also, recommend the permissions which need to be corrected.

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:

featurePermissionArray - (required)

invocationConfig - Configuration for the method invocation.

Returns:

com.vmware.nsx_policy.model.RecommendedFeaturePermissionListResult

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

validate

void validate(FeaturePermissionArray featurePermissionArray,
              com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback)

Validate the permissions of an incoming role. Also, recommend the permissions which need to be corrected.

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

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

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

Parameters:

featurePermissionArray - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

validate

void validate(FeaturePermissionArray featurePermissionArray,
              com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback,
              com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)

Validate the permissions of an incoming role. Also, recommend the permissions which need to be corrected.

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

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

Parameters:

featurePermissionArray - (required)

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.