Package com.oracle.bmc.queue.model

Class ConsumerGroup

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.queue.model.ConsumerGroup

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20210201")
public final class ConsumerGroup
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

A detailed representation of a consumer group.
Note: Objects should always be created or deserialized using the ConsumerGroup.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ConsumerGroup.Builder, which maintain a set of all explicitly set fields called ConsumerGroup.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ConsumerGroup.Builder
static class	ConsumerGroup.LifecycleState	The current state of the consumer group.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
ConsumerGroup(String id, String displayName, Date timeCreated, Date timeUpdated, ConsumerGroup.LifecycleState lifecycleState, String lifecycleDetails, String filter, String queueId, Integer deadLetterQueueDeliveryCount, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ConsumerGroup.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Integer	getDeadLetterQueueDeliveryCount()	The number of times a message can be delivered to a consumer before being moved to the dead letter queue.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDisplayName()	A user-friendly name for the consumer group.
String	getFilter()	The filter used by the consumer group.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	A unique identifier for the consumer group that is immutable on creation.
String	getLifecycleDetails()	Any additional details about the current state of the consumer group.
ConsumerGroup.LifecycleState	getLifecycleState()	The current state of the consumer group.
String	getQueueId()	The OCID of the associated queue.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeCreated()	The time that the consumer group was created, expressed in RFC 3339 timestamp format.
Date	getTimeUpdated()	The time that the consumer group was updated, expressed in RFC 3339 timestamp format.
int	hashCode()
ConsumerGroup.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ConsumerGroup

@Deprecated
@ConstructorProperties({"id","displayName","timeCreated","timeUpdated","lifecycleState","lifecycleDetails","filter","queueId","deadLetterQueueDeliveryCount","freeformTags","definedTags","systemTags"})
public ConsumerGroup(String id,
                     String displayName,
                     Date timeCreated,
                     Date timeUpdated,
                     ConsumerGroup.LifecycleState lifecycleState,
                     String lifecycleDetails,
                     String filter,
                     String queueId,
                     Integer deadLetterQueueDeliveryCount,
                     Map<String,String> freeformTags,
                     Map<String,Map<String,Object>> definedTags,
                     Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static ConsumerGroup.Builder builder()

Create a new builder.

toBuilder

public ConsumerGroup.Builder toBuilder()

getId

public String getId()

A unique identifier for the consumer group that is immutable on creation.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name for the consumer group.

It has to be unique within the same queue in a case-insensitive manner. It’s changeable. Avoid entering confidential information.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The time that the consumer group was created, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The time that the consumer group was updated, expressed in RFC 3339 timestamp format.

Example: 2018-04-20T00:00:07.405Z

Returns:

the value

getLifecycleState

public ConsumerGroup.LifecycleState getLifecycleState()

The current state of the consumer group.

Returns:

the value

getLifecycleDetails

public String getLifecycleDetails()

Any additional details about the current state of the consumer group.

Returns:

the value

getFilter

public String getFilter()

The filter used by the consumer group.

Only messages matching the filter will be available by consumers of the group. An empty value means that all messages will be available in the group.

Returns:

the value

getQueueId

public String getQueueId()

The OCID of the associated queue.

Returns:

the value

getDeadLetterQueueDeliveryCount

public Integer getDeadLetterQueueDeliveryCount()

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. If the value isn’t set, it will be using the value defined at the queue level.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel