OpenDreams  OD_1.5
Projeto OpenDreams - Openbus
Atributos Públicos
Referência ao interface tecgraf::openbus::DRMAA::JobTemplate

Um Job Template define os atributos necessários a submissão de um job para execução. Mais...

import "drmaa.idl";

Herdado por tecgraf::openbus::opendreams::OpenDreamsJobTemplate.

Mostrar lista completa dos membros

Atributos Públicos

const string HOME_DIRECTORY = "$drmaa_hd_ph$"
 Representa o home directory do usuário. Serve para usar na definição dos paths nos atributos workingDirectory, inputPath, outputPath, e errorPath.
const string WORKING_DIRECTORY = "$drmaa_wd_ph$"
 Representa o diretório corrente de trabalho. Serve para usar na definição dos paths nos atributos inputPath, outputPath e errorPath.
const string PARAMETRIC_INDEX = "$drmaa_incr_ph$"
 Representa o índice paramétrico do job. Serve para usar na definição dos paths nos atributos workingDirectory, inputPath, outputPath, e errorPath.
public string remoteCommand
 O comando a ser executado.
public OrderedStringList args
 Os argumentos command-line para execução do comando.
public JobSubmissionState jobSubmissionState
 O estado do job no momento da submissão.
public Dictionary jobEnvironment
 Valores de variáveis de ambiente para serem usados na máquina de execução. Os valores devem sobreescrever os valores das variáveis no ambiente remoto no caso de haver colisão de nomes. Se não for possível, o comportamento é dependente da implementação do DRMS. Esse atributo não é implementado no OpenDreams.
public string workingDirectory
 Especifica o diretório onde o job é executado. Se esse atributo não estiver configurado, o comportamento é dependente da implementação do DRMS. O valor desse atributo é relativo ao sistema de arquivo na máquina de execução. Esse valor pode usar as constantes HOME_DIRECTORY ou PARAMETRIC_INDEX na sua definição. No caso de iniciar com HOME_DIRECTORY significa que a parte restante é relativa ao diretório home do usuário. A constante PARAMETRIC_INDEX pode ser usada em qualquer posição da definição do diretório e é substituída pelo índice relativo ao job nas execuções paramétricas. Esse atributo não é implementado no OpenDreams.
public string jobCategory
 Define o uso de recursos ou políticas de acordo com categorias de jobs criadas pelo administrador do DRMS. Depende da implementação do DRMS. Os administradores podem criar uma categoria de job adequada para uma aplicação que usa o DRMS. A implementação DRMAA pode usar a categoria especificada no job template para gerenciar recursos e requisitos dos jobs nessa categoria. No OpenDreams, os seguintes valores serão válidos: CSBase ou System. A categoria CSBase identifica a execução de algoritmos do repositório. A categoria System serviria para atender a execução de comandos do sistema, de acordo com o uso comum do DRMAA. Por enquanto, o OpenDreams somente reconhece a categoria CSBase.
public string nativeSpecification
 Define o uso de recursos ou políticas de acordo com o valor passado pelos usuário final do sistema. Depende da implementação do DRMS. Esse atributo não é implementado no OpenDreams.
public StringList email
 Lista de emails usados para notificar o status do job e sua finalização.
public boolean blockEmail
 Indica se o envio de emails deve estar bloqueado, por default. Se o valor for true, o envio de email é bloqueado. Se o valor for false, o envio de email depende da configuração do DRMS.
public string jobName
 Especifica uma data/hora a partir da qual o job pode ser elegível para execução. TODO AINDA NÃO SEI COMO DEFINIR O TIPO. Esse atributo não é implementado no OpenDreams.
public string inputPath
 Especifica como direcionar a entrada padrão para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::inputStream, o arquivo de entrada deve ser recuperado a partir do hostname ou do host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::inputStream, assume-se que o arquivo de entrada sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho. Esse atributo não é implementado no OpenDreams.
public string outputPath
 Especifica como direcionar a saída padrão para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::outputStream, o arquivo de saída deve ser transferido para o hostname especificado ou para o host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::outputStream, assume-se que o arquivo de saída sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. Toda saída enviada para a saída padrão do job deve ser "appended". Se o arquivo não existir no momento da execução do job, ele é criado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho.
public string errorPath
 Especifica como direcionar a saída padrão de erros para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::errorStream, o arquivo de erros deve ser transferido para o hostname especificado ou para o host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::errorStream, assume-se que o arquivo de erros sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. Toda saída enviada para a saída padrão de erros do job deve ser "appended". Se o arquivo não existir no momento da execução do job, ele é criado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho.
public boolean joinFiles
 Indica se a saída de erros padrão deve ser junta com a saída padrão, independente do atributo errorPath ter sido especificado. O default é false.
