Package com.oracle.bmc.queue.model

Class CreateConsumerGroupDetails

java.lang.Object

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

com.oracle.bmc.queue.model.CreateConsumerGroupDetails

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

The information about a new consumer group.
Note: Objects should always be created or deserialized using the CreateConsumerGroupDetails.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 CreateConsumerGroupDetails.Builder, which maintain a set of all explicitly set fields called CreateConsumerGroupDetails.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	CreateConsumerGroupDetails.Builder

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
CreateConsumerGroupDetails(String displayName, String filter, String queueId, Boolean isEnabled, Integer deadLetterQueueDeliveryCount, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateConsumerGroupDetails.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()	The user-friendly name of 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.
Boolean	getIsEnabled()	Used to enable or disable the consumer group.
String	getQueueId()	The OCID of the associated queue.
int	hashCode()
CreateConsumerGroupDetails.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

CreateConsumerGroupDetails

@Deprecated
@ConstructorProperties({"displayName","filter","queueId","isEnabled","deadLetterQueueDeliveryCount","freeformTags","definedTags"})
public CreateConsumerGroupDetails(String displayName,
                                  String filter,
                                  String queueId,
                                  Boolean isEnabled,
                                  Integer deadLetterQueueDeliveryCount,
                                  Map<String,String> freeformTags,
                                  Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateConsumerGroupDetails.Builder builder()

Create a new builder.

toBuilder

public CreateConsumerGroupDetails.Builder toBuilder()

getDisplayName

public String getDisplayName()

The user-friendly name 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.

Returns:

the value

getQueueId

public String getQueueId()

The OCID of the associated queue.

Returns:

the value

getIsEnabled

public Boolean getIsEnabled()

Used to enable or disable the consumer group.

An enabled consumer group will have a lifecycle state of ACTIVE, while a disabled will have its state as INACTIVE.

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 specified, 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

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