@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public interface WorkRequest extends AutoCloseable
Many of the API operations that you use to create and configure Compute resources do not take effect immediately. In these cases, the operation spawns an asynchronous workflow to fulfill the request. Work requests provide visibility into the status of these in-progress, long-running workflows.
For more information about work requests and the operations that spawn work requests, see Viewing the State of a Compute Work Request.
Modifier and Type | Method and Description |
---|---|
String |
getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
|
WorkRequestPaginators |
getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data.
|
WorkRequestWaiters |
getWaiters()
Gets the pre-configured waiters available for resources for this service.
|
GetWorkRequestResponse |
getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.
|
ListWorkRequestErrorsResponse |
listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Gets the errors for a work request.
|
ListWorkRequestLogsResponse |
listWorkRequestLogs(ListWorkRequestLogsRequest request)
Gets the logs for a work request.
|
ListWorkRequestsResponse |
listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment or for a specified resource.
|
void |
setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
|
void |
setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
|
void |
setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
|
close
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint
- The endpoint of the service.String getEndpoint()
Gets the set endpoint for REST call (ex, https://www.example.com)
void setRegion(Region region)
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.
region
- The region of the service.void setRegion(String regionId)
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call
setRegion
.
If no known Region could be determined, it will create an endpoint based on the
default endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
regionId
- The public region ID.GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
Gets the details of a work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use GetWorkRequest API.
ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
Gets the errors for a work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequestErrors API.
ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
Gets the logs for a work request.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequestLogs API.
ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
Lists the work requests in a compartment or for a specified resource.
request
- The request object containing the details to sendBmcException
- when an error occurs.
Example: Click here to see how to use ListWorkRequests API.
WorkRequestWaiters getWaiters()
Gets the pre-configured waiters available for resources for this service.
WorkRequestPaginators getPaginators()
Gets the pre-configured paginators available for list operations in this service which may return multiple
pages of data. These paginators provide an Iterable
interface so that service responses, or
resources/records, can be iterated through without having to manually deal with pagination and page tokens.
Copyright © 2016–2021. All rights reserved.