public FileTransferMode transferFiles
 Especifica se os arquivos de entrada padrão, saída padrão e erro padrão, definidos respectivamente em inputPath, outputPath e errorPath devem ser transferidos tendo como referência o hostname especificado. Se o atributo não for explicitamente atribuído o efeito é o mesmo que usar false em todos os membros do FileTransferMode.
public TimeAmount hardWallClockTimeLimit
 Especifica o tempo limite após o qual o DRMS deve abortar ou terminar o job TODO AINDA NÃO SEI COMO DEFINIR O TIPO. Esse atributo não é implementado no OpenDreams.
public TimeAmount softWallClockTimeLimit
 Especifica uma estimativa de qual seria o tempo de parede limite para o job terminar. É usado para ajudar o escalonamento do job. A implementação pode, por exemplo, aplicar uma penalidade aos jobs que não atenderem esse limite. Esse atributo não é implementado no OpenDreams.
public TimeAmount hardRunDurationLimit
 Especifica o tempo de execução limite após o qual o DRMS deve abortar ou terminar o job. Esse atributo não é implementado no OpenDreams.
public TimeAmount softRunDurationLimit
 Especifica uma estimativa de qual seria o tempo de execução limite para o job terminar. É usado para ajudar o escalonamento no job. A implementação pode, por exemplo, aplicar uma penalidade aos jobs que não atenderem esse limite. Esse atributo não é implementado no OpenDreams.
readonly attribute StringList attributeNames

Descrição detalhada

Um Job Template define os atributos necessários a submissão de um job para execução.

As instâncias de um job template são criadas pela sessão ativa, através do método Session::createJobTemplate(). Uma aplicação DRMAA obtém um job template, altera os valores dos atributos desse job template e o retorna para o serviço na requisição de execução de jobs. Após usar um job template, a aplicação deve chamar o método Session::deleteJobTemplate().

Definido na linha 311 do ficheiro drmaa.idl.


Documentação dos dados membro

Os argumentos command-line para execução do comando.

Definido na linha 339 do ficheiro drmaa.idl.

Especifica a lista dos nomes de atributos definidos no JobTemplate, incluindo os atributos mandatórios e opcionais bem como os atributos específicos da implementação DRMAA.

Definido na linha 525 do ficheiro drmaa.idl.

Indica se o envio de emails deve estar bloqueado, por default. Se o valor for true, o envio de email é bloqueado. Se o valor for false, o envio de email depende da configuração do DRMS.

Definido na linha 397 do ficheiro drmaa.idl.

Lista de emails usados para notificar o status do job e sua finalização.

Definido na linha 391 do ficheiro drmaa.idl.

Especifica como direcionar a saída padrão de erros para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::errorStream, o arquivo de erros deve ser transferido para o hostname especificado ou para o host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::errorStream, assume-se que o arquivo de erros sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. Toda saída enviada para a saída padrão de erros do job deve ser "appended". Se o arquivo não existir no momento da execução do job, ele é criado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho.

Definido na linha 471 do ficheiro drmaa.idl.

Especifica o tempo de execução limite após o qual o DRMS deve abortar ou terminar o job. Esse atributo não é implementado no OpenDreams.

Definido na linha 511 do ficheiro drmaa.idl.

Especifica o tempo limite após o qual o DRMS deve abortar ou terminar o job TODO AINDA NÃO SEI COMO DEFINIR O TIPO. Esse atributo não é implementado no OpenDreams.

Especifica o tempo de parede limite após o qual o DRMS deve abortar ou terminar o job. Esse atributo não é implementado no OpenDreams.

Definido na linha 497 do ficheiro drmaa.idl.

Representa o home directory do usuário. Serve para usar na definição dos paths nos atributos workingDirectory, inputPath, outputPath, e errorPath.

Definido na linha 318 do ficheiro drmaa.idl.

Especifica como direcionar a entrada padrão para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::inputStream, o arquivo de entrada deve ser recuperado a partir do hostname ou do host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::inputStream, assume-se que o arquivo de entrada sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho. Esse atributo não é implementado no OpenDreams.

Definido na linha 429 do ficheiro drmaa.idl.

Define o uso de recursos ou políticas de acordo com categorias de jobs criadas pelo administrador do DRMS. Depende da implementação do DRMS. Os administradores podem criar uma categoria de job adequada para uma aplicação que usa o DRMS. A implementação DRMAA pode usar a categoria especificada no job template para gerenciar recursos e requisitos dos jobs nessa categoria. No OpenDreams, os seguintes valores serão válidos: CSBase ou System. A categoria CSBase identifica a execução de algoritmos do repositório. A categoria System serviria para atender a execução de comandos do sistema, de acordo com o uso comum do DRMAA. Por enquanto, o OpenDreams somente reconhece a categoria CSBase.

