EKM Client API

- Main Page
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Member Functions
com::ansys::ingress::client::api::impl::RsmJobManager Class Reference

RsmJobManager defines the interface for performing job management operations on an EKM server. More...

List of all members.

## Public Member Functions

| RsmJobManager (Ansys.Rsm.EkmPortal.IConnection conn)
| Creates a new instance of RsmJobManager.
| RsmJobManager (ConnectionImpl connectionImpl)
| Creates a new instance of RsmJobManager.
override string | AbortJob (string uniqueCallId, string jobSpaceId, string jobId)
| Abort a job.
override string | CancelCall (string uniqueCallId)
| Attempts to cancel an operation that is in progress.
override string | CompleteCall (string uniqueCallId)
| Signals that a call is complete. Any resources that were being cached in order to support Cancel may be cleaned up.
override IJobSpaceCreationResult | CreateJobSpace (IJobSpaceCreationData data)
| Create a Portal JobObject. Determines if ClientDirectory is visible to RSM. If it not, it generates a working directory for the Portal job.
override bool | CheckClientDirectoryVisibility (IJobSpaceCreationData data)
| Check if client directory is visible.
override void | DownloadFile (string jobSpaceId, string sourceRelativeFilePath, string destinationLocalFilePath, WaitHandle cancelHandle)
| Download a file from a job's working directory to the local computer.
override string | FinalizeJob (string uniqueCallId, string jobSpaceId, string jobId, string finalizeData)
| Finalize a job.
override string | GetClusterConfigurations ()
| Returns a list of all available cluster configurations.
override string | GetClusterConfigurationsWithInformation ()
| Returns information on all cluster configurations.
override string | GetJobInformation (string jobId)
| Get information about a given job.
override string | GetJobLog (string uniqueCallId, string jobSpaceId, string jobId, string getJobLogData)
| Get the job log for a given job.
override string | GetJobStatus (string uniqueCallId, string jobSpaceId, string jobId)
| Get the status of a specific job.
override string | GetQueues (string clusterConfiguration)
| Get information about the queues for a given cluster configuration.
override string | GetRsmVersion ()
| Returns the internal RSM version number. The result is used to verify that the version of RSM the Portal is using is compatible with the local RSM version.
override string | InquireJobByName (string uniqueCallId, string jobSpaceId, string jobId, string inquireData)
| Inquire for some files from a running job using file spec names.
override string | InquireJobByTag (string uniqueCallId, string jobSpaceId, string jobId, string inquireData)
| Inquire for some files from a running job using tag names.
override string | InterruptJob (string uniqueCallId, string jobSpaceId, string jobId)
| Interrupt a job.
override string | ReleaseJob (string uniqueCallId, string jobSpaceId, string jobId, string releaseData)
| Release a job from RSM.
override void | ReleaseJobSpace (string jobSpaceId)
| This method doesn't do anything.
override string | CreateJob (string jobSpaceId, string rsmSubmitData)
| Create an RSM job.
override string | SubmitJob (string uniqueCallId, string jobSpaceId, string rsmPersistedJobId, string rsmSubmitData, IPortalSubmitData portalSubmitData)
| Submit a job to RSM.
override void | UploadFile (string jobSpaceId, string sourceLocalFilePath, string destinationRelativeFilePath, WaitHandle cancelHandle)
| Upload a file from the local computer to a job's working directory.
Connection | getConnection ()
| A helper method to get the current Connection object.
override string | GetConfiguredQueues ()
| Get information about the configured queues.
override string | GetAllJobInformation ()
| Get information about all jobs.
override string | GetJobConclusionInformation (string jobSpaceId, string jobId)
| Gets information about a job after the job has completed.
override string | GetJobs (string data)
| Gets job ids.
override string | PerformDiagnosticOperation (string uniqueCallId, string diagnosticOperationType, string diagnosticOperationData)
| Performs a diagnostic operation.
override string | GetJobStatuses (string uniqueCallId, string jobIdList, bool shallowQuery)
| Get the statuses for a set of jobs.
override string | AddLogMessages (string jobSpaceId, string jobId, int msgType, string messageList)
| Add messages to the RSM log.

## Detailed Description

RsmJobManager defines the interface for performing job management operations on an EKM server.

## Constructor & Destructor Documentation

com::ansys::ingress::client::api::impl::RsmJobManager::RsmJobManager | ( | Ansys.Rsm.EkmPortal.IConnection | conn | ) | `[inline]`

Creates a new instance of RsmJobManager.

Parameters:

  conn | The Connection associated with this JobManager

