SBTopicInner Class

Package:

com.azure.resourcemanager.servicebus.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-servicebus:2.46.0

• java.lang.Object
• • com.azure.core.management.ProxyResource
  • • com.azure.core.management.Resource
    • • com.azure.resourcemanager.servicebus.fluent.models.SBTopicInner

public final class SBTopicInner
extends Resource

Description of topic resource.

Constructor Summary

Constructor	Description
SBTopicInner()	Creates an instance of SBTopicInner class.

Method Summary

Modifier and Type	Method and Description
OffsetDateTime	accessedAt() Get the accessedAt property: Last time the message was sent, or a request was received, for this topic.
Duration	autoDeleteOnIdle() Get the autoDeleteOnIdle property: ISO 8601 timespan idle interval after which the topic is automatically deleted.
MessageCountDetails	countDetails() Get the countDetails property: Message count details.
OffsetDateTime	createdAt() Get the createdAt property: Exact time the message was created.
Duration	defaultMessageTimeToLive() Get the defaultMessageTimeToLive property: ISO 8601 Default message timespan to live value.
Duration	duplicateDetectionHistoryTimeWindow() Get the duplicateDetectionHistoryTimeWindow property: ISO8601 timespan structure that defines the duration of the duplicate detection history.
Boolean	enableBatchedOperations() Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
Boolean	enableExpress() Get the enableExpress property: Value that indicates whether Express Entities are enabled.
Boolean	enablePartitioning() Get the enablePartitioning property: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
static SBTopicInner	fromJson(JsonReader jsonReader) Reads an instance of SBTopicInner from the JsonReader.
String	id() Get the id property: Fully qualified resource Id for the resource.
String	location() Get the location property: The geo-location where the resource lives.
Long	maxMessageSizeInKilobytes() Get the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the topic.
Integer	maxSizeInMegabytes() Get the maxSizeInMegabytes property: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic.
String	name() Get the name property: The name of the resource.
Boolean	requiresDuplicateDetection() Get the requiresDuplicateDetection property: Value indicating if this topic requires duplicate detection.
Long	sizeInBytes() Get the sizeInBytes property: Size of the topic, in bytes.
EntityStatus	status() Get the status property: Enumerates the possible values for the status of a messaging entity.
Integer	subscriptionCount() Get the subscriptionCount property: Number of subscriptions.
Boolean	supportOrdering() Get the supportOrdering property: Value that indicates whether the topic supports ordering.
SystemData	systemData() Get the systemData property: The system meta data relating to this resource.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: The type of the resource.
OffsetDateTime	updatedAt() Get the updatedAt property: The exact time the message was updated.
void	validate() Validates the instance.
SBTopicInner	withAutoDeleteOnIdle(Duration autoDeleteOnIdle) Set the autoDeleteOnIdle property: ISO 8601 timespan idle interval after which the topic is automatically deleted.
SBTopicInner	withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive) Set the defaultMessageTimeToLive property: ISO 8601 Default message timespan to live value.
SBTopicInner	withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow) Set the duplicateDetectionHistoryTimeWindow property: ISO8601 timespan structure that defines the duration of the duplicate detection history.
SBTopicInner	withEnableBatchedOperations(Boolean enableBatchedOperations) Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.
SBTopicInner	withEnableExpress(Boolean enableExpress) Set the enableExpress property: Value that indicates whether Express Entities are enabled.
SBTopicInner	withEnablePartitioning(Boolean enablePartitioning) Set the enablePartitioning property: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.
SBTopicInner	withMaxMessageSizeInKilobytes(Long maxMessageSizeInKilobytes) Set the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the topic.
SBTopicInner	withMaxSizeInMegabytes(Integer maxSizeInMegabytes) Set the maxSizeInMegabytes property: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic.
SBTopicInner	withRequiresDuplicateDetection(Boolean requiresDuplicateDetection) Set the requiresDuplicateDetection property: Value indicating if this topic requires duplicate detection.
SBTopicInner	withStatus(EntityStatus status) Set the status property: Enumerates the possible values for the status of a messaging entity.
SBTopicInner	withSupportOrdering(Boolean supportOrdering) Set the supportOrdering property: Value that indicates whether the topic supports ordering.

Methods inherited from ProxyResource

id name type

Methods inherited from Resource

fromJson location tags toJson withLocation withTags

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SBTopicInner

public SBTopicInner()

Creates an instance of SBTopicInner class.

Method Details

accessedAt

public OffsetDateTime accessedAt()

Get the accessedAt property: Last time the message was sent, or a request was received, for this topic.

Returns:

the accessedAt value.

autoDeleteOnIdle

public Duration autoDeleteOnIdle()

Get the autoDeleteOnIdle property: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

Returns:

the autoDeleteOnIdle value.

countDetails

public MessageCountDetails countDetails()

Get the countDetails property: Message count details.

Returns:

the countDetails value.

createdAt

public OffsetDateTime createdAt()

Get the createdAt property: Exact time the message was created.

Returns:

the createdAt value.

defaultMessageTimeToLive

public Duration defaultMessageTimeToLive()

Get the defaultMessageTimeToLive property: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

Returns:

the defaultMessageTimeToLive value.

duplicateDetectionHistoryTimeWindow

public Duration duplicateDetectionHistoryTimeWindow()

Get the duplicateDetectionHistoryTimeWindow property: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Returns:

the duplicateDetectionHistoryTimeWindow value.

enableBatchedOperations

public Boolean enableBatchedOperations()

Get the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Returns:

the enableBatchedOperations value.

enableExpress

public Boolean enableExpress()

Get the enableExpress property: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

Returns:

the enableExpress value.

enablePartitioning

public Boolean enablePartitioning()

