GetActivity Method

Retrieves detailed information about a single High Performance Computing (HPC) Activity, including the status of this Activity.

Syntax

Visual Basic (Declaration)
Visual Basic (Usage)
C#

Public Function GetActivity( _
   ByVal request As GetActivityRequest _
) As GetActivityResponse

Dim instance As ActivityManagementServiceClient
Dim request As GetActivityRequest
Dim value As GetActivityResponse
 
value = instance.GetActivity(request)

public GetActivityResponse GetActivity( 
   GetActivityRequest request
)

Parameters

request: Contains a GetActivityRequest that identifies the software-generated Activity Sequential Identifier (SID) of the HPC Activity for which you want to retrieve detailed status and other information, along with the associated Business Unit SID and SQL Instance SID.
You can find the ActivitySid by looking at the response that the software returns for asynchronous web service calls, such as for the SubmitCreateDatabase() or SubmitDeleteProject() method.

Return Value

A GetActivityResponse containing the detailed information about the specified Activity, including the status of the specified Activity.

Remarks

To find the Business Unit SID to pass into this method, call the GetBusinessUnits() method.

To find the SQL Instance SID to pass into this method, call the GetSqlInstances() method.

Example

The following example shows how to retrieve detailed information about an HPC Activity, including the status of the Activity, using the GetActivity() method:

using System;
using AIR.Services.ActivityManagement.Api;
using AIR.Services.ActivityManagement.Data;
using AIR.Services.Common.Data;
            
class SnippetGetActivityRequest
{
    private static void GetActivity(int businessUnitSid, int sqlInstanceSid, int activitySid)
    {
        ActivityManagementServiceClient activityClient = new ActivityManagementServiceClient();
        GetActivityRequest request = new GetActivityRequest();
        request.BusinessUnitSid = businessUnitSid;
        request.SqlInstanceSid = sqlInstanceSid;
        request.ActivitySid = activitySid;
        GetActivityResponse response = activityClient.GetActivity(request);
        if (response.Status.Code == StatusCode.Success)
        {
            Console.WriteLine("Code: " + response.Activity.Status.Code.ToString());
            Console.WriteLine("Message: " + response.Activity.Status.Message);
            Console.WriteLine("Percent Complete: " + response.Activity.Status.PercentComplete + "%");
            foreach (ActivityInfo subActivity in response.Activity.SubActivities)
            {
                Console.WriteLine("Subactivity SID: " + subActivity.Sid.ToString());
                Console.WriteLine("Subactivity Name: " + subActivity.Name.ToString());
                Console.WriteLine("Subactivity Status Code: " + subActivity.Status.Code.ToString());
                Console.WriteLine("Subactivity Message: " + subActivity.Status.Message);
                Console.WriteLine("Subactivity Percent Complete: " + subActivity.Status.PercentComplete + "%");
                Console.WriteLine("Subactivity Analysis SID: " + subActivity.AnalysisSid);
            }
        }
    }
}

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

ActivityManagementServiceClient Class
ActivityManagementServiceClient Members