com::ansys::ingress::client::api::impl::RsmJobManager::RsmJobManager | ( | ConnectionImpl | connectionImpl | ) | `[inline]`

Creates a new instance of RsmJobManager.

Parameters:

  connectionImpl | The Connection associated with this JobManager

## Member Function Documentation

override string com::ansys::ingress::client::api::impl::RsmJobManager::AbortJob | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId
| ) |  | `[inline]`

Abort a job.

Parameters:

  uniqueCallId |
  jobSpaceId | The Portal job id: the JobObject repository path
  jobId | The RSM job id

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::AddLogMessages | ( | string | jobSpaceId,
|  | string | jobId,
|  | int | msgType,
|  | string | messageList
| ) |  | `[inline]`

Add messages to the RSM log.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  msgType | a value from the LogMessageType enumeration
  messageList | Serialized list of message strings.

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::CancelCall | ( | string | uniqueCallId | ) | `[inline]`

Attempts to cancel an operation that is in progress.

Parameters:

  uniqueCallId | unique id that identifies the method call

Returns:

override bool com::ansys::ingress::client::api::impl::RsmJobManager::CheckClientDirectoryVisibility | ( | IJobSpaceCreationData | data | ) | `[inline]`

Check if client directory is visible.

Parameters:

  data | JobSpaceCreationData which includes the following:
  - ClientDirectory - The full path to the location of the client directory where job files are located
  - MarkerName - The name of a marker file used to identify the clientDirectory
  - JobName - The requested name for the job (not actually used so may be null)
  - AssociatedUncPathsForClientDirectory - collection of UNC paths associated with ClientDirectory

Returns:
  true if marker is found

override string com::ansys::ingress::client::api::impl::RsmJobManager::CompleteCall | ( | string | uniqueCallId | ) | `[inline]`

Signals that a call is complete. Any resources that were being cached in order to support Cancel may be cleaned up.

Parameters:

  uniqueCallId | unique id that identifies the method call

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::CreateJob | ( | string | jobSpaceId,
|  | string | rsmSubmitData
| ) |  | `[inline]`

Create an RSM job.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  rsmSubmitData | Serialized data intended for RSM use only: RsmSubmitData. Contains information used to run the job - ClientDirectory, Queue, etc.

Returns:
  The RSM job id of the created job

override IJobSpaceCreationResult com::ansys::ingress::client::api::impl::RsmJobManager::CreateJobSpace | ( | IJobSpaceCreationData | data | ) | `[inline]`

Create a Portal JobObject. Determines if ClientDirectory is visible to RSM. If it not, it generates a working directory for the Portal job.

This is the first step in submitting a job.

Parameters:

  data | JobSpaceCreationData which includes the following:
  - ClientDirectory - The full path to the location of the client directory where job files are located
  - MarkerName - The name of a marker file used to identify the clientDirectory
  - JobName - The requested name for the job (may append a timestamp to name)
  - AssociatedUncPathsForClientDirectory - collection of UNC paths associated with ClientDirectory

Returns:
  IJobSpaceCreationResult cotaining the JobSpaceId - see JobSpaceCreationResult

override void com::ansys::ingress::client::api::impl::RsmJobManager::DownloadFile | ( | string | jobSpaceId,
|  | string | sourceRelativeFilePath,
|  | string | destinationLocalFilePath,
|  | WaitHandle | cancelHandle
| ) |  | `[inline]`

Download a file from a job's working directory to the local computer.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  sourceRelativeFilePath | A relative path inside the job's working directory for the desired file
  destinationLocalFilePath | The path on the local computer to download to
  cancelHandle | Not used

override string com::ansys::ingress::client::api::impl::RsmJobManager::FinalizeJob | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId,
|  | string | finalizeData
| ) |  | `[inline]`

Finalize a job.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  finalizeData |

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetAllJobInformation | ( |  | ) | `[inline]`

Get information about all jobs.

Returns:
  a string containing information for all jobs

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetClusterConfigurations | ( |  | ) | `[inline]`

Returns a list of all available cluster configurations.

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetClusterConfigurationsWithInformation | ( |  | ) | `[inline]`

Returns information on all cluster configurations.

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetConfiguredQueues | ( |  | ) | `[inline]`

Get information about the configured queues.

Returns:
  Serialized collection of ConfiguredQueue

Connection com::ansys::ingress::client::api::impl::RsmJobManager::getConnection | ( |  | ) | `[inline]`

A helper method to get the current Connection object.

