QueueProperties クラス

  • リファレンス
パッケージ:
com.azure.messaging.servicebus.administration.models
Maven 成果物:
com.azure:azure-messaging-servicebus:7.15.1
  • java.lang.Object
    • com.azure.messaging.servicebus.administration.models.QueueProperties

public final class QueueProperties

キューのプロパティ。

メソッドの概要

修飾子と型 メソッドと説明
List<AuthorizationRule> getAuthorizationRules()

authorizationRules プロパティを取得します。リソースの承認規則。
Duration getAutoDeleteOnIdle()

自動削除OnIdle プロパティを取得します。ISO 8601 timeSpan アイドル間隔後、キューは自動的に削除されます。
Duration getDefaultMessageTimeToLive()

既定の MessageTimeToLive プロパティを取得します。ISO 8601 の既定のメッセージ時間スパンがライブ値になります。
Duration getDuplicateDetectionHistoryTimeWindow()

重複検出履歴の時間枠プロパティを取得します。重複検出履歴の期間を定義する ISO 8601 タイムスパン構造。
String getForwardDeadLetteredMessagesTo()

[配信不能メッセージの転送先] プロパティを取得します。このキューのすべての配信不能メッセージの転送先となる受信者エンティティの名前。
String getForwardTo()

forwardTo プロパティを取得する: キューに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
Duration getLockDuration()

lockDuration プロパティを取得します。 ISO 8601 timespan duration of a peek-lock, つまり、メッセージが他の受信者に対してロックされている時間です。
int getMaxDeliveryCount()

[最大配信数] プロパティを取得します。最大配信数。
long getMaxMessageSizeInKilobytes()

最大メッセージサイズInKilobytes プロパティを取得します。メッセージの最大サイズ (キロバイト単位)。
long getMaxSizeInMegabytes()

キューの最大サイズを MB 単位で取得します。これは、キューに割り当てられたメモリのサイズです。
String getName()

キューの名前を取得します。
EntityStatus getStatus()

status プロパティを取得します。Service Bus リソースの状態。
String getUserMetadata()

ユーザーメタデータプロパティを取得する: ユーザーが説明に関連付けることができるカスタム metdata。
boolean isBatchedOperationsEnabled()

[バッチ処理操作の有効化] プロパティを取得します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
boolean isDeadLetteringOnMessageExpiration()

配信不能OnMessageExpiration プロパティを取得する: メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。
boolean isDuplicateDetectionRequired()

[requires Duplicate Detection]\(重複検出が必要\) プロパティを取得します。このキューで重複検出が必要かどうかを示す値。
boolean isPartitioningEnabled()

[パーティション分割の有効化] プロパティを取得します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値。
boolean isSessionRequired()

requiresSession プロパティを取得します。キューがセッションの概念をサポートしているかどうかを示す値です。
QueueProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

AutoDelete OnIdle プロパティを設定します。 ISO 8601 timeSpan idle interval after the queue is automatically deleted.
QueueProperties setBatchedOperationsEnabled(boolean enableBatchedOperations)

[バッチ処理操作の有効化] プロパティを設定します。サーバー側のバッチ処理操作が有効かどうかを示す値です。
QueueProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

配信不能OnMessageExpiration プロパティを設定する: メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値。
QueueProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

既定の MessageTimeToLive プロパティを設定します。ISO 8601 の既定のメッセージ期間をライブ値に設定します。
QueueProperties setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

[重複検出履歴の時間枠] プロパティを設定します。重複検出履歴の期間を定義する ISO 8601 タイムスパン構造。
QueueProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

forwardDeadLetteredMessagesTo プロパティを設定します。このキューのすべての配信不能メッセージの転送先となる受信者エンティティの名前。
QueueProperties setForwardTo(String forwardTo)

forwardTo プロパティを設定する: キューに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。
QueueProperties setLockDuration(Duration lockDuration)

lockDuration プロパティを設定します。 ISO 8601 timespan duration of a peek-lock, つまり、メッセージが他の受信者に対してロックされている時間です。
QueueProperties setMaxDeliveryCount(Integer maxDeliveryCount)

配信の最大数を設定します。
QueueProperties setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

最大メッセージサイズInKilobytes プロパティを設定します。メッセージの最大サイズ (キロバイト単位)。
QueueProperties setMaxSizeInMegabytes(Integer maxSizeInMegabytes)

最大サイズInMegabytes プロパティを設定します。キューの最大サイズ (MB 単位) は、キューに割り当てられたメモリのサイズです。
QueueProperties setStatus(EntityStatus status)

status プロパティを設定します。Service Bus リソースの状態。
QueueProperties setUserMetadata(String userMetadata)

