All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

QueueClient
```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public interface Queue
extends AutoCloseable
```
Use the Queue API to produce and consume messages, create queues, and manage related items.
For more information, see Queue. This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`DeleteMessageResponse`	`deleteMessage(DeleteMessageRequest request)`	Deletes the message represented by the receipt from the queue.
`DeleteMessagesResponse`	`deleteMessages(DeleteMessagesRequest request)`	Deletes multiple messages from the queue or the consumer group.
`String`	`getEndpoint()`	Gets the set endpoint for REST call (ex, https://www.example.com)
`GetMessagesResponse`	`getMessages(GetMessagesRequest request)`	Consumes messages from the queue.
`GetStatsResponse`	`getStats(GetStatsRequest request)`	Gets the statistics for the queue and its dead letter queue.
`ListChannelsResponse`	`listChannels(ListChannelsRequest request)`	Gets the list of IDs of non-empty channels.
`PutMessagesResponse`	`putMessages(PutMessagesRequest request)`	Puts messages into the queue.
`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’).
`UpdateMessageResponse`	`updateMessage(UpdateMessageRequest request)`	Updates the visibility of the message represented by the receipt.
`UpdateMessagesResponse`	`updateMessages(UpdateMessagesRequest request)`	Updates multiple messages in the queue or the consumer group.
`void`	`useRealmSpecificEndpointTemplate(boolean realmSpecificEndpointTemplateEnabled)`	Determines whether realm specific endpoint should be used or not.

Methods inherited from interface java.lang.AutoCloseable
close

- Method Detail
  - refreshClient
```
void refreshClient()
```
    Rebuilds the client from scratch.
    Useful to refresh certificates.
  - setEndpoint
```
void setEndpoint(String endpoint)
```
    Sets the endpoint to call (ex, https://www.example.com).
    
    Parameters:
    
    endpoint - The endpoint of the service.
  - getEndpoint
```
String getEndpoint()
```
    Gets the set endpoint for REST call (ex, https://www.example.com)
  - setRegion
```
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.
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
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.
    
    Parameters:
    
    regionId - The public region ID.
  - useRealmSpecificEndpointTemplate
```
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”
    
    Parameters:
    
    realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template
  - deleteMessage
```
DeleteMessageResponse deleteMessage(DeleteMessageRequest request)
```
    Deletes the message represented by the receipt from the queue.
    You must use the messages endpoint to delete messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/DeleteMessageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteMessage API.
  - deleteMessages
```
DeleteMessagesResponse deleteMessages(DeleteMessagesRequest request)
```
    Deletes multiple messages from the queue or the consumer group.
    Only messages from the same queue/consumer group can be deleted at once. You must use the messages endpoint to delete messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/DeleteMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteMessages API.
  - getMessages
```
GetMessagesResponse getMessages(GetMessagesRequest request)
```
    Consumes messages from the queue.
    You must use the messages endpoint to consume messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint. GetMessages accepts optional channelFilter query parameter that can filter source channels of the messages. When channelFilter is present, service will return available messages from the channel which ID exactly matched the filter. When filter is not specified, messages will be returned from a random non-empty channel within a queue.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/GetMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetMessages API.
  - getStats
```
GetStatsResponse getStats(GetStatsRequest request)
```
    Gets the statistics for the queue and its dead letter queue.
    You must use the messages endpoint to get a queue’s statistics. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/GetStatsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetStats API.
  - listChannels
```
ListChannelsResponse listChannels(ListChannelsRequest request)
```
    Gets the list of IDs of non-empty channels.
    It will return an approximate list of IDs of non-empty channels. That information is based on the queue level statistics. API supports optional channelFilter parameter which will filter the returned results according to the specified filter. List of channel IDs is approximate, because statistics is refreshed once per-second, and that list represents a snapshot of the past information. API is paginated.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/ListChannelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListChannels API.
  - putMessages
```
PutMessagesResponse putMessages(PutMessagesRequest request)
```
    Puts messages into the queue.
    You must use the messages endpoint to produce messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation will not retry by default, users can also use RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION provided by the SDK to enable retries for it. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/PutMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use PutMessages API.
  - updateMessage
```
UpdateMessageResponse updateMessage(UpdateMessageRequest request)
```
    Updates the visibility of the message represented by the receipt.
    You must use the messages endpoint to update messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/UpdateMessageExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateMessage API.
  - updateMessages
```
UpdateMessagesResponse updateMessages(UpdateMessagesRequest request)
```
    Updates multiple messages in the queue or the consumer group.
    Only messages from the same queue/consumer group can be updated at once. You must use the messages endpoint to update messages. The messages endpoint may be different for different queues. Use getQueue to find the queue’s messagesEndpoint.
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
    
    Throws:
    
    BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries
    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.0/queue/UpdateMessagesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateMessages API.

Interface Queue

Method Summary

Methods inherited from interface java.lang.AutoCloseable

Method Detail

refreshClient

setEndpoint

getEndpoint

setRegion

setRegion

useRealmSpecificEndpointTemplate

deleteMessage

deleteMessages

getMessages

getStats

listChannels

putMessages

updateMessage

updateMessages