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

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

Avaliable Methods
public method	set_cardinality ()
public method	set_description ()
public method	set_associable_types ()
public method	set_name ()
public method	get_cardinality ()
public method	get_description ()
public method	get_associable_types ()
public method	new ()
public method	get_name ()

Detailed Description

The Com::Vmware::Cis::Tagging::Category::UpdateSpec class describes the updates to be made to an existing category.

Use the :func:Com::Vmware::Cis::Tagging::Category.update method to modify a category. When you call the method , specify the category identifier. You obtain the category identifier when you call the :func:Com::Vmware::Cis::Tagging::Category.create method . You can also retrieve an identifier by using the :func:Com::Vmware::Cis::Tagging::Category.list method* .

Member Function Documentation

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::get_associable_types

(

)

Gets the value of 'associable_types' property.

Return values

associable_types

- The current value of the field. Object types to which this category's tags can be attached.

The set of associable types cannot be updated incrementally. For example, if :attr:Com::Vmware::Cis::Tagging::Category::UpdateSpec.associable_types originally contains {A,B,C} and you want to add D, then you need to pass {A,B,C,D} in your update specification. You also cannot remove any item from this set . For example, if you have {A,B,C}, then you cannot remove say {A} from it. Similarly, if you start with an empty set , then that implies that you can tag any object and hence you cannot later pass say {A}, because that would be restricting the type of objects you want to tag. Thus, associable types can only grow and not shrink.

Optional#

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::get_cardinality

(

)

Gets the value of 'cardinality' property.

Return values

cardinality

- The current value of the field. The associated cardinality (SINGLE, MULTIPLE) of the category. Optional#

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::get_description

(

)

Gets the value of 'description' property.

Return values

description

- The current value of the field. The description of the category. Optional#

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::get_name

(

)

Gets the value of 'name' property.

Return values

name	- The current value of the field. The display name of the category. Optional#

Code:

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

(

)

Constructor to initialize the Com::Vmware::Cis::Tagging::Category::UpdateSpec structure

Return values

Blessed

object

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::set_associable_types

(

)

Sets the given value for 'associable_types' property.

Parameters

associable_types

- New value for the field. Object types to which this category's tags can be attached.

The set of associable types cannot be updated incrementally. For example, if :attr:Com::Vmware::Cis::Tagging::Category::UpdateSpec.associable_types originally contains {A,B,C} and you want to add D, then you need to pass {A,B,C,D} in your update specification. You also cannot remove any item from this set . For example, if you have {A,B,C}, then you cannot remove say {A} from it. Similarly, if you start with an empty set , then that implies that you can tag any object and hence you cannot later pass say {A}, because that would be restricting the type of objects you want to tag. Thus, associable types can only grow and not shrink.

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::set_cardinality

(

)

Sets the given value for 'cardinality' property.

Parameters

cardinality

- New value for the field. The associated cardinality (SINGLE, MULTIPLE) of the category.

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::set_description

(

)

Sets the given value for 'description' property.

Parameters

description

- New value for the field. The description of the category.

Code:

public method Com::Vmware::Cis::Tagging::Category::UpdateSpec::set_name

(

)

Sets the given value for 'name' property.

Parameters

name	- New value for the field. The display name of the category.

Code:

---

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

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