Returns:
  the current Connection object

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobConclusionInformation | ( | string | jobSpaceId,
|  | string | jobId
| ) |  | `[inline]`

Gets information about a job after the job has completed.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id

Returns:
  a string containing conclusion information about the specified job

This method must be used after FinalizeJob has been called and before ReleaseJob is called

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobInformation | ( | string | jobId | ) | `[inline]`

Get information about a given job.

Parameters:

  jobId | The RSM job id

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobLog | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId,
|  | string | getJobLogData
| ) |  | `[inline]`

Get the job log for a given job.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  getJobLogData |

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobs | ( | string | data | ) | `[inline]`

Gets job ids.

Parameters:

  data |

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobStatus | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId
| ) |  | `[inline]`

Get the status of a specific job.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id

Returns:
  serialized JobState string containing the JobStatus.

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetJobStatuses | ( | string | uniqueCallId,
|  | string | jobIdList,
|  | bool | shallowQuery
| ) |  | `[inline]`

Get the statuses for a set of jobs.

Parameters:

  uniqueCallId |
  jobIdList |
  shallowQuery |

Returns:
  serialized collection of the job state for each job containing JobStatus

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetQueues | ( | string | clusterConfiguration | ) | `[inline]`

Get information about the queues for a given cluster configuration.

Parameters:

  clusterConfiguration |

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::GetRsmVersion | ( |  | ) | `[inline]`

Returns the internal RSM version number. The result is used to verify that the version of RSM the Portal is using is compatible with the local RSM version.

Returns:
  a string containing the version number of RSM

override string com::ansys::ingress::client::api::impl::RsmJobManager::InquireJobByName | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId,
|  | string | inquireData
| ) |  | `[inline]`

Inquire for some files from a running job using file spec names.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  inquireData | Serialized collection of file name specs

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::InquireJobByTag | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId,
|  | string | inquireData
| ) |  | `[inline]`

Inquire for some files from a running job using tag names.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  inquireData | Serialized collection of tag names

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::InterruptJob | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId
| ) |  | `[inline]`

Interrupt a job.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::PerformDiagnosticOperation | ( | string | uniqueCallId,
|  | string | diagnosticOperationType,
|  | string | diagnosticOperationData
| ) |  | `[inline]`

Performs a diagnostic operation.

Parameters:

  uniqueCallId |
  diagnosticOperationType |
  diagnosticOperationData |

Returns:

override string com::ansys::ingress::client::api::impl::RsmJobManager::ReleaseJob | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | jobId,
|  | string | releaseData
| ) |  | `[inline]`

Release a job from RSM.

releaseData determines if release is immediate or delayed

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  jobId | The RSM job id
  releaseData | serialized ReleaseData with booleans JobFinalized and Immediate

Returns:

override void com::ansys::ingress::client::api::impl::RsmJobManager::ReleaseJobSpace | ( | string | jobSpaceId | ) | `[inline]`

This method doesn't do anything.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .

override string com::ansys::ingress::client::api::impl::RsmJobManager::SubmitJob | ( | string | uniqueCallId,
|  | string | jobSpaceId,
|  | string | rsmPersistedJobId,
|  | string | rsmSubmitData,
|  | IPortalSubmitData | portalSubmitData
| ) |  | `[inline]`

Submit a job to RSM.

Parameters:

  uniqueCallId |
  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  rsmPersistedJobId | The RSM job id
  rsmSubmitData | Serialized data intended for RSM use only: RsmSubmitData. Contains information used to run the job - ClientDirectory, Queue, etc.
  portalSubmitData | Data that the Portal requires for submission to RSM: PortalSubmitData.
  - JobSpaceId
  - JobType - job type. e.g., Workbench_FLUENT or Workbench_DESIGNPOINT
  - SolverTranscriptFileSearchPatterns
  - Cores
  - Queue

Returns:
  The RSM job id of the submitted job

override void com::ansys::ingress::client::api::impl::RsmJobManager::UploadFile | ( | string | jobSpaceId,
|  | string | sourceLocalFilePath,
|  | string | destinationRelativeFilePath,
|  | WaitHandle | cancelHandle
| ) |  | `[inline]`

Upload a file from the local computer to a job's working directory.

Parameters:

  jobSpaceId | Portal job id.
  See also:
    CreateJobSpace
  .
  sourceLocalFilePath | the path of the local file to upload
  destinationRelativeFilePath | the relative path inside the job's working directory to upload to
  cancelHandle | not used

The documentation for this class was generated from the following file:

- RsmJobManager.cs

All Classes Namespaces Functions Variables Enumerations Properties