Get the enablePartitioning property: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

Returns:

the enablePartitioning value.

fromJson

public static SBTopicInner fromJson(JsonReader jsonReader)

Reads an instance of SBTopicInner from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SBTopicInner if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

id

public String id()

Get the id property: Fully qualified resource Id for the resource.

Overrides:

SBTopicInner.id()

Returns:

the id value.

location

public String location()

Get the location property: The geo-location where the resource lives.

Overrides:

SBTopicInner.location()

Returns:

the location value.

maxMessageSizeInKilobytes

public Long maxMessageSizeInKilobytes()

Get the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

Returns:

the maxMessageSizeInKilobytes value.

maxSizeInMegabytes

public Integer maxSizeInMegabytes()

Get the maxSizeInMegabytes property: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

Returns:

the maxSizeInMegabytes value.

name

public String name()

Get the name property: The name of the resource.

Overrides:

SBTopicInner.name()

Returns:

the name value.

requiresDuplicateDetection

public Boolean requiresDuplicateDetection()

Get the requiresDuplicateDetection property: Value indicating if this topic requires duplicate detection.

Returns:

the requiresDuplicateDetection value.

sizeInBytes

public Long sizeInBytes()

Get the sizeInBytes property: Size of the topic, in bytes.

Returns:

the sizeInBytes value.

status

public EntityStatus status()

Get the status property: Enumerates the possible values for the status of a messaging entity.

Returns:

the status value.

subscriptionCount

public Integer subscriptionCount()

Get the subscriptionCount property: Number of subscriptions.

Returns:

the subscriptionCount value.

supportOrdering

public Boolean supportOrdering()

Get the supportOrdering property: Value that indicates whether the topic supports ordering.

Returns:

the supportOrdering value.

systemData

public SystemData systemData()

Get the systemData property: The system meta data relating to this resource.

Returns:

the systemData value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SBTopicInner.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: The type of the resource.

Overrides:

SBTopicInner.type()

Returns:

the type value.

updatedAt

public OffsetDateTime updatedAt()

Get the updatedAt property: The exact time the message was updated.

Returns:

the updatedAt value.

validate

public void validate()

Validates the instance.

withAutoDeleteOnIdle

public SBTopicInner withAutoDeleteOnIdle(Duration autoDeleteOnIdle)

Set the autoDeleteOnIdle property: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration is 5 minutes.

Parameters:

autoDeleteOnIdle - the autoDeleteOnIdle value to set.

Returns:

the SBTopicInner object itself.

withDefaultMessageTimeToLive

public SBTopicInner withDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

Set the defaultMessageTimeToLive property: ISO 8601 Default message timespan to live value. This is the duration after which the message expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not set on a message itself.

Parameters:

defaultMessageTimeToLive - the defaultMessageTimeToLive value to set.

Returns:

the SBTopicInner object itself.

withDuplicateDetectionHistoryTimeWindow

public SBTopicInner withDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

Set the duplicateDetectionHistoryTimeWindow property: ISO8601 timespan structure that defines the duration of the duplicate detection history. The default value is 10 minutes.

Parameters:

duplicateDetectionHistoryTimeWindow - the duplicateDetectionHistoryTimeWindow value to set.

Returns:

the SBTopicInner object itself.

withEnableBatchedOperations

public SBTopicInner withEnableBatchedOperations(Boolean enableBatchedOperations)

Set the enableBatchedOperations property: Value that indicates whether server-side batched operations are enabled.

Parameters:

enableBatchedOperations - the enableBatchedOperations value to set.

Returns:

the SBTopicInner object itself.

withEnableExpress

public SBTopicInner withEnableExpress(Boolean enableExpress)

Set the enableExpress property: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory temporarily before writing it to persistent storage.

Parameters:

enableExpress - the enableExpress value to set.

Returns:

the SBTopicInner object itself.

withEnablePartitioning

public SBTopicInner withEnablePartitioning(Boolean enablePartitioning)

Set the enablePartitioning property: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled.

Parameters:

enablePartitioning - the enablePartitioning value to set.

Returns:

the SBTopicInner object itself.

withMaxMessageSizeInKilobytes

public SBTopicInner withMaxMessageSizeInKilobytes(Long maxMessageSizeInKilobytes)

Set the maxMessageSizeInKilobytes property: Maximum size (in KB) of the message payload that can be accepted by the topic. This property is only used in Premium today and default is 1024.

Parameters:

maxMessageSizeInKilobytes - the maxMessageSizeInKilobytes value to set.

Returns:

the SBTopicInner object itself.

withMaxSizeInMegabytes

public SBTopicInner withMaxSizeInMegabytes(Integer maxSizeInMegabytes)

Set the maxSizeInMegabytes property: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. Default is 1024.

Parameters:

maxSizeInMegabytes - the maxSizeInMegabytes value to set.

Returns:

the SBTopicInner object itself.

withRequiresDuplicateDetection

public SBTopicInner withRequiresDuplicateDetection(Boolean requiresDuplicateDetection)

Set the requiresDuplicateDetection property: Value indicating if this topic requires duplicate detection.

Parameters:

requiresDuplicateDetection - the requiresDuplicateDetection value to set.

Returns:

the SBTopicInner object itself.

withStatus

public SBTopicInner withStatus(EntityStatus status)

Set the status property: Enumerates the possible values for the status of a messaging entity.

Parameters:

status - the status value to set.

Returns:

the SBTopicInner object itself.

withSupportOrdering

public SBTopicInner withSupportOrdering(Boolean supportOrdering)

Set the supportOrdering property: Value that indicates whether the topic supports ordering.

Parameters:

supportOrdering - the supportOrdering value to set.

Returns:

the SBTopicInner object itself.