com.oracle.bmc.queue

Class QueueAdminClient

java.lang.Object

com.oracle.bmc.queue.QueueAdminClient

All Implemented Interfaces:

QueueAdmin, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public class QueueAdminClient
extends Object
implements QueueAdmin

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueueAdminClient.Builder Builder class for this client.

Field Summary

Fields

Modifier and Type	Field and Description
static Service	SERVICE Service instance for QueueAdmin.

Constructor Summary

Constructors

Modifier	Constructor and Description
	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService) Creates a new service instance using the given authentication provider and client configuration.
protected	QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService, RestClientFactoryBuilder restClientFactoryBuilder) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider) Creates a new service instance using the given authentication provider.
	QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration) Creates a new service instance using the given authentication provider and client configuration.
	QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator) Creates a new service instance using the given authentication provider and client configuration.

Method Summary

Modifier and Type	Method and Description
static QueueAdminClient.Builder	builder() Create a builder for this client.
ChangeQueueCompartmentResponse	changeQueueCompartment(ChangeQueueCompartmentRequest request) Moves a Queue resource from one compartment identifier to another.
void	close()
CreateQueueResponse	createQueue(CreateQueueRequest request) Creates a new Queue.
DeleteQueueResponse	deleteQueue(DeleteQueueRequest request) Deletes a Queue resource by identifier
String	getEndpoint() Gets the set endpoint for REST call (ex, https://www.example.com)
QueueAdminPaginators	getPaginators() Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
GetQueueResponse	getQueue(GetQueueRequest request) Gets a Queue by identifier
QueueAdminWaiters	getWaiters() Gets the pre-configured waiters available for resources for this service.
GetWorkRequestResponse	getWorkRequest(GetWorkRequestRequest request) Gets the status of the work request with the given ID.
ListQueuesResponse	listQueues(ListQueuesRequest request) Returns a list of Queues.
ListWorkRequestErrorsResponse	listWorkRequestErrors(ListWorkRequestErrorsRequest request) Return a (paginated) list of errors for a given work request.
ListWorkRequestLogsResponse	listWorkRequestLogs(ListWorkRequestLogsRequest request) Return a (paginated) list of logs for a given work request.
ListWorkRequestsResponse	listWorkRequests(ListWorkRequestsRequest request) Lists the work requests in a compartment.
PurgeQueueResponse	purgeQueue(PurgeQueueRequest request) Deletes all messages present in the queue at the time of invocation.
void	refreshClient() Rebuilds the client from scratch.
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’).
UpdateQueueResponse	updateQueue(UpdateQueueRequest request) Updates the Queue

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE

public static final Service SERVICE

Service instance for QueueAdmin.

Constructor Detail

QueueAdminClient

public QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)

Creates a new service instance using the given authentication provider.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

QueueAdminClient

public QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration)

Creates a new service instance using the given authentication provider and client configuration.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

QueueAdminClient

public QueueAdminClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

QueueAdminClient

public QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

QueueAdminClient

public QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        List<ClientConfigurator> additionalClientConfigurators)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

QueueAdminClient

public QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

QueueAdminClient

public QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

QueueAdminClient

public QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                        ClientConfiguration configuration,
                        ClientConfigurator clientConfigurator,
                        RequestSignerFactory defaultRequestSignerFactory,
                        Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                        List<ClientConfigurator> additionalClientConfigurators,
                        String endpoint,
                        ExecutorService executorService)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

QueueAdminClient

protected QueueAdminClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                           ClientConfiguration configuration,
                           ClientConfigurator clientConfigurator,
                           RequestSignerFactory defaultRequestSignerFactory,
                           Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                           List<ClientConfigurator> additionalClientConfigurators,
                           String endpoint,
                           ExecutorService executorService,
                           RestClientFactoryBuilder restClientFactoryBuilder)

Creates a new service instance using the given authentication provider and client configuration. Additionally, a Consumer can be provided that will be invoked whenever a REST Client is created to allow for additional configuration/customization.

This is an advanced constructor for clients that want to take control over how requests are signed. Use the QueueAdminClient.Builder to get access to all these parameters.

Parameters:

authenticationDetailsProvider - The authentication details provider, required.

configuration - The client configuration, optional.

clientConfigurator - ClientConfigurator that will be invoked for additional configuration of a REST client, optional.

