Com::Vmware::Cis::Tagging::Category Class Reference

Inheritance diagram for Com::Vmware::Cis::Tagging::Category:

Classes
class	CreateSpec
class	UpdateSpec

Avaliable Methods
public method	remove_from_used_by ()
public method	create ()
public method	revoke_propagating_permissions ()
public method	add_to_used_by ()
public method	list_used_categories ()
public method	get ()
public method	delete ()
public method	new ()
public method	update ()
public method	list ()

Detailed Description

The Com::Vmware::Cis::Tagging::Category interface provides methods to create, read, update, delete, and enumerate categories.

Member Function Documentation

public method Com::Vmware::Cis::Tagging::Category::add_to_used_by

(

)

Adds the used_by_entity to the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by subscribers set for the specified category. If the used_by_entity is already in the set , then this becomes an idempotent no-op. To invoke this method , you need the modify :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by privilege on the category.

Parameters

category_id	[REQUIRED] The identifier of the input category. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.
used_by_entity	[REQUIRED] The name of the user to be added to the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by set . . The value must be String.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to add an entity to the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by field.

Code:

public method Com::Vmware::Cis::Tagging::Category::create

(

)

Creates a category. To invoke this method , you need the create category privilege.

Parameters

create_spec

[REQUIRED] Specification for the new category to be created. . The value must be Com::Vmware::Cis::Tagging::Category::CreateSpec.

Return values

The	identifier of the created category. The value will be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). The return type will be str

Exceptions

Com::Vmware::Vapi::Std::Errors::AlreadyExists	if the :attr:Com::Vmware::Cis::Tagging::Category::CreateSpec.name provided in the create_spec is the name of an already existing category.
Com::Vmware::Vapi::Std::Errors::InvalidArgument	if any of the information in the create_spec is invalid.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to create a category.

Code:

public method Com::Vmware::Cis::Tagging::Category::delete

(

)

Deletes an existing category. To invoke this method , you need the delete privilege on the category.

Parameters

category_id

[REQUIRED] The identifier of category to be deleted. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to delete the category.

Code:

public method Com::Vmware::Cis::Tagging::Category::get

(

)

Fetches the category information for the given category identifier. In order to view the category information, you need the read privilege on the category.

Parameters

category_id

[REQUIRED] The identifier of the input category. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.

Return values

The	class Com::Vmware::Cis::Tagging::CategoryModel that corresponds to category_id . The return type will be Com::Vmware::Cis::Tagging::CategoryModel

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to read the category.

Code:

public method Com::Vmware::Cis::Tagging::Category::list

(

)

Enumerates the categories in the system. To invoke this method , you need the read privilege on the individual categories. The list will only contain those categories for which you have read privileges.

Return values

The	list of resource identifiers for the categories in the system. The value will be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). The return type will be Array of str

Code:

public method Com::Vmware::Cis::Tagging::Category::list_used_categories

(

)

Enumerates all categories for which the used_by_entity is part of the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by subscribers set . To invoke this method , you need the read privilege on the individual categories.

Parameters

used_by_entity

[REQUIRED] The field on which the results will be filtered. . The value must be String.

Return values

The	list of resource identifiers for the categories in the system that are used by used_by_entity . The value will be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). The return type will be Array of str

Code:

public method Com::Vmware::Cis::Tagging::Category::new

(

)

Constructor to initialize the object

Parameters

api_provider	- protocol connection to use with stubs created by this factory
StubConfig	- Stub's additional configuration

Return values

Blessed

object

Code:

public method Com::Vmware::Cis::Tagging::Category::remove_from_used_by

(

)

Removes the used_by_entity from the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by subscribers set . If the used_by_entity is not using this category, then this becomes a no-op. To invoke this method* , you need the modify :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by privilege on the category.

Parameters

category_id	[REQUIRED] The identifier of the input category. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.
used_by_entity	[REQUIRED] The name of the user to be removed from the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by set . . The value must be String.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to remove an entity from the :attr:Com::Vmware::Cis::Tagging::CategoryModel.used_by field.

Code:

public method Com::Vmware::Cis::Tagging::Category::revoke_propagating_permissions

(

)

Revokes all propagating permissions on the given category. You should then attach a direct permission with tagging privileges on the given category. To invoke this method , you need category related privileges (direct or propagating) on the concerned category.

Parameters

category_id

[REQUIRED] The identifier of the input category. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.

Exceptions

Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to revoke propagating permissions on the category.

Code:

public method Com::Vmware::Cis::Tagging::Category::update

(

)

Updates an existing category. To invoke this method , you need the edit privilege on the category.

Parameters

category_id	[REQUIRED] The identifier of the category to be updated. The value must be an identifier for the resource type getQualifiedName(com.vmware.cis.tagging.Category). . The value must be str.
update_spec	[REQUIRED] Specification to update the category. . The value must be Com::Vmware::Cis::Tagging::Category::UpdateSpec.

Exceptions

Com::Vmware::Vapi::Std::Errors::AlreadyExists	if the :attr:Com::Vmware::Cis::Tagging::Category::UpdateSpec.name provided in the update_spec is the name of an already existing category.
Com::Vmware::Vapi::Std::Errors::InvalidArgument	if any of the information in the update_spec is invalid.
Com::Vmware::Vapi::Std::Errors::NotFound	if the category for the given category_id does not exist in the system.
Com::Vmware::Vapi::Std::Errors::Unauthorized	if you do not have the privilege to update the category.

Code:

---

The documentation for this class was generated from the following file:

• Com/Vmware/Cis/Tagging/Category.pm