Classe Job
The Job class represents a Microsoft SQL Server Agent job.
Hierarquia de herança
System. . :: . .Object
Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
Microsoft.SqlServer.Management.Smo.Agent. . :: . .AgentObjectBase
Microsoft.SqlServer.Management.Smo.Agent..::..Job
Namespace: Microsoft.SqlServer.Management.Smo.Agent
Assembly: Microsoft.SqlServer.Smo (em Microsoft.SqlServer.Smo.dll)
Sintaxe
'Declaração
Public NotInheritable Class Job _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'Uso
Dim instance As Job
public sealed class Job : AgentObjectBase, IAlterable,
ICreatable, IDroppable, IRenamable, IScriptable
public ref class Job sealed : public AgentObjectBase,
IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
type Job =
class
inherit AgentObjectBase
interface IAlterable
interface ICreatable
interface IDroppable
interface IRenamable
interface IScriptable
end
public final class Job extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
O tipo Job expõe os membros a seguir.
Construtores
Nome | Descrição | |
---|---|---|
Job() () () () | Initializes a new instance of the Job class. | |
Job(JobServer, String) | Initializes a new instance of the Job class on the specified instance of Microsoft SQL Server Agent and with the specified name. | |
Job(JobServer, String, Int32) | Initializes a new instance of the Job class on the specified instance of SQL Server Agent and with the specified name and category |
Início
Propriedades
Nome | Descrição | |
---|---|---|
Category | Gets or sets the category to which the job belongs. | |
CategoryID | Gets the ID value that uniquely identifies the job category. | |
CategoryType | Gets or sets the type of category, with respect to local or multiserver jobs. | |
CurrentRunRetryAttempt | Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully. | |
CurrentRunStatus | Gets the current execution status of the job. | |
CurrentRunStep | Gets information about the job step that is currently running. | |
DateCreated | Gets the date and time when the job was created. | |
DateLastModified | Gets the date and time when the job was last modified. | |
DeleteLevel | Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution. | |
Description | Gets or sets the textual description of the job. | |
EmailLevel | Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution. | |
EventLogLevel | Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution. | |
ExecuteForScalar | Obtém ou define o valor da propriedade Boolean que especifica se o objeto esta definido para a opção execute for scalar. (Herdado de SqlSmoObject.) | |
HasSchedule | Gets the Boolean property value that specifies whether the job has at least one schedule. | |
HasServer | Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations. | |
HasStep | Gets the Boolean property value that specifies whether the job has at least one job step. | |
IsEnabled | Gets or sets the Boolean property value that specifies whether the job is enabled. | |
IsTouched | Obtém o valor da propriedade Boolean que especifica se as propriedades do objeto foram atualizadas, mas ainda não foram persistidas no servidor. (Herdado de SqlSmoObject.) | |
JobID | Gets the job ID value. | |
JobSchedules | Gets a collection of JobSchedule objects that represent the schedules assigned to the job. | |
JobSteps | Gets a collection of JobStep objects that represent the job steps defined for the job. | |
JobType | Gets the job type, which specifies whether the job is local or multiserver. | |
LastRunDate | Gets the date and time when the job was last run. | |
LastRunOutcome | Gets the result of the job from the last time it completed execution. | |
Name | Gets or sets the name of the Job. (Substitui NamedSmoObject. . :: . .Name.) | |
NetSendLevel | Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution. | |
NextRunDate | Gets the date and time when the job is next scheduled to run. | |
NextRunScheduleID | Gets the ID value of the schedule that is responsible for the next execution of the job. | |
ObjectInSpace | Obtém o valor da propriedade Boolean que especifica se o objeto existe em isolamento ou se está direta ou indiretamente conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
OperatorToEmail | Gets or sets the operator that receives notification by e-mail when the job finishes execution. | |
OperatorToNetSend | Gets or sets the operator that receives a net-send notification when the job finishes execution. | |
OperatorToPage | Gets or sets the operator that receives a pager notification when the job finishes execution. | |
OriginatingServer | Gets the name of the server that is acting as the master server in a multiserver job. | |
OwnerLoginName | Gets or sets the owner of the job. | |
PageLevel | Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution. | |
Parent | Gets or sets the JobServer object that is the parent of the Job object. | |
Properties | Obtém uma coleção de objetos Property que representam as propriedades do objeto. (Herdado de SqlSmoObject.) | |
ScalarResult | Obtém o resultado escalar do objeto referenciado. (Herdado de SqlSmoObject.) | |
StartStepID | Gets or sets the ID value of the first job step in the sequence to be executed. | |
State | Gets the state of the referenced object. (Herdado de SmoObjectBase.) | |
Urn | Obtém o valor do endereço do URN (Uniform Resource Name) que identifica exclusivamente o objeto. (Herdado de SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Herdado de SmoObjectBase.) | |
VersionNumber | Gets a system-maintained value that is incremented every time the job is modified. |
Início
Métodos
Nome | Descrição | |
---|---|---|
AddDatabaseContext(StringCollection) | Adiciona o contexto do banco de dados à coleção de consultas identificadas pelo parâmetro queries. (Herdado de SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Adiciona o contexto de banco de dados à coleção de consultas identificadas pelo parâmetro queries e usando as opções de script especificadas. (Herdado de SqlSmoObject.) | |
AddSharedSchedule | Adds a shared schedule to the Microsoft SQL Server Agent job. | |
Alter | Updates any Job object property changes on an instance of Microsoft SQL Server. | |
AlterImpl | Ativa o evento alterado do objeto. (Herdado de SqlSmoObject.) | |
AlterImplFinish | Método chamado quando o evento alterado do objeto é concluído. (Herdado de SqlSmoObject.) | |
AlterImplInit | Método chamado quando o evento de alteração do objeto é inicializado. (Herdado de SqlSmoObject.) | |
AlterImplWorker | Chama os métodos Alter. (Herdado de SqlSmoObject.) | |
ApplyToTargetServer | Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. | |
ApplyToTargetServerGroup | Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. | |
BindDefaultImpl | Associa os itens padrão identificados pelos parâmetros. (Herdado de SqlSmoObject.) | |
BindRuleImpl | Associa o esquema de regra à regra e às colunas identificadas pelos parâmetros. (Herdado de SqlSmoObject.) | |
CheckCollation | Verifica a ordem das opções de script pelo método de agrupamento identificado pelo parâmetro collationName. (Herdado de SqlSmoObject.) | |
CheckObjectState() () () () | Valida o estado do objeto referenciado. (Herdado de SqlSmoObject.) | |
CheckObjectState(Boolean) | Valida o estado do objeto referenciado com a opção de especificar que uma exceção será gerada se o objeto ainda não tiver sido criado. (Herdado de SqlSmoObject.) | |
CheckObjectStateImpl | Verifica o estado de um SqlSmoObject. (Herdado de SqlSmoObject.) | |
CheckVersion100 | Verifica se a versão do SQL Server é SQL Server 2008. (Herdado de SqlSmoObject.) | |
CheckVersion80 | Verifica a validade do objeto no SQL Server 2000. (Herdado de SqlSmoObject.) | |
CheckVersion80SP3 | Verifica a validade do objeto no SQL Server 2000 SP3. (Herdado de SqlSmoObject.) | |
CheckVersion90 | Verifica a validade do objeto no SQL Server 2005. (Herdado de SqlSmoObject.) | |
CheckVersionBelow90 | Verifica se a versão do SQL Server é anterior ao SQL Server 2005. (Herdado de SqlSmoObject.) | |
CleanObject | Define o objeto como estado inalterado. (Herdado de SqlSmoObject.) | |
Create | Creates a job on the instance of Microsoft SQL Server as defined by the Job object. | |
CreateImpl | Cria um objeto com as opções do script. (Herdado de SqlSmoObject.) | |
CreateImplFinish | Método chamado quando o evento de criação é concluído. (Herdado de SqlSmoObject.) | |
CreateImplInit | Método chamado quando o evento de criação é inicializado. (Herdado de SqlSmoObject.) | |
DeleteJobStepLogs(DateTime) | Deletes job step log files that are older than the specified date. | |
DeleteJobStepLogs(Int32) | Deletes job step log files that are larger that the specified log ID number. | |
Discover | Descobre uma lista do tipo Object. (Herdado de SqlSmoObject.) | |
Drop() () () () | Removes an existing job. | |
Drop(Boolean) | Removes an existing job. | |
DropImpl | Remove um SqlSmoObject. (Herdado de SqlSmoObject.) | |
DropImplWorker | Chama os métodos de remoção. (Herdado de SqlSmoObject.) | |
EnumAlerts | Enumerates a list of Agent alerts that cause automated execution of the referenced job. | |
EnumHistory() () () () | Enumerates a list of execution history associated with the referenced job. | |
EnumHistory(JobHistoryFilter) | Enumerates a list of execution history associated with the referenced job. | |
EnumJobStepLogs() () () () | Enumerates a list of job step log files for the referenced job. | |
EnumJobStepLogs(Int32) | Enumerates a list of job step log files for the job step with the specified ID value. | |
EnumJobStepLogs(String) | Enumerates a list of job step log files for the job step with the specified name. | |
EnumJobStepsByID | Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value. | |
EnumScriptImpl | Enumera scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorker | Chama os métodos que enumeram scripts especificados pelo parâmetro so. (Herdado de SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Retorna uma cadeia de caracteres IEnumerable que descreve as opções de script de um objeto. (Herdado de SqlSmoObject.) | |
EnumTargetServers | Enumerates a list of execution target servers that have been assigned to the referenced job. | |
Equals | (Herdado de Object.) | |
ExecuteNonQuery | (Herdado de SqlSmoObject.) | |
Finalize | (Herdado de Object.) | |
FormatSqlVariant | Formata um objeto como tipo SqlVariant. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Gera um script para criar arquivo de dados. (Herdado de SqlSmoObject.) | |
GenerateDataSpaceScript | Gera um script para alocar espaço no arquivo de dados. (Herdado de SqlSmoObject.) | |
GetBindDefaultScript | Obtém o script que associa padrões especificados pelos parâmetros defSchema e defName. (Herdado de SqlSmoObject.) | |
GetBindRuleScript | Obtém o script que especifica as regras de associação. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro booliano do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui uma propriedade booliana do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetDateTimeParameter | Atribui a propriedade datetime do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetDateTimeParameterAsInt | Atribuirá a propriedade datetime do SqlSmoObject como um valor inteiro se a propriedade datetime não for nula. (Herdado de SqlSmoObject.) | |
GetDBName | Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. Gets the database name that is associated with the object. (Herdado de AgentObjectBase.) | |
GetEnumParameter | Atribui uma propriedade de enumeração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetFragOptionString | Obtém um objeto FragmentationOption como um valor de cadeia de caracteres. (Herdado de SqlSmoObject.) | |
GetGuidParameter | Atribui uma propriedade Guid do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetHashCode | (Herdado de Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro do SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptional | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetRealValue | Obtém um valor da propriedade do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetScriptingOptionsForCreate | Obtém ScriptingOptions para o objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetServerName | Obtém o nome da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetServerObject | Obtém o servidor do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetSqlServerVersionName | Obtém o nome da versão da instância do SQL Server à qual o objeto está associado. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Atribui um parâmetro de cadeia de caracteres do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Atribui um parâmetro de período de tempo do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetType | (Herdado de Object.) | |
GetUrnRecursive(StringBuilder) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Atribui um objeto Urn do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
ImplInitialize | Inicializa os campos do objeto SqlSmoObject. (Herdado de SqlSmoObject.) | |
Initialize() () () () | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
Initialize(Boolean) | Inicializa o objeto e força o carregamento das propriedades. (Herdado de SqlSmoObject.) | |
Invoke | Runs the job. | |
IsObjectDirty | Verifica se as propriedades de objeto foram modificadas e se as alterações ainda não foram persistidas na instância do SQL Server. (Herdado de SqlSmoObject.) | |
IsObjectInitialized | Verifica se o objeto foi inicializado. (Herdado de SqlSmoObject.) | |
IsObjectInSpace | Verifica se o objeto está isolado ou conectado com a instância do SQL Server. (Herdado de SqlSmoObject.) | |
IsVersion80SP3 | Determina se a versão do SQL Server é SQL Server 2000 com SP3. (Herdado de SqlSmoObject.) | |
IsVersion90AndAbove | Determina se a versão do SQL Server é SQL Server 2005 ou posterior. (Herdado de SqlSmoObject.) | |
MarkDropped | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MarkForDropImpl | Define o SqlSmoState como removido. (Herdado de SqlSmoObject.) | |
MemberwiseClone | (Herdado de Object.) | |
PostAlter | Método ativado depois da alteração do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostCreate | Método ativado depois da criação do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PostDrop | Método ativado depois da remoção do SqlSmoObject. (Herdado de SqlSmoObject.) | |
PurgeHistory | Removes system records maintaining execution history for the referenced job. | |
Refresh | Atualiza o objeto e recupera as propriedades na próxima vez que o objeto é acessado. (Herdado de SqlSmoObject.) | |
RemoveAllJobSchedules() () () () | Removes all shared and unshared schedules from the job. | |
RemoveAllJobSchedules(Boolean) | Removes all unused schedules from the job. | |
RemoveAllJobSteps | Removes all the job steps associated with the job. | |
RemoveFromTargetServer | Removes an execution target server from the list of target servers maintained for a job. | |
RemoveFromTargetServerGroup | Removes a group of execution target servers from the list of target servers maintained for a job. | |
RemoveSharedSchedule(Int32) | Removes the specified shared schedule from the job. | |
RemoveSharedSchedule(Int32, Boolean) | Removes the specified shared schedule from the job and keeps unused schedules. | |
Rename | Renames the job. | |
RenameImpl | Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.) | |
RenameImplWorker | Identificado apenas para fins informativos. Sem suporte. A compatibilidade futura não está garantida. (Herdado de NamedSmoObject.) | |
Script() () () () | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job. | |
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job as specified by the scripting options. | |
ScriptAlter | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.) | |
ScriptCreate | Altera o SqlSmoObject de acordo com os parâmetros. (Herdado de SqlSmoObject.) | |
ScriptDdl | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptDrop | Gera a InvalidSmoOperationException. (Herdado de SqlSmoObject.) | |
ScriptImpl() () () () | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptImplWorker | Obtém uma coleção de scripts do SqlSmoObject. (Herdado de SqlSmoObject.) | |
ScriptOwner | Alters the script owner authorization. (Herdado de NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Herdado de NamedSmoObject.) | |
SetParentImpl | Define o pai do SqlSmoObject como o parâmetro newParent. (Herdado de SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Herdado de NamedSmoObject.) | |
Start() () () () | Runs the referenced job. | |
Start(String) | Runs the referenced job starting at the specified job step. | |
Stop | Stops executing the referenced job. | |
ToString | Retorna um String que representa o objeto referenciado. (Herdado de SqlSmoObject.) | |
TouchImpl | Não implementado. (Herdado de SqlSmoObject.) | |
UnbindDefaultImpl | Desassocia as colunas padrão do SqlSmoObject. (Herdado de SqlSmoObject.) | |
UnbindRuleImpl | Desassocia as regras do SqlSmoObject. (Herdado de SqlSmoObject.) | |
Validate | Validates the state of an object. (Herdado de SmoObjectBase.) |
Início
Eventos
Nome | Descrição | |
---|---|---|
PropertyChanged | Representa o evento que ocorre quando uma propriedade é alterada. (Herdado de SqlSmoObject.) | |
PropertyMetadataChanged | Representa o evento que ocorre quando os metadados da propriedade são alterados. (Herdado de SqlSmoObject.) |
Início
Campos
Nome | Descrição | |
---|---|---|
m_ExtendedProperties | Representa uma propriedade definida para estender as propriedades fornecidas por um SqlSmoObject. (Herdado de SqlSmoObject.) | |
singletonParent | Representa o pai do singleton. (Herdado de SqlSmoObject.) |
Início
Implementações de interfaces explícitas
Nome | Descrição | |
---|---|---|
IAlienObject. . :: . .Discover | Descobre quaisquer dependências. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Retorna a raiz do domínio. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Obtém o pai do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Obtém o tipo da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Obtém o valor da propriedade especificada. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Obtém o Unified Resource Name do objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Obtém a instância que contém as informações sobre o objeto a partir do Unified Resource Name do objeto. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Define o estado do objeto como o valor SfcObjectState especificado. (Herdado de SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Define o valor da propriedade. (Herdado de SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Obtém a referência da interface para o conjunto de propriedades deste objeto. Não referencie esse membro diretamente no código. Ele dá suporte à infraestrutura do SQL Server. (Herdado de SqlSmoObject.) |
Início
Comentários
To get or set Job object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.
To create a job, users must be a member of the SQLAgentUserRole, SQLAgentReaderRole, and SQLAgentOperatorRole database roles on the MSDB database, or be a member of the sysadmin fixed server role.
To drop a job, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.
Thread Safety
Qualquer membro público estático (Compartilhado no Microsoft Visual Basic) desse tipo é seguro para operações multi-threaded. Não há garantia de que qualquer membro de instância seja seguro para threads.
Segurança de thread
Qualquer membro público static (Shared no Visual Basic) desse tipo é seguro para threads. Não há garantia de que qualquer membro de instância seja seguro para threads.
Consulte também