com.sap.cloud.sdk.services.scp.workflow.cf.api

Class JobsApi

java.lang.Object

com.sap.cloud.sdk.services.rest.core.AbstractRestService

com.sap.cloud.sdk.services.scp.workflow.cf.api.JobsApi

All Implemented Interfaces:

RestService

@Component(value="com.sap.cloud.sdk.services.scp.workflow.cf.api.JobsApi")
 @Beta
public class JobsApi
extends AbstractRestService

Workflow API for Cloud Foundry in version v1. This API in the Cloud SDK uses the SAP Cloud Platform Workflow service REST API. With the API, you can, for example, start new workflow instances and work with tasks.
For more information on how to obtain the necessary parameters, please see Determine Service Configuration Parameters in the documentation. The OAuth client you use must have extended scopes.
Note: The underlying REST APIs are designed for loosely coupled clients. This means:

• If workflow service adds fields to responses, the REST API version number does not increase. REST API clients must ignore new fields. These fields become available in the Workflow API in the Cloud SDK only in new versions of the SDK.
• The order of fields in responses and of entries in arrays may change. This applies unless the API provides an explicit means to specify the desired order.

Field Summary

Fields inherited from class com.sap.cloud.sdk.services.rest.core.AbstractRestService

apiClient

Constructor Summary

Constructors

Constructor and Description
JobsApi(HttpDestinationProperties httpDestination) Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Method Summary

Modifier and Type	Method and Description
Job	getJob(String jobId) Retrieve Job status

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobsApi

public JobsApi(@Nonnull
               HttpDestinationProperties httpDestination)

Instantiates this API class to invoke operations on the the Workflow API for Cloud Foundry.

Parameters:

httpDestination - The destination that API should be used with

Method Detail

getJob

@Nullable
public Job getJob(@Nonnull
                            String jobId)
                     throws RestRequestException

Retrieve Job status

Tracks the status of API requests, which the server executed asynchronously. Roles permitted to execute this operation: - Global roles: WorkflowTenantOperator - Scope: JOB_STATUS_GET

200 - Returns the status of the job

404 - Job not found. You may have provided an incorrect job ID or the job may have already completed.

429 - You have reached the usage limits that are configured for your tenant. You are performing too many requests or consume too many resources.

Parameters:

jobId - The ID of the job for which you check the status. Typically, the ID has been retrieved from another API request that was processed asynchronously. The ID is at most 36 characters long.

Returns:

Job

Throws:

RestRequestException - if an error occurs while attempting to invoke the API