public interface Roles extends com.vmware.vapi.bindings.Service, RolesTypes
_VAPI_SERVICE_ID, LIST_SCOPE_ORG, LIST_SCOPE_PROJECT, LIST_SCOPE_ROOT, LIST_SCOPE_VPC
Modifier and Type | Method and Description |
---|---|
NewRole |
clone(java.lang.String role,
NewRole newRole)
The role with id
|
void |
clone(java.lang.String role,
NewRole newRole,
com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback)
The role with id
|
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
|
NewRole |
clone(java.lang.String role,
NewRole newRole,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
The role with id
|
void |
delete(java.lang.String role)
If a role is assigned to a role binding then the deletion of the role is not
allowed.
|
void |
delete(java.lang.String role,
com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
If a role is assigned to a role binding then the deletion of the role is not
allowed.
|
void |
delete(java.lang.String role,
com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
If a role is assigned to a role binding then the deletion of the role is not
allowed.
|
void |
delete(java.lang.String role,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
If a role is assigned to a role binding then the deletion of the role is not
allowed.
|
RoleWithFeatures |
get(java.lang.String role)
Get role information
|
void |
get(java.lang.String role,
com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback)
Get role information
|
void |
get(java.lang.String role,
com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Get role information
|
RoleWithFeatures |
get(java.lang.String role,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Get role information
|
RoleListResult |
list(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 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 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 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
|
RoleWithFeatures |
update(java.lang.String role,
RoleWithFeatures roleWithFeatures)
Creates a new role with id as
|
void |
update(java.lang.String role,
RoleWithFeatures roleWithFeatures,
com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback)
Creates a new role with id as
|
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
|
RoleWithFeatures |
update(java.lang.String role,
RoleWithFeatures roleWithFeatures,
com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Creates a new role with id as
|
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.
|
NewRole clone(java.lang.String role, NewRole newRole)
Synchronous method overload. Result of the invocation will be reported as a method return value.
role
- Role id (required)newRole
- (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundNewRole clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
role
- Role id (required)newRole
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.NewRole
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Role id (required)newRole
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void clone(java.lang.String role, NewRole newRole, com.vmware.vapi.bindings.client.AsyncCallback<NewRole> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.model.NewRole
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Role id (required)newRole
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.void delete(java.lang.String role)
Synchronous method overload. Result of the invocation will be reported as a method return value.
role
- Custom role id (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid delete(java.lang.String role, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
role
- Custom role id (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid delete(java.lang.String role, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Custom role id (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void delete(java.lang.String role, com.vmware.vapi.bindings.client.AsyncCallback<java.lang.Void> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Use invocationConfig
to specify configuration for this particular invocation.
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Custom role id (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.RoleWithFeatures get(java.lang.String role)
Synchronous method overload. Result of the invocation will be reported as a method return value.
role
- Role id (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundRoleWithFeatures get(java.lang.String role, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
role
- Role id (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid get(java.lang.String role, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.RoleWithFeatures
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Role id (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void get(java.lang.String role, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.model.RoleWithFeatures
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Role id (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.RoleListResult list(java.lang.String cursor, java.lang.String includedFields, java.lang.Long pageSize, java.lang.String scope, java.lang.Boolean sortAscending, java.lang.String sortBy)
Synchronous method overload. Result of the invocation will be reported as a method return value.
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)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundRoleListResult list(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)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
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.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid list(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)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.RoleListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
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.void list(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)
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.model.RoleListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
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.RoleWithFeatures update(java.lang.String role, RoleWithFeatures roleWithFeatures)
Synchronous method overload. Result of the invocation will be reported as a method return value.
role
- Custom role id (required)roleWithFeatures
- (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundRoleWithFeatures update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
role
- Custom role id (required)roleWithFeatures
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.RoleWithFeatures
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
role
- Custom role id (required)roleWithFeatures
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void update(java.lang.String role, RoleWithFeatures roleWithFeatures, com.vmware.vapi.bindings.client.AsyncCallback<RoleWithFeatures> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.model.RoleWithFeatures
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
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.RecommendedFeaturePermissionListResult validate(FeaturePermissionArray featurePermissionArray)
Synchronous method overload. Result of the invocation will be reported as a method return value.
featurePermissionArray
- (required)com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not FoundRecommendedFeaturePermissionListResult validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig
to specify configuration for this particular invocation.
featurePermissionArray
- (required)invocationConfig
- Configuration for the method invocation.com.vmware.vapi.std.errors.InvalidRequest
- Bad Request, Precondition Failedcom.vmware.vapi.std.errors.Unauthorized
- Forbiddencom.vmware.vapi.std.errors.ServiceUnavailable
- Service Unavailablecom.vmware.vapi.std.errors.InternalServerError
- Internal Server Errorcom.vmware.vapi.std.errors.NotFound
- Not Foundvoid validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback)
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback
.
Invocation Result:
com.vmware.nsx.model.RecommendedFeaturePermissionListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
featurePermissionArray
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.void validate(FeaturePermissionArray featurePermissionArray, com.vmware.vapi.bindings.client.AsyncCallback<RecommendedFeaturePermissionListResult> asyncCallback, com.vmware.vapi.bindings.client.InvocationConfig invocationConfig)
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.model.RecommendedFeaturePermissionListResult
Operation Errors:
InvalidRequest
- Bad Request, Precondition Failed
Unauthorized
- Forbidden
ServiceUnavailable
- Service Unavailable
InternalServerError
- Internal Server Error
NotFound
- Not Found
featurePermissionArray
- (required)asyncCallback
- Receives the status (progress, result or error) of the operation invocation.invocationConfig
- Configuration for the method invocation.