defaultRequestSignerFactory - The request signer factory used to create the request signer for this service.

signingStrategyRequestSignerFactories - The request signer factories for each signing strategy used to create the request signer

additionalClientConfigurators - Additional client configurators to be run after the primary configurator.

endpoint - Endpoint, or null to leave unset (note, may be overridden by authenticationDetailsProvider)

executorService - ExecutorService used by the client, or null to use the default configured ThreadPoolExecutor

restClientFactoryBuilder - the builder for the RestClientFactory

Method Detail

builder

public static QueueAdminClient.Builder builder()

Create a builder for this client.

Returns:

builder

refreshClient

public void refreshClient()

Description copied from interface: QueueAdmin

Rebuilds the client from scratch. Useful to refresh certificates.

Specified by:

refreshClient in interface QueueAdmin

setEndpoint

public void setEndpoint(String endpoint)

Description copied from interface: QueueAdmin

Sets the endpoint to call (ex, https://www.example.com).

Specified by:

setEndpoint in interface QueueAdmin

Parameters:

endpoint - The endpoint of the service.

getEndpoint

public String getEndpoint()

Description copied from interface: QueueAdmin

Gets the set endpoint for REST call (ex, https://www.example.com)

Specified by:

getEndpoint in interface QueueAdmin

setRegion

public void setRegion(Region region)

Description copied from interface: QueueAdmin

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.

Specified by:

setRegion in interface QueueAdmin

Parameters:

region - The region of the service.

setRegion

public void setRegion(String regionId)

Description copied from interface: QueueAdmin

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.

Specified by:

setRegion in interface QueueAdmin

Parameters:

regionId - The public region ID.

close

public void close()

Specified by:

close in interface AutoCloseable

changeQueueCompartment

public ChangeQueueCompartmentResponse changeQueueCompartment(ChangeQueueCompartmentRequest request)

Description copied from interface: QueueAdmin

Moves a Queue resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Specified by:

changeQueueCompartment in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

createQueue

public CreateQueueResponse createQueue(CreateQueueRequest request)

Description copied from interface: QueueAdmin

Creates a new Queue.

Specified by:

createQueue in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

deleteQueue

public DeleteQueueResponse deleteQueue(DeleteQueueRequest request)

Description copied from interface: QueueAdmin

Deletes a Queue resource by identifier

Specified by:

deleteQueue in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getQueue

public GetQueueResponse getQueue(GetQueueRequest request)

Description copied from interface: QueueAdmin

Gets a Queue by identifier

Specified by:

getQueue in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWorkRequest

public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)

Description copied from interface: QueueAdmin

Gets the status of the work request with the given ID.

Specified by:

getWorkRequest in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listQueues

public ListQueuesResponse listQueues(ListQueuesRequest request)

Description copied from interface: QueueAdmin

Returns a list of Queues.

Specified by:

listQueues in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestErrors

public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)

Description copied from interface: QueueAdmin

Return a (paginated) list of errors for a given work request.

Specified by:

listWorkRequestErrors in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequestLogs

public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)

Description copied from interface: QueueAdmin

Return a (paginated) list of logs for a given work request.

Specified by:

listWorkRequestLogs in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

listWorkRequests

public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)

Description copied from interface: QueueAdmin

Lists the work requests in a compartment.

Specified by:

listWorkRequests in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

purgeQueue

public PurgeQueueResponse purgeQueue(PurgeQueueRequest request)

Description copied from interface: QueueAdmin

Deletes all messages present in the queue 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.

Specified by:

purgeQueue in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

updateQueue

public UpdateQueueResponse updateQueue(UpdateQueueRequest request)

Description copied from interface: QueueAdmin

Updates the Queue

Specified by:

updateQueue in interface QueueAdmin

Parameters:

request - The request object containing the details to send

Returns:

A response object containing details about the completed operation

getWaiters

public QueueAdminWaiters getWaiters()

Description copied from interface: QueueAdmin

Gets the pre-configured waiters available for resources for this service.

Specified by:

getWaiters in interface QueueAdmin

Returns:

The service waiters.

getPaginators

public QueueAdminPaginators getPaginators()

Description copied from interface: QueueAdmin

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.

Specified by:

getPaginators in interface QueueAdmin

Returns:

The service paginators.