Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Policy class


The Policy class represents a placement policy.

Policy class APIs

The following tables list the basic APIs, operation APIs, and relationship APIs for the Policy class.

Basic APIs

Name

HTTP
method

URI

Description

create

POST

Creates a Policy object.

delete

DELETE

Deletes a Policy object.

get

GET

Retrieves a Policy object.

update

POST

Updates a Policy object.

search

POST

Searches for Policy objects.

Operation APIs

The Policy class has no operation APIs.

Relationship APIs

Name

HTTP
method

URI

Description

relation

GET

Retrieves the policyCategory relationship.

relation

GET

Retrieves the policyType relationship.

relation

GET

Retrieves the provider relationship.

relation

GET

Retrieves the tags relationship.

Policy class relationships and attributes

The following tables list the relationships and attributes of the Policy class.

Relationships

Name

Type

Multi-
plicity

Description

policyCategory

1

The category the policy is in

policyType

1

Type of policy

cloudClass

1

Fully-qualified name of the class to which the object belongs

provider

1

Provider that created the object

tags

0..*

Tags associated with the object

Attributes

Name

Type

Multi-
plicity

Description

content
String

1

Content of the policy

isInference
Boolean

1

Indicates whether the policy is an inference

lifecycleStage
String

1

Lifecycle stage that the policy applies to

rulesCombinator
String

0..1

Rules combinator

version
String

0..1

Policy version

description
String

0..1

Text that describes the object

guid
String

1

Globally unique identifier for the object

labels
String

0..*

 

modifiedDate

0..1

Date the Cloudobject was modified

name
String

1

Human-readable name of the object

 

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