Queue.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.queue.model.Queue.Builder

Enclosing class:: Queue

public static class Queue.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Queue`	`build()`
`Queue.Builder`	`channelConsumptionLimit(Integer channelConsumptionLimit)` The percentage of allocated queue resources that can be consumed by a single channel.
`Queue.Builder`	`compartmentId(String compartmentId)` The OCID of the compartment containing the queue.
`Queue.Builder`	`copy(Queue model)`
`Queue.Builder`	`customEncryptionKeyId(String customEncryptionKeyId)` The OCID of the custom encryption key to be used to encrypt messages content.
`Queue.Builder`	`deadLetterQueueDeliveryCount(Integer deadLetterQueueDeliveryCount)` The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
`Queue.Builder`	`definedTags(Map<String,Map<String,Object>> definedTags)` Defined tags for this resource.
`Queue.Builder`	`displayName(String displayName)` A user-friendly name for the queue.
`Queue.Builder`	`freeformTags(Map<String,String> freeformTags)` Simple key-value pair that is applied without any predefined name, type or scope.
`Queue.Builder`	`id(String id)` A unique identifier for the queue that is immutable on creation.
`Queue.Builder`	`lifecycleDetails(String lifecycleDetails)` Any additional details about the current state of the queue.
`Queue.Builder`	`lifecycleState(Queue.LifecycleState lifecycleState)` The current state of the queue.
`Queue.Builder`	`messagesEndpoint(String messagesEndpoint)` The endpoint to use to consume or publish messages in the queue.
`Queue.Builder`	`retentionInSeconds(Integer retentionInSeconds)` The retention period of the messages in the queue, in seconds.
`Queue.Builder`	`systemTags(Map<String,Map<String,Object>> systemTags)` Usage of system tag keys.
`Queue.Builder`	`timeCreated(Date timeCreated)` The time that the queue was created, expressed in RFC 3339 timestamp format.
`Queue.Builder`	`timeoutInSeconds(Integer timeoutInSeconds)` The default polling timeout of the messages in the queue, in seconds.
`Queue.Builder`	`timeUpdated(Date timeUpdated)` The time that the queue was updated, expressed in RFC 3339 timestamp format.
`Queue.Builder`	`visibilityInSeconds(Integer visibilityInSeconds)` The default visibility timeout of the messages consumed from the queue, in seconds.

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

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - id
```
public Queue.Builder id(String id)
```
    A unique identifier for the queue that is immutable on creation.
    
    Parameters:
    
    id - the value to set
    
    Returns:
    
    this builder
  - displayName
```
public Queue.Builder displayName(String displayName)
```
    A user-friendly name for the queue. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
    
    Parameters:
    
    displayName - the value to set
    
    Returns:
    
    this builder
  - compartmentId
```
public Queue.Builder compartmentId(String compartmentId)
```
    The OCID of the compartment containing the queue.
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - timeCreated
```
public Queue.Builder timeCreated(Date timeCreated)
```
    The time that the queue was created, expressed in RFC 3339 timestamp format.
    
    Example: 2018-04-20T00:00:07.405Z
    
    Parameters:
    
    timeCreated - the value to set
    
    Returns:
    
    this builder
  - timeUpdated
```
public Queue.Builder timeUpdated(Date timeUpdated)
```
    The time that the queue was updated, expressed in RFC 3339 timestamp format.
    
    Example: 2018-04-20T00:00:07.405Z
    
    Parameters:
    
    timeUpdated - the value to set
    
    Returns:
    
    this builder
  - lifecycleState
```
public Queue.Builder lifecycleState(Queue.LifecycleState lifecycleState)
```
    The current state of the queue.
    
    Parameters:
    
    lifecycleState - the value to set
    
    Returns:
    
    this builder
  - lifecycleDetails
```
public Queue.Builder lifecycleDetails(String lifecycleDetails)
```
    Any additional details about the current state of the queue.
    
    Parameters:
    
    lifecycleDetails - the value to set
    
    Returns:
    
    this builder
  - messagesEndpoint
```
public Queue.Builder messagesEndpoint(String messagesEndpoint)
```
    The endpoint to use to consume or publish messages in the queue.
    
    Parameters:
    
    messagesEndpoint - the value to set
    
    Returns:
    
    this builder
  - retentionInSeconds
```
public Queue.Builder retentionInSeconds(Integer retentionInSeconds)
```
    The retention period of the messages in the queue, in seconds.
    
    Parameters:
    
    retentionInSeconds - the value to set
    
    Returns:
    
    this builder
  - visibilityInSeconds
```
public Queue.Builder visibilityInSeconds(Integer visibilityInSeconds)
```
    The default visibility timeout of the messages consumed from the queue, in seconds.
    
    Parameters:
    
    visibilityInSeconds - the value to set
    
    Returns:
    
    this builder
  - timeoutInSeconds
```
public Queue.Builder timeoutInSeconds(Integer timeoutInSeconds)
```
    The default polling timeout of the messages in the queue, in seconds.
    
    Parameters:
    
    timeoutInSeconds - the value to set
    
    Returns:
    
    this builder
  - deadLetterQueueDeliveryCount
```
public Queue.Builder deadLetterQueueDeliveryCount(Integer deadLetterQueueDeliveryCount)
```
    The number of times a message can be delivered to a consumer before being moved to the dead letter queue. A value of 0 indicates that the DLQ is not used.
    
    Parameters:
    
    deadLetterQueueDeliveryCount - the value to set
    
    Returns:
    
    this builder
  - customEncryptionKeyId
```
public Queue.Builder customEncryptionKeyId(String customEncryptionKeyId)
```
    The OCID of the custom encryption key to be used to encrypt messages content.
    
    Parameters:
    
    customEncryptionKeyId - the value to set
    
    Returns:
    
    this builder
  - freeformTags
```
public Queue.Builder freeformTags(Map<String,String> freeformTags)
```
    Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
    
    Parameters:
    
    freeformTags - the value to set
    
    Returns:
    
    this builder
  - definedTags
```
public Queue.Builder definedTags(Map<String,Map<String,Object>> definedTags)
```
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
    
    Parameters:
    
    definedTags - the value to set
    
    Returns:
    
    this builder
  - systemTags
```
public Queue.Builder systemTags(Map<String,Map<String,Object>> systemTags)
```
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud": {"free-tier-retained": "true"}}
    
    Parameters:
    
    systemTags - the value to set
    
    Returns:
    
    this builder
  - channelConsumptionLimit
```
public Queue.Builder channelConsumptionLimit(Integer channelConsumptionLimit)
```
    The percentage of allocated queue resources that can be consumed by a single channel. For example, if a queue has a storage limit of 2Gb, and a single channel consumption limit is 0.1 (10%), that means data size of a single channel can’t exceed 200Mb. Consumption limit of 100% (default) means that a single channel can consume up-to all allocated queue’s resources.
    
    Parameters:
    
    channelConsumptionLimit - the value to set
    
    Returns:
    
    this builder
  - build
```
public Queue build()
```
  - copy
```
public Queue.Builder copy(Queue model)
```

Class Queue.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

id

displayName

compartmentId

timeCreated

timeUpdated

lifecycleState

lifecycleDetails

messagesEndpoint

retentionInSeconds

visibilityInSeconds

timeoutInSeconds

deadLetterQueueDeliveryCount

customEncryptionKeyId

freeformTags

definedTags

systemTags

channelConsumptionLimit

build

copy