ユーザーメタデータ プロパティを設定します。ユーザーが説明に関連付けることができるカスタム metdata。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

getAuthorizationRules

public List getAuthorizationRules()

authorizationRules プロパティを取得します。リソースの承認規則。

Returns:

authorizationRules 値。

getAutoDeleteOnIdle

public Duration getAutoDeleteOnIdle()

autoDeleteOnIdle プロパティを取得します。ISO 8601 timeSpan アイドル間隔後、キューが自動的に削除されます。 最小時間は、5 分です。

Returns:

autoDeleteOnIdle 値。

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

defaultMessageTimeToLive プロパティを取得します。ISO 8601 の既定のメッセージ時間スパンがライブ値になります。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

Returns:

defaultMessageTimeToLive 値。

getDuplicateDetectionHistoryTimeWindow

public Duration getDuplicateDetectionHistoryTimeWindow()

duplicateDetectionHistoryTimeWindow プロパティを取得します。重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

Returns:

duplicateDetectionHistoryTimeWindow 値。

getForwardDeadLetteredMessagesTo

public String getForwardDeadLetteredMessagesTo()

forwardDeadLetteredMessagesTo プロパティを取得します。このキューのすべての配信不能メッセージの転送先となる受信者エンティティの名前。

Returns:

forwardDeadLetteredMessagesTo 値。

getForwardTo

public String getForwardTo()

forwardTo プロパティを取得する: キューに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Returns:

forwardTo 値。

getLockDuration

public Duration getLockDuration()

lockDuration プロパティを取得します。ピーク ロックの期間は ISO 8601 です。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

Returns:

lockDuration 値。

getMaxDeliveryCount

public int getMaxDeliveryCount()

maxDeliveryCount プロパティを取得します。最大配信数。 この配信数の後に、メッセージは自動的に配信不能になります。 既定値は 10 です。

Returns:

maxDeliveryCount 値。

getMaxMessageSizeInKilobytes

public long getMaxMessageSizeInKilobytes()

maxMessageSizeInKilobytes プロパティを取得します。メッセージの最大サイズ (キロバイト単位)。

Returns:

maxMessageSizeInKilobytes 値。

getMaxSizeInMegabytes

public long getMaxSizeInMegabytes()

キューの最大サイズを MB 単位で取得します。これは、キューに割り当てられたメモリのサイズです。

Returns:

maxSizeInMegabytes 値。

getName

public String getName()

キューの名前を取得します。

Returns:

キューの名前。

getStatus

public EntityStatus getStatus()

status プロパティを取得します。Service Bus リソースの状態。

Returns:

状態の値。

getUserMetadata

public String getUserMetadata()

userMetadata プロパティを取得する: ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。

Returns:

userMetadata 値。

isBatchedOperationsEnabled

public boolean isBatchedOperationsEnabled()

enableBatchedOperations プロパティを取得します。サーバー側のバッチ処理操作が有効かどうかを示す値です。

Returns:

enableBatchedOperations 値。

isDeadLetteringOnMessageExpiration

public boolean isDeadLetteringOnMessageExpiration()

deadLetteringOnMessageExpiration プロパティを取得します。メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値です。

Returns:

deadLetteringOnMessageExpiration 値。

isDuplicateDetectionRequired

public boolean isDuplicateDetectionRequired()

requiresDuplicateDetection プロパティを取得します。このキューで重複検出が必要かどうかを示す値。

Returns:

requiresDuplicateDetection 値。

isPartitioningEnabled

public boolean isPartitioningEnabled()

enablePartitioning プロパティを取得します。キューを複数のメッセージ ブローカー間でパーティション分割するかどうかを示す値です。

Returns:

enablePartitioning 値。

isSessionRequired

public boolean isSessionRequired()

requiresSession プロパティを取得します。キューがセッションの概念をサポートしているかどうかを示す値です。

Returns:

にはSession 値が必要です。

setAutoDeleteOnIdle

public QueueProperties setAutoDeleteOnIdle(Duration autoDeleteOnIdle)

autoDeleteOnIdle プロパティを設定します。ISO 8601 timeSpan アイドル間隔後、キューが自動的に削除されます。 最小時間は、5 分です。

Parameters:

autoDeleteOnIdle - 設定する autoDeleteOnIdle 値。

Returns:

QueuePropertiesオブジェクト自体。

setBatchedOperationsEnabled

public QueueProperties setBatchedOperationsEnabled(boolean enableBatchedOperations)

enableBatchedOperations プロパティを設定します。サーバー側のバッチ処理操作が有効かどうかを示す値です。

Parameters:

enableBatchedOperations - 設定する enableBatchedOperations 値。

Returns:

