com.azure.messaging.servicebus.ServiceBusRuleManagerClient.yml

### YamlMime:JavaType
uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient"
fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient"
name: "ServiceBusRuleManagerClient"
nameWithType: "ServiceBusRuleManagerClient"
summary: "A **synchronous** rule manager responsible for managing rules for a specific topic subscription."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public class **ServiceBusRuleManagerClient**</br> implements <a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
methods:
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.close()"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.close()"
  name: "close()"
  nameWithType: "ServiceBusRuleManagerClient.close()"
  summary: "Disposes of the <xref uid=\"com.azure.messaging.servicebus.ServiceBusRuleManagerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusRuleManagerClient\"></xref>."
  syntax: "public void close()"
  desc: "Disposes of the <xref uid=\"com.azure.messaging.servicebus.ServiceBusRuleManagerClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusRuleManagerClient\"></xref>. If the client has a dedicated connection, the underlying connection is also closed."
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.createRule(java.lang.String,com.azure.messaging.servicebus.administration.models.CreateRuleOptions)"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.createRule(String ruleName, CreateRuleOptions options)"
  name: "createRule(String ruleName, CreateRuleOptions options)"
  nameWithType: "ServiceBusRuleManagerClient.createRule(String ruleName, CreateRuleOptions options)"
  summary: "Creates a rule to the current subscription to filter the messages reaching from topic to the subscription."
  parameters:
  - description: "Name of rule."
    name: "ruleName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The options for the rule to add."
    name: "options"
    type: "<xref href=\"com.azure.messaging.servicebus.administration.models.CreateRuleOptions?alt=com.azure.messaging.servicebus.administration.models.CreateRuleOptions&text=CreateRuleOptions\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public void createRule(String ruleName, CreateRuleOptions options)"
  desc: "Creates a rule to the current subscription to filter the messages reaching from topic to the subscription."
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.deleteRule(java.lang.String)"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.deleteRule(String ruleName)"
  name: "deleteRule(String ruleName)"
  nameWithType: "ServiceBusRuleManagerClient.deleteRule(String ruleName)"
  summary: "Removes the rule on the subscription identified by `ruleName`."
  parameters:
  - description: "Name of rule to delete."
    name: "ruleName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void deleteRule(String ruleName)"
  desc: "Removes the rule on the subscription identified by `ruleName`."
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.getEntityPath()"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.getEntityPath()"
  name: "getEntityPath()"
  nameWithType: "ServiceBusRuleManagerClient.getEntityPath()"
  summary: "Gets the name of the Service Bus resource."
  syntax: "public String getEntityPath()"
  desc: "Gets the name of the Service Bus resource."
  returns:
    description: "The name of the Service Bus resource."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.getFullyQualifiedNamespace()"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.getFullyQualifiedNamespace()"
  name: "getFullyQualifiedNamespace()"
  nameWithType: "ServiceBusRuleManagerClient.getFullyQualifiedNamespace()"
  summary: "Gets the fully qualified namespace."
  syntax: "public String getFullyQualifiedNamespace()"
  desc: "Gets the fully qualified namespace."
  returns:
    description: "The fully qualified namespace."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.listRules()"
  fullName: "com.azure.messaging.servicebus.ServiceBusRuleManagerClient.listRules()"
  name: "listRules()"
  nameWithType: "ServiceBusRuleManagerClient.listRules()"
  summary: "Fetches all rules associated with the topic and subscription."
  syntax: "public IterableStream<RuleProperties> listRules()"
  desc: "Fetches all rules associated with the topic and subscription."
  returns:
    description: "A list of rules associated with the topic and subscription."
    type: "<xref href=\"com.azure.core.util.IterableStream?alt=com.azure.core.util.IterableStream&text=IterableStream\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.messaging.servicebus.administration.models.RuleProperties?alt=com.azure.messaging.servicebus.administration.models.RuleProperties&text=RuleProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "class"
desc: "A **synchronous** rule manager responsible for managing rules for a specific topic subscription. The rule manager requires only Listen claims, whereas the <xref uid=\"com.azure.messaging.servicebus.administration.ServiceBusAdministrationAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ServiceBusAdministrationAsyncClient\"></xref> requires Manage claims.\n\n**Create a rule to a Service Bus subscription**\n\n```java\nTokenCredential credential = new DefaultAzureCredentialBuilder().build();\n\n // 'fullyQualifiedNamespace' will look similar to \"{your-namespace}.servicebus.windows.net\"\n ServiceBusRuleManagerClient ruleManager = new ServiceBusClientBuilder()\n     .credential(fullyQualifiedNamespace, credential)\n     .ruleManager()\n     .topicName(topicName)\n     .subscriptionName(subscriptionName)\n     .buildClient();\n\n RuleFilter trueRuleFilter = new TrueRuleFilter();\n CreateRuleOptions options = new CreateRuleOptions(trueRuleFilter);\n ruleManager.createRule(\"new-rule\", options);\n\n // Dispose of the ruleManager when finished using it.\n ruleManager.close();\n```"
implements:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html\">AutoCloseable</a>"
metadata: {}
package: "com.azure.messaging.servicebus"
artifact: com.azure:azure-messaging-servicebus:7.17.0