Command Usage: sam v8_1_5 sam delete request
|  |
Command Description:
Delete an existing request id.
Usage:
sam delete request <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--requestId=<value> # Id of the request to be deleted
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--definitionId=<value> # DB ID number of the dataset definition to be used to create the project file list
--definitionName=<value> # name of the dataset definition to be used to create the project file list
--retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
--retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
--retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
--snapshotId=<value> # DB ID number of an existing snapshot to be used as the project file list
--snapshotName=<value> # name of an existing snapshot to be used as the project file list
--snapshotVersion=<value> # "new", "last", or an existing snapshot version taken with the specified dataset definition
-flags:
-c # automatically close all servants after each method call
-d # debug mode
-s # retrySilently mode (do not issue messages to stderr on proxy retries)
-t # time-it mode (print additional info on timings)
-v # verbose mode
Synonymous Options:
--def-id=<value> # synonym for --definitionId=<value>
--def-name=<value> # synonym for --definitionName=<value>
--defid=<value> # synonym for --definitionId=<value>
--defname=<value> # synonym for --definitionName=<value>
--snap-id=<value> # synonym for --snapshotId=<value>
--snap-name=<value> # synonym for --snapshotName=<value>
--snap-ver=<value> # synonym for --snapshotVersion=<value>
--snap-version=<value> # synonym for --snapshotVersion=<value>
--snapid=<value> # synonym for --snapshotId=<value>
--snapname=<value> # synonym for --snapshotName=<value>
--snapver=<value> # synonym for --snapshotVersion=<value>
--snapversion=<value> # synonym for --snapshotVersion=<value>
Mutually Exclusive Options:
--definitionName=<value> OR --definitionId=<value>
--snapshotName=<value> OR --snapshotId=<value>
--snapshotName=<value> OR --snapshotVersion=<value>
Incompatible Option Combinations:
[definitionName, definitionId, snapshotVersion] OR [snapshotName, snapshotId]
Required Data Types:
corbaCallTimeout : int
definitionId : long
definitionName : string
requestId : long
retryInterval : int
retryJitter : int
retryMaxCount : int
snapshotId : long
snapshotName : string
snapshotVersion : SnapshotVersion
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: