public class CategoryStub extends com.vmware.vapi.internal.bindings.Stub implements Category
Category
API service.
WARNING: Internal API, subject to change in future versions.
CategoryTypes.CreateSpec, CategoryTypes.UpdateSpec| Constructor and Description |
|---|
CategoryStub(ApiProvider apiProvider,
StubConfigurationBase config) |
| Modifier and Type | Method and Description |
|---|---|
void |
addToUsedBy(String categoryId,
String usedByEntity)
|
void |
addToUsedBy(String categoryId,
String usedByEntity,
AsyncCallback<Void> asyncCallback)
|
void |
addToUsedBy(String categoryId,
String usedByEntity,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
|
void |
addToUsedBy(String categoryId,
String usedByEntity,
InvocationConfig invocationConfig)
|
String |
create(CategoryTypes.CreateSpec createSpec)
Creates a category.
|
void |
create(CategoryTypes.CreateSpec createSpec,
AsyncCallback<String> asyncCallback)
Creates a category.
|
void |
create(CategoryTypes.CreateSpec createSpec,
AsyncCallback<String> asyncCallback,
InvocationConfig invocationConfig)
Creates a category.
|
String |
create(CategoryTypes.CreateSpec createSpec,
InvocationConfig invocationConfig)
Creates a category.
|
void |
delete(String categoryId)
Deletes an existing category.
|
void |
delete(String categoryId,
AsyncCallback<Void> asyncCallback)
Deletes an existing category.
|
void |
delete(String categoryId,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
Deletes an existing category.
|
void |
delete(String categoryId,
InvocationConfig invocationConfig)
Deletes an existing category.
|
CategoryModel |
get(String categoryId)
Fetches the category information for the given category identifier.
|
void |
get(String categoryId,
AsyncCallback<CategoryModel> asyncCallback)
Fetches the category information for the given category identifier.
|
void |
get(String categoryId,
AsyncCallback<CategoryModel> asyncCallback,
InvocationConfig invocationConfig)
Fetches the category information for the given category identifier.
|
CategoryModel |
get(String categoryId,
InvocationConfig invocationConfig)
Fetches the category information for the given category identifier.
|
List<String> |
list()
Enumerates the categories in the system.
|
void |
list(AsyncCallback<List<String>> asyncCallback)
Enumerates the categories in the system.
|
void |
list(AsyncCallback<List<String>> asyncCallback,
InvocationConfig invocationConfig)
Enumerates the categories in the system.
|
List<String> |
list(InvocationConfig invocationConfig)
Enumerates the categories in the system.
|
List<String> |
listUsedCategories(String usedByEntity)
Enumerates all categories for which the
usedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. |
void |
listUsedCategories(String usedByEntity,
AsyncCallback<List<String>> asyncCallback)
Enumerates all categories for which the
usedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. |
void |
listUsedCategories(String usedByEntity,
AsyncCallback<List<String>> asyncCallback,
InvocationConfig invocationConfig)
Enumerates all categories for which the
usedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. |
List<String> |
listUsedCategories(String usedByEntity,
InvocationConfig invocationConfig)
Enumerates all categories for which the
usedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. |
void |
removeFromUsedBy(String categoryId,
String usedByEntity)
|
void |
removeFromUsedBy(String categoryId,
String usedByEntity,
AsyncCallback<Void> asyncCallback)
|
void |
removeFromUsedBy(String categoryId,
String usedByEntity,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
|
void |
removeFromUsedBy(String categoryId,
String usedByEntity,
InvocationConfig invocationConfig)
|
void |
revokePropagatingPermissions(String categoryId)
Revokes all propagating permissions on the given category.
|
void |
revokePropagatingPermissions(String categoryId,
AsyncCallback<Void> asyncCallback)
Revokes all propagating permissions on the given category.
|
void |
revokePropagatingPermissions(String categoryId,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
Revokes all propagating permissions on the given category.
|
void |
revokePropagatingPermissions(String categoryId,
InvocationConfig invocationConfig)
Revokes all propagating permissions on the given category.
|
void |
update(String categoryId,
CategoryTypes.UpdateSpec updateSpec)
Updates an existing category.
|
void |
update(String categoryId,
CategoryTypes.UpdateSpec updateSpec,
AsyncCallback<Void> asyncCallback)
Updates an existing category.
|
void |
update(String categoryId,
CategoryTypes.UpdateSpec updateSpec,
AsyncCallback<Void> asyncCallback,
InvocationConfig invocationConfig)
Updates an existing category.
|
void |
update(String categoryId,
CategoryTypes.UpdateSpec updateSpec,
InvocationConfig invocationConfig)
Updates an existing category.
|
public CategoryStub(ApiProvider apiProvider, StubConfigurationBase config)
public String create(CategoryTypes.CreateSpec createSpec)
CategorySynchronous method overload. Result of the invocation will be reported as a method return value.
public String create(CategoryTypes.CreateSpec createSpec, InvocationConfig invocationConfig)
CategorySynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
create in interface CategorycreateSpec - Specification for the new category to be created.invocationConfig - Configuration for the method invocation.com.vmware.cis.tagging.Category.public void create(CategoryTypes.CreateSpec createSpec, AsyncCallback<String> asyncCallback)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Result:
The identifier of the created category.
The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.
Operation Errors:
AlreadyExists - if the CategoryTypes.CreateSpec.getName() provided
in the createSpec is the name of an already existing category.
InvalidArgument - if any of the information in the createSpec is invalid.
Unauthorized - if you do not have the privilege to create a category.
public void create(CategoryTypes.CreateSpec createSpec, AsyncCallback<String> asyncCallback, InvocationConfig invocationConfig)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Result:
The identifier of the created category.
The return value will be an identifier for the resource type: com.vmware.cis.tagging.Category.
Operation Errors:
AlreadyExists - if the CategoryTypes.CreateSpec.getName() provided
in the createSpec is the name of an already existing category.
InvalidArgument - if any of the information in the createSpec is invalid.
Unauthorized - if you do not have the privilege to create a category.
public CategoryModel get(String categoryId)
CategorySynchronous method overload. Result of the invocation will be reported as a method return value.
get in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.CategoryModel that corresponds to categoryId.public CategoryModel get(String categoryId, InvocationConfig invocationConfig)
CategorySynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
get in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.invocationConfig - Configuration for the method invocation.CategoryModel that corresponds to categoryId.public void get(String categoryId, AsyncCallback<CategoryModel> asyncCallback)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Result:
The CategoryModel that corresponds to categoryId.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.
public void get(String categoryId, AsyncCallback<CategoryModel> asyncCallback, InvocationConfig invocationConfig)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Result:
The CategoryModel that corresponds to categoryId.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to read the category.
get in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public void update(String categoryId, CategoryTypes.UpdateSpec updateSpec)
CategorySynchronous method overload. Result of the invocation will be reported as a method return value.
public void update(String categoryId, CategoryTypes.UpdateSpec updateSpec, InvocationConfig invocationConfig)
CategorySynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
update in interface CategorycategoryId - The identifier of the category to be updated.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.updateSpec - Specification to update the category.invocationConfig - Configuration for the method invocation.public void update(String categoryId, CategoryTypes.UpdateSpec updateSpec, AsyncCallback<Void> asyncCallback)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Errors:
AlreadyExists - if the CategoryTypes.UpdateSpec.getName() provided
in the updateSpec is the name of an already existing category.
InvalidArgument - if any of the information in the updateSpec is invalid.
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to update the category.
update in interface CategorycategoryId - The identifier of the category to be updated.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.updateSpec - Specification to update the category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.public void update(String categoryId, CategoryTypes.UpdateSpec updateSpec, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Errors:
AlreadyExists - if the CategoryTypes.UpdateSpec.getName() provided
in the updateSpec is the name of an already existing category.
InvalidArgument - if any of the information in the updateSpec is invalid.
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to update the category.
update in interface CategorycategoryId - The identifier of the category to be updated.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.updateSpec - Specification to update the category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public void delete(String categoryId)
CategorySynchronous method overload. Result of the invocation will be reported as a method return value.
public void delete(String categoryId, InvocationConfig invocationConfig)
CategorySynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
public void delete(String categoryId, AsyncCallback<Void> asyncCallback)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the category.
public void delete(String categoryId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to delete the category.
delete in interface CategorycategoryId - The identifier of category to be deleted.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public List<String> list()
CategoryList will
only contain those categories for which you have read privileges.
Synchronous method overload. Result of the invocation will be reported as a method return value.
public List<String> list(InvocationConfig invocationConfig)
CategoryList will
only contain those categories for which you have read privileges.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
public void list(AsyncCallback<List<String>> asyncCallback)
CategoryList will
only contain those categories for which you have read privileges.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Result:
The List of resource identifiers for the categories in the
system.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.
public void list(AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig)
CategoryList will
only contain those categories for which you have read privileges.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Result:
The List of resource identifiers for the categories in the
system.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.
public List<String> listUsedCategories(String usedByEntity)
CategoryusedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the
individual categories.
Synchronous method overload. Result of the invocation will be reported as a method return value.
listUsedCategories in interface CategoryusedByEntity - The field on which the results will be filtered.List of resource identifiers for the categories in the
system that are used by usedByEntity.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.public List<String> listUsedCategories(String usedByEntity, InvocationConfig invocationConfig)
CategoryusedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the
individual categories.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
listUsedCategories in interface CategoryusedByEntity - The field on which the results will be filtered.invocationConfig - Configuration for the method invocation.List of resource identifiers for the categories in the
system that are used by usedByEntity.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.public void listUsedCategories(String usedByEntity, AsyncCallback<List<String>> asyncCallback)
CategoryusedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the
individual categories.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Result:
The List of resource identifiers for the categories in the
system that are used by usedByEntity.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.
listUsedCategories in interface CategoryusedByEntity - The field on which the results will be filtered.asyncCallback - Receives the status (progress, result or error) of the operation invocation.public void listUsedCategories(String usedByEntity, AsyncCallback<List<String>> asyncCallback, InvocationConfig invocationConfig)
CategoryusedByEntity is part of the
CategoryModel.getUsedBy() subscribers Set. To invoke this method, you need the read privilege on the
individual categories.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Result:
The List of resource identifiers for the categories in the
system that are used by usedByEntity.
The return value will contain identifiers for the resource type: com.vmware.cis.tagging.Category.
listUsedCategories in interface CategoryusedByEntity - The field on which the results will be filtered.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public void addToUsedBy(String categoryId, String usedByEntity)
CategoryusedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is
already in the Set, then this becomes an idempotent no-op. To
invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Synchronous method overload. Result of the invocation will be reported as a method return value.
addToUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.public void addToUsedBy(String categoryId, String usedByEntity, InvocationConfig invocationConfig)
CategoryusedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is
already in the Set, then this becomes an idempotent no-op. To
invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
addToUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.invocationConfig - Configuration for the method invocation.public void addToUsedBy(String categoryId, String usedByEntity, AsyncCallback<Void> asyncCallback)
CategoryusedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is
already in the Set, then this becomes an idempotent no-op. To
invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the CategoryModel.getUsedBy() field.
addToUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.asyncCallback - Receives the status (progress, result or error) of the operation invocation.public void addToUsedBy(String categoryId, String usedByEntity, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
CategoryusedByEntity to the CategoryModel.getUsedBy() subscribers Set for the specified category. If the usedByEntity is
already in the Set, then this becomes an idempotent no-op. To
invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
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:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to add an entity to the CategoryModel.getUsedBy() field.
addToUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be added to the CategoryModel.getUsedBy() Set.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public void removeFromUsedBy(String categoryId, String usedByEntity)
CategoryusedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then
this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Synchronous method overload. Result of the invocation will be reported as a method return value.
removeFromUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.public void removeFromUsedBy(String categoryId, String usedByEntity, InvocationConfig invocationConfig)
CategoryusedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then
this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Synchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
removeFromUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.invocationConfig - Configuration for the method invocation.public void removeFromUsedBy(String categoryId, String usedByEntity, AsyncCallback<Void> asyncCallback)
CategoryusedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then
this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
Asynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the CategoryModel.getUsedBy() field.
removeFromUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.asyncCallback - Receives the status (progress, result or error) of the operation invocation.public void removeFromUsedBy(String categoryId, String usedByEntity, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
CategoryusedByEntity from the CategoryModel.getUsedBy() subscribers Set. If the usedByEntity is not using this category, then
this becomes a no-op. To invoke this method, you need the modify CategoryModel.getUsedBy() privilege on the category.
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:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to remove an entity from the CategoryModel.getUsedBy() field.
removeFromUsedBy in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.usedByEntity - The name of the user to be removed from the CategoryModel.getUsedBy() Set.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.public void revokePropagatingPermissions(String categoryId)
CategorySynchronous method overload. Result of the invocation will be reported as a method return value.
revokePropagatingPermissions in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.public void revokePropagatingPermissions(String categoryId, InvocationConfig invocationConfig)
CategorySynchronous method overload. Result of the invocation will be
reported as a method return value.
Use invocationConfig to specify configuration for this particular invocation.
revokePropagatingPermissions in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.invocationConfig - Configuration for the method invocation.public void revokePropagatingPermissions(String categoryId, AsyncCallback<Void> asyncCallback)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the
category.
revokePropagatingPermissions in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.public void revokePropagatingPermissions(String categoryId, AsyncCallback<Void> asyncCallback, InvocationConfig invocationConfig)
CategoryAsynchronous method overload. Result of the invocation will be
reported via the specified asyncCallback.
Use invocationConfig to specify configuration for this particular invocation.
Operation Errors:
NotFound - if the category for the given categoryId does not exist in the system.
Unauthorized - if you do not have the privilege to revoke propagating permissions on the
category.
revokePropagatingPermissions in interface CategorycategoryId - The identifier of the input category.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.asyncCallback - Receives the status (progress, result or error) of the operation invocation.invocationConfig - Configuration for the method invocation.Copyright © 2016. All Rights Reserved.