PingAM

Caches

Realm Operations

The caches that the Cache Manager Service will manage.

Resource path:

/realm-config/services/cache-manager/caches

Resource version: 0.0

create

Usage

am> create Caches --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "durationUnit" : {
      "title" : "Duration Unit",
      "description" : "The unit of time that will be used for the duration settings, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPolicy" : {
      "title" : "Eviction Policy",
      "description" : "The eviction policy that will be used to determine when to remove or reload entries from the cache.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Loading Script",
      "description" : "The script that will be used to load cache entries.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPeriod" : {
      "title" : "Eviction Period",
      "description" : "The period of time after which entries will be evicted or reloaded from the cache, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 400,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete Caches --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action Caches --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action Caches --realm Realm --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action Caches --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query Caches --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read Caches --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update Caches --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "durationUnit" : {
      "title" : "Duration Unit",
      "description" : "The unit of time that will be used for the duration settings, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPolicy" : {
      "title" : "Eviction Policy",
      "description" : "The eviction policy that will be used to determine when to remove or reload entries from the cache.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Loading Script",
      "description" : "The script that will be used to load cache entries.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPeriod" : {
      "title" : "Eviction Period",
      "description" : "The period of time after which entries will be evicted or reloaded from the cache, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 400,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    }
  }
}

Global Operations

The caches that the Cache Manager Service will manage.

Resource path:

/global-config/services/cache-manager/caches

Resource version: 1.0

create

Usage

am> create Caches --global --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "evictionPeriod" : {
      "title" : "Eviction Period",
      "description" : "The period of time after which entries will be evicted or reloaded from the cache, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 400,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Loading Script",
      "description" : "The script that will be used to load cache entries.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPolicy" : {
      "title" : "Eviction Policy",
      "description" : "The eviction policy that will be used to determine when to remove or reload entries from the cache.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "durationUnit" : {
      "title" : "Duration Unit",
      "description" : "The unit of time that will be used for the duration settings, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    }
  }
}

delete

Usage

am> delete Caches --global --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action Caches --global --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action Caches --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action Caches --global --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query Caches --global --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read Caches --global --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update Caches --global --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "evictionPeriod" : {
      "title" : "Eviction Period",
      "description" : "The period of time after which entries will be evicted or reloaded from the cache, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 400,
      "required" : true,
      "type" : "integer",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Loading Script",
      "description" : "The script that will be used to load cache entries.",
      "propertyOrder" : 100,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "evictionPolicy" : {
      "title" : "Eviction Policy",
      "description" : "The eviction policy that will be used to determine when to remove or reload entries from the cache.",
      "propertyOrder" : 200,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    },
    "durationUnit" : {
      "title" : "Duration Unit",
      "description" : "The unit of time that will be used for the duration settings, ignored if the eviction policy is set to Never.",
      "propertyOrder" : 300,
      "required" : true,
      "type" : "string",
      "exampleValue" : ""
    }
  }
}