@Named(value="com.sap.cloud.sdk.s4hana.datamodel.odata.services.DefaultExternalJobSchedulerIntegrationService") public class DefaultExternalJobSchedulerIntegrationService extends Object implements ExternalJobSchedulerIntegrationService
This service enables external job schedulers to connect to the SAP back-end and perform the following operations on application jobs: get a list of application job templates, instantiate a job from a job template without parameters and with start condition ‘immediate start’, read the status of a job, and cancel or deschedule a job.
Reference: SAP API Business Hub
OData Service: | BC_EXT_APPJOB_MANAGEMENT |
API Version: | 2 |
Communication Scenario: | External Scheduler Integration (SAP_COM_0064) |
DEFAULT_SERVICE_PATH
Constructor and Description |
---|
DefaultExternalJobSchedulerIntegrationService()
Creates a service using
ExternalJobSchedulerIntegrationService.DEFAULT_SERVICE_PATH to send the requests. |
Modifier and Type | Method and Description |
---|---|
DefaultExternalJobSchedulerIntegrationServiceBatch |
batch()
Instantiate a new FluentHelper instance for a single OData batch request.
|
JobTemplateFluentHelper |
getAllJobTemplate()
Fetch multiple
JobTemplate entities. |
JobTemplateByKeyFluentHelper |
getJobTemplateByKey(String jobTemplateName,
String jobTemplateVersion)
Fetch a single
JobTemplate entity using key fields. |
JobAbortFluentHelper |
jobAbort(String jobRunCount,
String jobName)
Creates a fluent helper for the JobAbort OData function import.
|
JobCancelFluentHelper |
jobCancel(String jobRunCount,
String jobName)
Creates a fluent helper for the JobCancel OData function import.
|
JobScheduleFluentHelper |
jobSchedule(String jobUserID,
String jobUserName,
String jobText,
String jobTemplateName,
String jobParameterValues,
Boolean testModeInd,
String jobUser)
Creates a fluent helper for the JobSchedule OData function import.
|
JobStatusGetFluentHelper |
jobStatusGet(String jobName,
String jobRunCount)
Creates a fluent helper for the JobStatusGet OData function import.
|
DefaultExternalJobSchedulerIntegrationService |
withServicePath(String servicePath)
Overrides the default service path and returns a new service instance with the specified service path.
|
public DefaultExternalJobSchedulerIntegrationService()
ExternalJobSchedulerIntegrationService.DEFAULT_SERVICE_PATH
to send the requests.@Nonnull public DefaultExternalJobSchedulerIntegrationService withServicePath(@Nonnull String servicePath)
ExternalJobSchedulerIntegrationService
withServicePath
in interface ExternalJobSchedulerIntegrationService
servicePath
- Service path that will override the default.@Nonnull public DefaultExternalJobSchedulerIntegrationServiceBatch batch()
batch
in interface BatchService<ExternalJobSchedulerIntegrationServiceBatch>
@Nonnull public JobTemplateFluentHelper getAllJobTemplate()
ExternalJobSchedulerIntegrationService
JobTemplate
entities.getAllJobTemplate
in interface ExternalJobSchedulerIntegrationService
JobTemplate
entities. This fluent helper allows methods which modify the underlying query to be called
before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public JobTemplateByKeyFluentHelper getJobTemplateByKey(String jobTemplateName, String jobTemplateVersion)
ExternalJobSchedulerIntegrationService
JobTemplate
entity using key fields.getJobTemplateByKey
in interface ExternalJobSchedulerIntegrationService
JobTemplate
entity using key fields. This fluent helper allows methods which modify the underlying query
to be called before executing the query itself. To perform execution, call the
execute
method on the fluent helper object.@Nonnull public JobScheduleFluentHelper jobSchedule(String jobUserID, String jobUserName, String jobText, String jobTemplateName, String jobParameterValues, Boolean testModeInd, String jobUser)
ExternalJobSchedulerIntegrationService
Creates a fluent helper for the JobSchedule OData function import.
jobSchedule
in interface ExternalJobSchedulerIntegrationService
jobUserID
- Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: JobUserID
jobUserName
- Constraints: Nullable, Maximum length: 12
Original parameter name from the Odata EDM: JobUserName
jobText
- Constraints: Not nullable, Maximum length: 120
Original parameter name from the Odata EDM: JobText
jobTemplateName
- Constraints: Not nullable, Maximum length: 40
Original parameter name from the Odata EDM: JobTemplateName
jobParameterValues
- Constraints: Nullable
Original parameter name from the Odata EDM: JobParameterValues
testModeInd
- Indicator
Constraints: Nullable
Original parameter name from the Odata EDM: TestModeInd
jobUser
- Constraints: Nullable, Maximum length: 40
Original parameter name from the Odata EDM: JobUser
execute
method on the fluent helper object.@Nonnull public JobCancelFluentHelper jobCancel(String jobRunCount, String jobName)
ExternalJobSchedulerIntegrationService
Creates a fluent helper for the JobCancel OData function import.
jobCancel
in interface ExternalJobSchedulerIntegrationService
jobRunCount
- Constraints: Not nullable, Maximum length: 14
Original parameter name from the Odata EDM: JobRunCount
jobName
- Constraints: Not nullable, Maximum length: 32
Original parameter name from the Odata EDM: JobName
execute
method on the fluent helper object.@Nonnull public JobAbortFluentHelper jobAbort(String jobRunCount, String jobName)
ExternalJobSchedulerIntegrationService
Creates a fluent helper for the JobAbort OData function import.
jobAbort
in interface ExternalJobSchedulerIntegrationService
jobRunCount
- Constraints: Not nullable, Maximum length: 14
Original parameter name from the Odata EDM: JobRunCount
jobName
- Constraints: Not nullable, Maximum length: 32
Original parameter name from the Odata EDM: JobName
execute
method on the fluent helper object.@Nonnull public JobStatusGetFluentHelper jobStatusGet(String jobName, String jobRunCount)
ExternalJobSchedulerIntegrationService
Creates a fluent helper for the JobStatusGet OData function import.
jobStatusGet
in interface ExternalJobSchedulerIntegrationService
jobName
- Constraints: none
Original parameter name from the Odata EDM: JobName
jobRunCount
- Constraints: none
Original parameter name from the Odata EDM: JobRunCount
execute
method on the fluent helper object.Copyright © 2019 SAP SE. All rights reserved.