Definido na linha 379 do ficheiro drmaa.idl.

Valores de variáveis de ambiente para serem usados na máquina de execução. Os valores devem sobreescrever os valores das variáveis no ambiente remoto no caso de haver colisão de nomes. Se não for possível, o comportamento é dependente da implementação do DRMS. Esse atributo não é implementado no OpenDreams.

Definido na linha 352 do ficheiro drmaa.idl.

Especifica uma data/hora a partir da qual o job pode ser elegível para execução. TODO AINDA NÃO SEI COMO DEFINIR O TIPO. Esse atributo não é implementado no OpenDreams.

O nome de um job, fornecido pelo cliente, deve ser formado de caracteres alfanuméricos e '_'. Esse atributo não é implementado no OpenDreams.

Definido na linha 410 do ficheiro drmaa.idl.

O estado do job no momento da submissão.

Definido na linha 343 do ficheiro drmaa.idl.

Indica se a saída de erros padrão deve ser junta com a saída padrão, independente do atributo errorPath ter sido especificado. O default é false.

Definido na linha 477 do ficheiro drmaa.idl.

Define o uso de recursos ou políticas de acordo com o valor passado pelos usuário final do sistema. Depende da implementação do DRMS. Esse atributo não é implementado no OpenDreams.

Definido na linha 386 do ficheiro drmaa.idl.

Especifica como direcionar a saída padrão para um arquivo. Possui o formato[hostname]:file_path. Se o atributo transferFiles for implementado e possui um valor verdadeiro em FileTransferMode::outputStream, o arquivo de saída deve ser transferido para o hostname especificado ou para o host de submissão se o hostname não for definido. Se o atributo transferFiles não for implementado ou possui um valor falso em FileTransferMode::outputStream, assume-se que o arquivo de saída sempre estará na máquina de execução do job, independente de um hostname ter sido especificado. Toda saída enviada para a saída padrão do job deve ser "appended". Se o arquivo não existir no momento da execução do job, ele é criado. O valor do atributo pode usar o placeholder PARAMETRIC_INDEX em qualquer posição para ser substituído pelo índice paramétrico de execução de um job. O valor do atributo pode usar o placeholder HOME_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório do home do usuário. O valor do atributo pode usar o placeholder WORKING_DIRECTORY no início, indicando que o restante é um caminho relativo ao diretório de trabalho.

Definido na linha 450 do ficheiro drmaa.idl.

Representa o índice paramétrico do job. Serve para usar na definição dos paths nos atributos workingDirectory, inputPath, outputPath, e errorPath.

Definido na linha 331 do ficheiro drmaa.idl.

O comando a ser executado.

Definido na linha 335 do ficheiro drmaa.idl.

Especifica uma estimativa de qual seria o tempo de execução limite para o job terminar. É usado para ajudar o escalonamento no job. A implementação pode, por exemplo, aplicar uma penalidade aos jobs que não atenderem esse limite. Esse atributo não é implementado no OpenDreams.

Definido na linha 519 do ficheiro drmaa.idl.

Especifica uma estimativa de qual seria o tempo de parede limite para o job terminar. É usado para ajudar o escalonamento do job. A implementação pode, por exemplo, aplicar uma penalidade aos jobs que não atenderem esse limite. Esse atributo não é implementado no OpenDreams.

Definido na linha 505 do ficheiro drmaa.idl.

Especifica se os arquivos de entrada padrão, saída padrão e erro padrão, definidos respectivamente em inputPath, outputPath e errorPath devem ser transferidos tendo como referência o hostname especificado. Se o atributo não for explicitamente atribuído o efeito é o mesmo que usar false em todos os membros do FileTransferMode.

Definido na linha 485 do ficheiro drmaa.idl.

Representa o diretório corrente de trabalho. Serve para usar na definição dos paths nos atributos inputPath, outputPath e errorPath.

Definido na linha 324 do ficheiro drmaa.idl.

Especifica o diretório onde o job é executado. Se esse atributo não estiver configurado, o comportamento é dependente da implementação do DRMS. O valor desse atributo é relativo ao sistema de arquivo na máquina de execução. Esse valor pode usar as constantes HOME_DIRECTORY ou PARAMETRIC_INDEX na sua definição. No caso de iniciar com HOME_DIRECTORY significa que a parte restante é relativa ao diretório home do usuário. A constante PARAMETRIC_INDEX pode ser usada em qualquer posição da definição do diretório e é substituída pelo índice relativo ao job nas execuções paramétricas. Esse atributo não é implementado no OpenDreams.

Definido na linha 365 do ficheiro drmaa.idl.


A documentação para este interface foi gerada a partir do seguinte ficheiro:
 Tudo Classes Namespaces Ficheiros Funções Variáveis Definições de tipos Enumerações Valores da enumeração