java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.queue.QueueClient

All Implemented Interfaces:: Queue, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public class QueueClient
extends BaseSyncClient
implements Queue

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class QueueClient.Builder
Builder class for this client.

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`clientCommonLibraryVersion`	Compatible SDK version, provided by the codegen.
`Optional<String>`	`minimumClientCommonLibraryVersionFromClient`	Minimum compatible SDK version, maybe provided by the codegen.
`static Service`	`SERVICE`	Service instance for Queue.

Constructor Summary

Constructors
Constructor	Description
`QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static QueueClient.Builder`	`builder()`	Create a builder for this client.
`void`	`close()`
`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`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`String`	`getEndpoint()`
`GetMessagesResponse`	`getMessages(GetMessagesRequest request)`	Consumes messages from the queue.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`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.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`PutMessagesResponse`	`putMessages(PutMessagesRequest request)`	Puts messages into the queue.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`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’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`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 useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

Methods inherited from interface com.oracle.bmc.queue.Queue
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Queue.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - QueueClient
```
@Deprecated
public QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - QueueClient
```
@Deprecated
public QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - QueueClient
```
@Deprecated
public QueueClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - QueueClient
```
@Deprecated
public QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - QueueClient
```
@Deprecated
public QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - QueueClient
```
@Deprecated
public QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
  - QueueClient
```
@Deprecated
public QueueClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                   ClientConfiguration configuration,
                   ClientConfigurator clientConfigurator,
                   RequestSignerFactory defaultRequestSignerFactory,
                   Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                   List<ClientConfigurator> additionalClientConfigurators,
                   String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see QueueClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
    
    endpoint - ClientBuilderBase.endpoint(java.lang.String)
    
    signingStrategyRequestSignerFactories - ClientBuilderBase.signingStrategyRequestSignerFactories
- Method Detail
  - builder
```
public static QueueClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Queue
    
    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 Queue
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Queue
    
    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 Queue
    
    Parameters:
    
    regionId - The public region ID.
  - deleteMessage
```
public DeleteMessageResponse deleteMessage(DeleteMessageRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    deleteMessage in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteMessages
```
public DeleteMessagesResponse deleteMessages(DeleteMessagesRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    deleteMessages in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getMessages
```
public GetMessagesResponse getMessages(GetMessagesRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    getMessages in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getStats
```
public GetStatsResponse getStats(GetStatsRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    getStats in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listChannels
```
public ListChannelsResponse listChannels(ListChannelsRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    listChannels in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - putMessages
```
public PutMessagesResponse putMessages(PutMessagesRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    putMessages in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateMessage
```
public UpdateMessageResponse updateMessage(UpdateMessageRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    updateMessage in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateMessages
```
public UpdateMessagesResponse updateMessages(UpdateMessagesRequest request)
```
    Description copied from interface: Queue
    
    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.
    
    Specified by:
    
    updateMessages in interface Queue
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDefaultConfigurator
```
protected ClientConfigurator getDefaultConfigurator()
```
  - useRealmSpecificEndpointTemplate
```
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
```
    This method should be used to enable or disable the use of realm-specific endpoint template.
    The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
    
    Parameters:
    
    useOfRealmSpecificEndpointTemplateEnabled - This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
  - populateServiceParametersInEndpoint
```
public final void populateServiceParametersInEndpoint(String endpoint,
                                                      Map<String,Object> requiredParametersMap)
```
    Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
    The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
    
    Parameters:
    
    endpoint - The endpoint template in use
    
    requiredParametersMap - Map of parameter name as key and value set in request path or query parameter as value
  - updateBaseEndpoint
```
public final void updateBaseEndpoint(String endpoint)
```
    This method should be used for parameterized endpoint templates only.
    This does not include {region} and {secondLevelDomain} parameters.
    
    Parameters:
    
    endpoint - The updated endpoint to use
  - setEndpoint
```
public final void setEndpoint(String endpoint)
```
  - getEndpoint
```
public final String getEndpoint()
```
  - refreshClient
```
public final void refreshClient()
```
    Rebuild the backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class QueueClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.queue.Queue

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

QueueClient

QueueClient

QueueClient

QueueClient

QueueClient

QueueClient

QueueClient

Method Detail

builder

setRegion

setRegion

deleteMessage

deleteMessages

getMessages

getStats

listChannels

putMessages

updateMessage

updateMessages

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient