JobSchedule class
Classe que representa um JobSchedule.
Construtores
| Job |
Crie um JobSchedule. |
Métodos
Detalhes do construtor
JobSchedule(BatchServiceClientContext)
Crie um JobSchedule.
new JobSchedule(client: BatchServiceClientContext)Parâmetros
- client
- BatchServiceClientContext
Referência ao cliente de serviço.
Detalhes do método
add(JobScheduleAddParameter, JobScheduleAddOptionalParams)
function add(cloudJobSchedule: JobScheduleAddParameter, options?: JobScheduleAddOptionalParams): Promise<JobScheduleAddResponse>Parâmetros
- cloudJobSchedule
- JobScheduleAddParameter
O Agendamento de Trabalho a ser adicionado.
- options
- JobScheduleAddOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleAddResponse>
< Promise>Models.JobScheduleAddResponse
add(JobScheduleAddParameter, JobScheduleAddOptionalParams, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, options: JobScheduleAddOptionalParams, callback: ServiceCallback<void>)Parâmetros
- cloudJobSchedule
- JobScheduleAddParameter
O Agendamento de Trabalho a ser adicionado.
- options
- JobScheduleAddOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
add(JobScheduleAddParameter, ServiceCallback<void>)
function add(cloudJobSchedule: JobScheduleAddParameter, callback: ServiceCallback<void>)Parâmetros
- cloudJobSchedule
- JobScheduleAddParameter
O Agendamento de Trabalho a ser adicionado.
- callback
-
ServiceCallback<void>
O retorno de chamada
deleteMethod(string, JobScheduleDeleteMethodOptionalParams)
Quando você exclui um Agendamento de Trabalho, isso também exclui todos os Trabalhos e Tarefas nesse agendamento. Quando tarefas são excluídas, todos os arquivos em seus diretórios de trabalho nos Nós de Computação também são excluídos (o período de retenção é ignorado). As estatísticas de Agendamento de Trabalho não estarão mais acessíveis depois que a Agenda de Trabalho é excluída, embora ainda sejam contadas para estatísticas de tempo de vida da conta.
function deleteMethod(jobScheduleId: string, options?: JobScheduleDeleteMethodOptionalParams): Promise<JobScheduleDeleteResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser excluída.
Os parâmetros opcionais
Retornos
Promise<JobScheduleDeleteResponse>
< Promise>Models.JobScheduleDeleteResponse
deleteMethod(string, JobScheduleDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, options: JobScheduleDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser excluída.
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
deleteMethod(string, ServiceCallback<void>)
function deleteMethod(jobScheduleId: string, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser excluída.
- callback
-
ServiceCallback<void>
O retorno de chamada
disable(string, JobScheduleDisableOptionalParams)
Nenhum novo Trabalho será criado até que o Agendamento de Trabalhos seja habilitado novamente.
function disable(jobScheduleId: string, options?: JobScheduleDisableOptionalParams): Promise<JobScheduleDisableResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser desabilitada.
- options
- JobScheduleDisableOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleDisableResponse>
< Promise>Models.JobScheduleDisableResponse
disable(string, JobScheduleDisableOptionalParams, ServiceCallback<void>)
function disable(jobScheduleId: string, options: JobScheduleDisableOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser desabilitada.
- options
- JobScheduleDisableOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
disable(string, ServiceCallback<void>)
function disable(jobScheduleId: string, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser desabilitada.
- callback
-
ServiceCallback<void>
O retorno de chamada
enable(string, JobScheduleEnableOptionalParams)
function enable(jobScheduleId: string, options?: JobScheduleEnableOptionalParams): Promise<JobScheduleEnableResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser habilitada.
- options
- JobScheduleEnableOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleEnableResponse>
Prometer<Models.JobScheduleEnableResponse>
enable(string, JobScheduleEnableOptionalParams, ServiceCallback<void>)
function enable(jobScheduleId: string, options: JobScheduleEnableOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser habilitada.
- options
- JobScheduleEnableOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
enable(string, ServiceCallback<void>)
function enable(jobScheduleId: string, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser habilitada.
- callback
-
ServiceCallback<void>
O retorno de chamada
exists(string, JobScheduleExistsOptionalParams)
function exists(jobScheduleId: string, options?: JobScheduleExistsOptionalParams): Promise<JobScheduleExistsResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho que você deseja verificar.
- options
- JobScheduleExistsOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleExistsResponse>
Promessa<Models.JobScheduleExistsResponse>
exists(string, JobScheduleExistsOptionalParams, ServiceCallback<boolean>)
function exists(jobScheduleId: string, options: JobScheduleExistsOptionalParams, callback: ServiceCallback<boolean>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho que você deseja verificar.
- options
- JobScheduleExistsOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<boolean>
O retorno de chamada
exists(string, ServiceCallback<boolean>)
function exists(jobScheduleId: string, callback: ServiceCallback<boolean>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho que você deseja verificar.
- callback
-
ServiceCallback<boolean>
O retorno de chamada
get(string, JobScheduleGetOptionalParams)
Obtém informações sobre o Agendamento de Trabalho especificado.
function get(jobScheduleId: string, options?: JobScheduleGetOptionalParams): Promise<JobScheduleGetResponse>Parâmetros
- jobScheduleId
-
string
A ID do Agendamento de Trabalho a ser obtido.
- options
- JobScheduleGetOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleGetResponse>
< Promise>Models.JobScheduleGetResponse
get(string, JobScheduleGetOptionalParams, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, options: JobScheduleGetOptionalParams, callback: ServiceCallback<CloudJobSchedule>)Parâmetros
- jobScheduleId
-
string
A ID do Agendamento de Trabalho a ser obtido.
- options
- JobScheduleGetOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
get(string, ServiceCallback<CloudJobSchedule>)
function get(jobScheduleId: string, callback: ServiceCallback<CloudJobSchedule>)Parâmetros
- jobScheduleId
-
string
A ID do Agendamento de Trabalho a ser obtido.
- callback
O retorno de chamada
list(JobScheduleListOptionalParams)
function list(options?: JobScheduleListOptionalParams): Promise<JobScheduleListResponse>Parâmetros
- options
- JobScheduleListOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleListResponse>
< Promise>Models.JobScheduleListResponse
list(JobScheduleListOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function list(options: JobScheduleListOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)Parâmetros
- options
- JobScheduleListOptionalParams
Os parâmetros opcionais
- callback
O retorno de chamada
list(ServiceCallback<CloudJobScheduleListResult>)
function list(callback: ServiceCallback<CloudJobScheduleListResult>)Parâmetros
- callback
O retorno de chamada
listNext(string, JobScheduleListNextOptionalParams)
function listNext(nextPageLink: string, options?: JobScheduleListNextOptionalParams): Promise<JobScheduleListResponse>Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
Os parâmetros opcionais
Retornos
Promise<JobScheduleListResponse>
< Promise>Models.JobScheduleListResponse
listNext(string, JobScheduleListNextOptionalParams, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, options: JobScheduleListNextOptionalParams, callback: ServiceCallback<CloudJobScheduleListResult>)Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
Os parâmetros opcionais
- callback
O retorno de chamada
listNext(string, ServiceCallback<CloudJobScheduleListResult>)
function listNext(nextPageLink: string, callback: ServiceCallback<CloudJobScheduleListResult>)Parâmetros
- nextPageLink
-
string
O NextLink da chamada com êxito anterior para a operação List.
- callback
O retorno de chamada
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams)
Isso substitui apenas as propriedades de Agendamento de Trabalho especificadas na solicitação. Por exemplo, se a propriedade de agendamento não for especificada com essa solicitação, o serviço do Lote manterá o agendamento existente. As alterações em um Agendamento de Trabalho só afetam os trabalhos criados pelo agendamento após a atualização ter ocorrido; Atualmente, os trabalhos em execução não são afetados.
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options?: JobSchedulePatchOptionalParams): Promise<JobSchedulePatchResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobSchedulePatchParameter
- JobSchedulePatchParameter
Os parâmetros da solicitação.
- options
- JobSchedulePatchOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobSchedulePatchResponse>
< Promise>Models.JobSchedulePatchResponse
patch(string, JobSchedulePatchParameter, JobSchedulePatchOptionalParams, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, options: JobSchedulePatchOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobSchedulePatchParameter
- JobSchedulePatchParameter
Os parâmetros da solicitação.
- options
- JobSchedulePatchOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
patch(string, JobSchedulePatchParameter, ServiceCallback<void>)
function patch(jobScheduleId: string, jobSchedulePatchParameter: JobSchedulePatchParameter, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobSchedulePatchParameter
- JobSchedulePatchParameter
Os parâmetros da solicitação.
- callback
-
ServiceCallback<void>
O retorno de chamada
terminate(string, JobScheduleTerminateOptionalParams)
function terminate(jobScheduleId: string, options?: JobScheduleTerminateOptionalParams): Promise<JobScheduleTerminateResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser encerrada.
Os parâmetros opcionais
Retornos
Promise<JobScheduleTerminateResponse>
Promise<Models.JobScheduleTerminateResponse>
terminate(string, JobScheduleTerminateOptionalParams, ServiceCallback<void>)
function terminate(jobScheduleId: string, options: JobScheduleTerminateOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser encerrada.
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
terminate(string, ServiceCallback<void>)
function terminate(jobScheduleId: string, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser encerrada.
- callback
-
ServiceCallback<void>
O retorno de chamada
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams)
Isso substitui totalmente todas as propriedades atualizáveis do Agendamento de Trabalho. Por exemplo, se a propriedade de agendamento não for especificada com essa solicitação, o serviço do Lote removerá o agendamento existente. As alterações em um Agendamento de Trabalho só afetam os trabalhos criados pelo agendamento após a atualização ter ocorrido; Atualmente, os trabalhos em execução não são afetados.
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options?: JobScheduleUpdateOptionalParams): Promise<JobScheduleUpdateResponse>Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
Os parâmetros da solicitação.
- options
- JobScheduleUpdateOptionalParams
Os parâmetros opcionais
Retornos
Promise<JobScheduleUpdateResponse>
< Promise>Models.JobScheduleUpdateResponse
update(string, JobScheduleUpdateParameter, JobScheduleUpdateOptionalParams, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, options: JobScheduleUpdateOptionalParams, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
Os parâmetros da solicitação.
- options
- JobScheduleUpdateOptionalParams
Os parâmetros opcionais
- callback
-
ServiceCallback<void>
O retorno de chamada
update(string, JobScheduleUpdateParameter, ServiceCallback<void>)
function update(jobScheduleId: string, jobScheduleUpdateParameter: JobScheduleUpdateParameter, callback: ServiceCallback<void>)Parâmetros
- jobScheduleId
-
string
A ID da Agenda de Trabalho a ser atualizada.
- jobScheduleUpdateParameter
- JobScheduleUpdateParameter
Os parâmetros da solicitação.
- callback
-
ServiceCallback<void>
O retorno de chamada