REST Resource: folders.capabilityConfigs

Resource: CapabilityConfig

A CapabilityConfig allows managing experiences like applications and agents on a logical administrative perimeter of Projects (Boundary).

JSON representation
{
  "name": string,
  "displayName": string,
  "types": [
    enum (Type)
  ],
  "managementProject": string,
  "boundaries": [
    string
  ],
  "state": enum (State),
  "etag": string,
  "createTime": string,
  "updateTime": string
}
Fields
name

string

Identifier. The unique resource name of the CapabilityConfig. Format: organizations/{organization}/capabilityConfigs/{capabilityConfig} or, folders/{folder}/capabilityConfigs/{capabilityConfig} or, projects/{project}/capabilityConfigs/{capabilityConfig}

displayName

string

Optional. Human-readable non-unique display name of the CapabilityConfig. When present it must be between 4 to 30 characters. Allowed characters are: lowercase and uppercase letters, numbers, hyphen, single-quote, double-quote, space, and exclamation point. Example: My CapabilityConfig

types[]

enum (Type)

Required. The CapabilityConfig types.

managementProject

string

Optional. Immutable. The Management Project associated with this CapabilityConfig. If not provided during creation, a management project will be automatically created. Cannot be modified after creation. Format: projects/{projectNumber} Example: projects/123456789012

boundaries[]

string

Optional. The list of Boundaries associated with this CapabilityConfig. Format: organizations/{organization}/boundaries/{boundary} or, folders/{folder}/boundaries/{boundary} or, projects/{project}/boundaries/{boundary}

state

enum (State)

Output only. The lifecycle state of the CapabilityConfig.

etag

string

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

createTime

string (Timestamp format)

Output only. The creation time of the CapabilityConfig.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The most recent time this CapabilityConfig was modified.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

Type

Types of a CapabilityConfig.

Enums
TYPE_UNSPECIFIED Unspecified type.
APP_MANAGEMENT For AppHub applications.
AGENT_MANAGEMENT For Agent Registry.

State

Lifecycle states.

Enums
STATE_UNSPECIFIED Unspecified state.
ACTIVE CapabilityConfig is operational, and the management project is fully active.

Methods

create

Creates a CapabilityConfig under a parent Organization, Folder or Project.

delete

Deletes the CapabilityConfig identified by the specified name (for example, folders/123456789/capabilityConfigs/my-capability-config).

get

Retrieves the CapabilityConfig identified by the specified name (for example, folders/123456789/capabilityConfigs/my-capability-config).

list

Lists CapabilityConfigs that are direct children of the specified organization, folder or project resource.

patch

Updates the display_name, types and boundaries of the CapabilityConfig identified by the specified name (for example, folders/123456789/capabilityConfigs/my-capability-config).