QueuePropertiesオブジェクト自体。

setDeadLetteringOnMessageExpiration

public QueueProperties setDeadLetteringOnMessageExpiration(boolean deadLetteringOnMessageExpiration)

deadLetteringOnMessageExpiration プロパティを設定します。メッセージの有効期限が切れたときに、このキューで配信不能がサポートされているかどうかを示す値です。

Parameters:

deadLetteringOnMessageExpiration - 設定する deadLetteringOnMessageExpiration 値。

Returns:

QueuePropertiesオブジェクト自体。

setDefaultMessageTimeToLive

public QueueProperties setDefaultMessageTimeToLive(Duration defaultMessageTimeToLive)

defaultMessageTimeToLive プロパティを設定します。ISO 8601 の既定のメッセージ期間をライブ値に設定します。 これは、メッセージが Service Bus に送信されてからメッセージが期限切れになるまでの期間です。 これは、メッセージ自体に TimeToLive が設定されていない場合に使用される既定値です。

Parameters:

defaultMessageTimeToLive - 設定する defaultMessageTimeToLive 値。

Returns:

QueuePropertiesオブジェクト自体。

setDuplicateDetectionHistoryTimeWindow

public QueueProperties setDuplicateDetectionHistoryTimeWindow(Duration duplicateDetectionHistoryTimeWindow)

duplicateDetectionHistoryTimeWindow プロパティを設定します。重複検出履歴の期間を定義する ISO 8601 timeSpan 構造体。 既定値は 10 分です。

Parameters:

duplicateDetectionHistoryTimeWindow - 設定する duplicateDetectionHistoryTimeWindow 値。

Returns:

QueuePropertiesオブジェクト自体。

setForwardDeadLetteredMessagesTo

public QueueProperties setForwardDeadLetteredMessagesTo(String forwardDeadLetteredMessagesTo)

forwardDeadLetteredMessagesTo プロパティを設定します。このキューのすべての配信不能メッセージの転送先となる受信者エンティティの名前。

Parameters:

forwardDeadLetteredMessagesTo - 設定する forwardDeadLetteredMessagesTo 値。

Returns:

QueuePropertiesオブジェクト自体。

setForwardTo

public QueueProperties setForwardTo(String forwardTo)

forwardTo プロパティを設定する: キューに送信されるすべてのメッセージの転送先となる受信者エンティティの名前。

Parameters:

forwardTo - 設定する forwardTo 値。

Returns:

QueuePropertiesオブジェクト自体。

setLockDuration

public QueueProperties setLockDuration(Duration lockDuration)

lockDuration プロパティを設定します。ピーク ロックの期間は ISO 8601 です。つまり、メッセージが他の受信者に対してロックされている時間です。 LockDuration の最大値は 5 分です。既定値は 1 分です。

Parameters:

lockDuration - 設定する lockDuration 値。

Returns:

QueuePropertiesオブジェクト自体。

setMaxDeliveryCount

public QueueProperties setMaxDeliveryCount(Integer maxDeliveryCount)

配信の最大数を設定します。 この配信数の後に、メッセージは自動的に配信不能になります。 既定値は 10 です。

Parameters:

maxDeliveryCount - 設定する maxDeliveryCount 値。

Returns:

QueuePropertiesオブジェクト自体。

setMaxMessageSizeInKilobytes

public QueueProperties setMaxMessageSizeInKilobytes(long maxMessageSizeInKilobytes)

maxMessageSizeInKilobytes プロパティを設定します。メッセージの最大サイズ (キロバイト単位)。

Parameters:

maxMessageSizeInKilobytes - 設定する maxMessageSizeInKilobytes 値。

Returns:

QueueDescription オブジェクト自体。

setMaxSizeInMegabytes

public QueueProperties setMaxSizeInMegabytes(Integer maxSizeInMegabytes)

maxSizeInMegabytes プロパティを設定します。キューの最大サイズ (MB 単位) は、キューに割り当てられたメモリのサイズです。

Parameters:

maxSizeInMegabytes - 設定する maxSizeInMegabytes 値。

Returns:

QueuePropertiesオブジェクト自体。

setStatus

public QueueProperties setStatus(EntityStatus status)

status プロパティを設定します。Service Bus リソースの状態。

Parameters:

status - 設定する状態値。

Returns:

QueuePropertiesオブジェクト自体。

setUserMetadata

public QueueProperties setUserMetadata(String userMetadata)

userMetadata プロパティを設定します。ユーザーが説明に関連付けることができるカスタム metdata。 最大長は 1024 文字です。

Parameters:

userMetadata - 設定する userMetadata 値。

Returns:

QueuePropertiesオブジェクト自体。

適用対象