Sinisa Susnjar > CA-AutoSys-1.05 > CA::AutoSys::Status

Download:
CA-AutoSys-1.05.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 1.03   Source  

NAME ^

CA::AutoSys::Status - Object representing an AutoSys job status.

CLASS METHODS ^

format_status()

    my $status_string = $status->format_status($status->{status}) ;

Returns a two character string that represents the status like the AutoSys 'autorep' tool.

format_time()

    my $time_string = $status->format_time($status->{last_start}) ;

Returns a time string that looks like the one from AutoSys' 'autorep' tool.

INSTANCE VARIABLES ^

last_start

    print "last_start: ".$status->{last_start}."\n";

Contains the time when the job was last started or 999999999 (CA's equivalent for never). Time is measured in non leap seconds since the epoch, i.e. like the return value of perl's time() function.

last_end

    print "last_end: ".$status->{last_end}."\n";

Contains the time when the job last ended or 999999999 (CA's equivalent for never). Time is measured in non leap seconds since the epoch, i.e. like the return value of perl's time() function.

status

    print "status: ".$status->{status}."\n";

Contains an integer value that represents the status of the job. The various integer values are mapped to these constants:

    NONE        = 0
    RUNNING     = 1
    UNDEF_2     = 2
    STARTING    = 3
    SUCCESS     = 4
    FAILURE     = 5
    TERMINATED  = 6
    ON_ICE      = 7
    INACTIVE    = 8
    ACTIVATED   = 9
    RESTART     = 10
    ON_HOLD     = 11
    QUEUE_WAIT  = 12
    UNDEF_13    = 13
    REFRESH_DEP = 14
    REFRESH_FW  = 15

status_time

    print "status_time: ".$status->{status_time}."\n";

Contains the time of the last status change or 999999999 (CA's equivalent for never). Time is measured in non leap seconds since the epoch, i.e. like the return value of perl's time() function.

name

    print "status name: ".$status->{name}."\n";

Contains the long name of the appropriate integer value that represents the status of the job. Can be used instead of the more cryptic output of the "format_status() " method. The various integer values are mapped to these constants:

    "NONE"        = 0
    "RUNNING"     = 1
    "UNDEF_2"     = 2
    "STARTING"    = 3
    "SUCCESS"     = 4
    "FAILURE"     = 5
    "TERMINATED"  = 6
    "ON_ICE"      = 7
    "INACTIVE"    = 8
    "ACTIVATED"   = 9
    "RESTART"     = 10
    "ON_HOLD"     = 11
    "QUEUE_WAIT"  = 12
    "UNDEF_13"    = 13
    "REFRESH_DEP" = 14
    "REFRESH_FW"  = 15

run_num

    print "run_num: ".$status->{run_num}."\n";

Contains an integer value that shows an AutoSys internal run number. It is currently only used to be output-compatible with CA's 'autorep' tool.

ntry

    print "ntry: ".$status->{ntry}."\n";

Contains an integer that shows how often the run of the job has been retried by AutoSys.

exit_code

    print "exit_code: ".$status->{exit_code}."\n";

Contains the last exit code of the job.

SEE ALSO ^

CA::AutoSys::Job, CA::AutoSys

AUTHOR ^

Sinisa Susnjar <sini@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (c) 2007 Sinisa Susnjar. All rights reserved.

This program is free software; you can use and redistribute it under the terms of the L-GPL. See the LICENSE file for details.

syntax highlighting: