Classes


The BMC Cloud Lifecycle Management object model is a collection of classes that represents a cloud system and the activities that take place in the cloud. Each class has a unique name and is composed of attributes, relationships, and operations, as illustrated in the following diagram.

class-composition.png

Class name

A class name describes the abstract or concrete cloud object that the class models. A fully-qualified class name is written in the following form:

com.bmc.cloud.model.beans.<ClassName>

To create a fully-qualified class name, concatenate the prefix com.bmc.cloud.model.beans. and the class name. For example, the fully-qualified class name for the VirtualCluster class is:

com.bmc.cloud.model.beans.VirtualCluster

Attributes

Attributes provide state and descriptive information about a cloud object. Each attribute is strongly typed; that is, it has a name and a type. Attributes are usually primitive types such as string, integer, or Boolean, or a simple data structure such as an enumeration.

Relationships

Relationships provide information about connections between cloud objects and enable you to navigate among the objects within your cloud. A relationship can represent:

  • Ownership of another class object
  • Dependence on another class object
  • A reference to another class object

Relationships are strongly typed, and the type is always another class in the API.

Operations

Operations provide actions that you can perform on cloud objects. Each operation has a name and return type. The return type specifies the type of object that will be returned in the HTTP response message JSON document.

Some operations are static operations, which apply to a class rather than a specific object.

The following table describes some typical operations offered by classes in the API. Each class has its own set of available operations and does not provide all the operations listed in the table. Some classes offer unique operations that are not included in this table. The API-reference lists the specific operations offered by each class.

Typical operations

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*