rw-staging-mgmt - User documentation

Schema Globals

Global Schema Type	rw_ypbc_RwStagingMgmt_RwStagingMgmt_t_schema
Global Schema Pointer	rw_ypbc_RwStagingMgmt_RwStagingMgmt_g_schema

rw-staging-mgmt data

rw-staging-mgmt:staging-areas

Staging Areas

Key Identifiers:

XPath Path	/rw-staging-mgmt:staging-areas
XPath Keyed Path	/rw-staging-mgmt:staging-areas
RW.REST URI Path	/rw-staging-mgmt:staging-areas

Fields

Name	Type	Description
staging-area	LIST

JSON Sample

{
  "staging-area": [
    {
      "area-id": "STRING",
      "package-type": "NSD",
      "name": "STRING",
      "validity-time": 3600,
      "status": "LIVE",
      "created-time": 0,
      "deleted-time": 0,
      "size": 0,
      "path": "STRING"
    }, {
      ...
    }
  ]
}

XML Sample

<rw-staging-mgmt:staging-areas xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
  <rw-staging-mgmt:staging-area>
    <rw-staging-mgmt:area-id>STRING</rw-staging-mgmt:area-id>
    <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
    <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
    <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
    <rw-staging-mgmt:status>LIVE</rw-staging-mgmt:status>
    <rw-staging-mgmt:created-time>0</rw-staging-mgmt:created-time>
    <rw-staging-mgmt:deleted-time>0</rw-staging-mgmt:deleted-time>
    <rw-staging-mgmt:size>0</rw-staging-mgmt:size>
    <rw-staging-mgmt:path>STRING</rw-staging-mgmt:path>
  </rw-staging-mgmt:staging-area>
</rw-staging-mgmt:staging-areas>

rw-staging-mgmt:staging-area

Key Identifiers:

XPath Path

/rw-staging-mgmt:staging-areas/rw-staging-mgmt:staging-area

XPath Keyed Path

/rw-staging-mgmt:staging-areas/rw-staging-mgmt:staging-area[rw-staging-mgmt:area-id='STRING']

RW.REST URI Path

/rw-staging-mgmt:staging-areas/staging-area/STRING

Fields

Name	Type	Description
area-id	STRING	Staging Area ID
package-type	ENUM
name	STRING	name of the binary
validity-time	UINT64	lifetime of the staging area (in seconds)
status	ENUM	The status of the staging area
created-time	UINT32	start time (unix epoch)
deleted-time	UINT32	stop time (unix epoch)
size	UINT64	size of the binary in bytes
path	STRING	Path of the staging area

JSON Sample

[
  {
    "area-id": "STRING",
    "package-type": "NSD",
    "name": "STRING",
    "validity-time": 3600,
    "status": "LIVE",
    "created-time": 0,
    "deleted-time": 0,
    "size": 0,
    "path": "STRING"
  }, {
    ...
  }
]

XML Sample

<rw-staging-mgmt:staging-area xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
  <rw-staging-mgmt:area-id>STRING</rw-staging-mgmt:area-id>
  <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
  <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
  <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
  <rw-staging-mgmt:status>LIVE</rw-staging-mgmt:status>
  <rw-staging-mgmt:created-time>0</rw-staging-mgmt:created-time>
  <rw-staging-mgmt:deleted-time>0</rw-staging-mgmt:deleted-time>
  <rw-staging-mgmt:size>0</rw-staging-mgmt:size>
  <rw-staging-mgmt:path>STRING</rw-staging-mgmt:path>
</rw-staging-mgmt:staging-area>

rw-staging-mgmt rpc input

rw-staging-mgmt:create-staging-area

Key Identifiers:

XPath Path	/rw-staging-mgmt:create-staging-area
XPath Keyed Path	/rw-staging-mgmt:create-staging-area
RW.REST URI Path	/input

Fields

Name	Type	Description
package-type	ENUM
name	STRING	name of the binary
validity-time	UINT64	lifetime of the staging area (in seconds)

JSON Sample

{
  "package-type": "NSD",
  "name": "STRING",
  "validity-time": 3600
}

XML Sample

<rw-staging-mgmt:input xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
  <rw-staging-mgmt:package-type>NSD</rw-staging-mgmt:package-type>
  <rw-staging-mgmt:name>STRING</rw-staging-mgmt:name>
  <rw-staging-mgmt:validity-time>3600</rw-staging-mgmt:validity-time>
</rw-staging-mgmt:input>

rw-staging-mgmt rpc output

rw-staging-mgmt:create-staging-area

Key Identifiers:

XPath Path	/rw-staging-mgmt:create-staging-area
XPath Keyed Path	/rw-staging-mgmt:create-staging-area
RW.REST URI Path	/output

Fields

Name	Type	Description
port	UINT32
endpoint	STRING	Endpoint that contains all the package-related data

JSON Sample

{
  "port": 0,
  "endpoint": "STRING"
}

XML Sample

<rw-staging-mgmt:output xmlns:rw-staging-mgmt="http://riftio.com/ns/riftware-1.0/rw-staging-mgmt">
  <rw-staging-mgmt:port>0</rw-staging-mgmt:port>
  <rw-staging-mgmt:endpoint>STRING</rw-staging-mgmt:endpoint>
</rw-staging-mgmt:output>