@Generated(value="OracleSDKGenerator",
comments="API Version: 20210201")
public interface QueueAdminAsync
extends AutoCloseable
Use the Queue API to produce and consume messages, create queues, and manage related items. For more information, see Queue.
closevoid refreshClient()
Rebuilds the client from scratch. Useful to refresh certificates.
void setEndpoint(String endpoint)
Sets the endpoint to call (ex, https://www.example.com).
endpoint - The endpoint of the serice.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.void useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)
Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”
realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint
templateFuture<ChangeQueueCompartmentResponse> changeQueueCompartment(ChangeQueueCompartmentRequest request, AsyncHandler<ChangeQueueCompartmentRequest,ChangeQueueCompartmentResponse> handler)
Moves a queue from one compartment to another. When provided, If-Match is checked against ETag values of the resource.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<CreateQueueResponse> createQueue(CreateQueueRequest request, AsyncHandler<CreateQueueRequest,CreateQueueResponse> handler)
Creates a new queue.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<DeleteQueueResponse> deleteQueue(DeleteQueueRequest request, AsyncHandler<DeleteQueueRequest,DeleteQueueResponse> handler)
Deletes a queue resource by identifier.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<GetQueueResponse> getQueue(GetQueueRequest request, AsyncHandler<GetQueueRequest,GetQueueResponse> handler)
Gets a queue by identifier.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Gets the status of the work request with the given ID.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListQueuesResponse> listQueues(ListQueuesRequest request, AsyncHandler<ListQueuesRequest,ListQueuesResponse> handler)
Returns a list of queues.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Return a (paginated) list of errors for a given work request.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Return a (paginated) list of logs for a given work request.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Lists the work requests in a compartment.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<PurgeQueueResponse> purgeQueue(PurgeQueueRequest request, AsyncHandler<PurgeQueueRequest,PurgeQueueResponse> handler)
Deletes all messages present in the queue, or deletes all the messages in the specific channel at the time of invocation. Only one concurrent purge operation is supported for any given queue. However multiple concurrent purge operations are supported for different queues. Purge request without specification of target channels will clean up all messages in the queue and in the child channels.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Future<UpdateQueueResponse> updateQueue(UpdateQueueRequest request, AsyncHandler<UpdateQueueRequest,UpdateQueueResponse> handler)
Updates the specified queue.
request - The request object containing the details to sendhandler - The request handler to invoke upon completion, may be null.Copyright © 2016–2024. All rights reserved.