### YamlMime:JavaType
uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter"
fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter"
name: "CorrelationFilter"
nameWithType: "CorrelationFilter"
summary: "Represents a correlation filter expression."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.microsoft.azure.servicebus.rules.Filter?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 **CorrelationFilter**</br> extends <xref href=\"com.microsoft.azure.servicebus.rules.Filter?alt=com.microsoft.azure.servicebus.rules.Filter&text=Filter\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.CorrelationFilter()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.CorrelationFilter()"
  name: "CorrelationFilter()"
  nameWithType: "CorrelationFilter.CorrelationFilter()"
  summary: "Creates a correlation filter with null values for all fields."
  syntax: "public CorrelationFilter()"
  desc: "Creates a correlation filter with null values for all fields."
methods:
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.equals(java.lang.Object)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.equals(Object o)"
  name: "equals(Object o)"
  nameWithType: "CorrelationFilter.equals(Object o)"
  overridden: "java.lang.Object.equals(java.lang.Object)"
  parameters:
  - name: "o"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  syntax: "public boolean equals(Object o)"
  returns:
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getContentType()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getContentType()"
  name: "getContentType()"
  nameWithType: "CorrelationFilter.getContentType()"
  summary: "Gets the value of Content<wbr>Type property of a message this filter matches."
  syntax: "public String getContentType()"
  desc: "Gets the value of ContentType property of a message this filter matches."
  returns:
    description: "ContentType property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getCorrelationId()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getCorrelationId()"
  name: "getCorrelationId()"
  nameWithType: "CorrelationFilter.getCorrelationId()"
  summary: "Gets the value of correlation<wbr>Id property of a message this filter matches."
  syntax: "public String getCorrelationId()"
  desc: "Gets the value of correlationId property of a message this filter matches."
  returns:
    description: "correlation id this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getLabel()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getLabel()"
  name: "getLabel()"
  nameWithType: "CorrelationFilter.getLabel()"
  summary: "Gets the value of Label property of a message this filter matches."
  syntax: "public String getLabel()"
  desc: "Gets the value of Label property of a message this filter matches."
  returns:
    description: "Label property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getMessageId()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getMessageId()"
  name: "getMessageId()"
  nameWithType: "CorrelationFilter.getMessageId()"
  summary: "Gets the value of Message<wbr>Id property of a message this filter matches."
  syntax: "public String getMessageId()"
  desc: "Gets the value of MessageId property of a message this filter matches."
  returns:
    description: "message id this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getProperties()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getProperties()"
  name: "getProperties()"
  nameWithType: "CorrelationFilter.getProperties()"
  summary: "Gets a name to value map of custom properties on a message this filter matches."
  syntax: "public Map<String,Object> getProperties()"
  desc: "Gets a name to value map of custom properties on a message this filter matches."
  returns:
    description: "map of custom properties this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getReplyTo()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getReplyTo()"
  name: "getReplyTo()"
  nameWithType: "CorrelationFilter.getReplyTo()"
  summary: "Gets the value of Reply<wbr>To property of a message this filter matches."
  syntax: "public String getReplyTo()"
  desc: "Gets the value of ReplyTo property of a message this filter matches."
  returns:
    description: "ReplyTo property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getReplyToSessionId()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getReplyToSessionId()"
  name: "getReplyToSessionId()"
  nameWithType: "CorrelationFilter.getReplyToSessionId()"
  summary: "Gets the value of Reply<wbr>ToSession<wbr>Id property of a message this filter matches."
  syntax: "public String getReplyToSessionId()"
  desc: "Gets the value of ReplyToSessionId property of a message this filter matches."
  returns:
    description: "ReplyToSessionId property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getSessionId()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getSessionId()"
  name: "getSessionId()"
  nameWithType: "CorrelationFilter.getSessionId()"
  summary: "Gets the value of Session<wbr>Id property of a message this filter matches."
  syntax: "public String getSessionId()"
  desc: "Gets the value of SessionId property of a message this filter matches."
  returns:
    description: "SessionId property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getTo()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.getTo()"
  name: "getTo()"
  nameWithType: "CorrelationFilter.getTo()"
  summary: "Gets the value of To property of a message this filter matches."
  syntax: "public String getTo()"
  desc: "Gets the value of To property of a message this filter matches."
  returns:
    description: "To property value this filter matches"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.hashCode()"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.hashCode()"
  name: "hashCode()"
  nameWithType: "CorrelationFilter.hashCode()"
  overridden: "java.lang.Object.hashCode()"
  syntax: "public int hashCode()"
  returns:
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setContentType(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setContentType(String contentType)"
  name: "setContentType(String contentType)"
  nameWithType: "CorrelationFilter.setContentType(String contentType)"
  summary: "Sets the value of Content<wbr>Type property of a message this filter matches."
  parameters:
  - description: "ContentType property value this filter matches"
    name: "contentType"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setContentType(String contentType)"
  desc: "Sets the value of ContentType property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setCorrelationId(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setCorrelationId(String correlationId)"
  name: "setCorrelationId(String correlationId)"
  nameWithType: "CorrelationFilter.setCorrelationId(String correlationId)"
  summary: "Gets the value of Correlation<wbr>Id property of a message this filter matches."
  parameters:
  - description: "correlation id this filter matches"
    name: "correlationId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setCorrelationId(String correlationId)"
  desc: "Gets the value of CorrelationId property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setLabel(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setLabel(String label)"
  name: "setLabel(String label)"
  nameWithType: "CorrelationFilter.setLabel(String label)"
  summary: "Sets the value of Label property of a message this filter matches."
  parameters:
  - description: "Label property value this filter matches"
    name: "label"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setLabel(String label)"
  desc: "Sets the value of Label property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setMessageId(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setMessageId(String messageId)"
  name: "setMessageId(String messageId)"
  nameWithType: "CorrelationFilter.setMessageId(String messageId)"
  summary: "Sets the value of Message<wbr>Id property of a message this filter matches."
  parameters:
  - description: "message id this filter matches"
    name: "messageId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setMessageId(String messageId)"
  desc: "Sets the value of MessageId property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setProperties(java.util.Map<java.lang.String,java.lang.Object>)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setProperties(Map<String,Object> properties)"
  name: "setProperties(Map<String,Object> properties)"
  nameWithType: "CorrelationFilter.setProperties(Map<String,Object> properties)"
  summary: "Sets a name to value map of custom properties on a message this filter matches."
  parameters:
  - description: "map of custom properties this filter matches"
    name: "properties"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
  syntax: "public void setProperties(Map<String,Object> properties)"
  desc: "Sets a name to value map of custom properties on a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setReplyTo(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setReplyTo(String replyTo)"
  name: "setReplyTo(String replyTo)"
  nameWithType: "CorrelationFilter.setReplyTo(String replyTo)"
  summary: "Sets the value of Reply<wbr>To property of a message this filter matches."
  parameters:
  - description: "ReplyTo property value this filter matches"
    name: "replyTo"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setReplyTo(String replyTo)"
  desc: "Sets the value of ReplyTo property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setReplyToSessionId(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setReplyToSessionId(String replyToSessionId)"
  name: "setReplyToSessionId(String replyToSessionId)"
  nameWithType: "CorrelationFilter.setReplyToSessionId(String replyToSessionId)"
  summary: "Sets the value of Reply<wbr>ToSession<wbr>Id property of a message this filter matches."
  parameters:
  - description: "ReplyToSessionId property value this filter matches"
    name: "replyToSessionId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setReplyToSessionId(String replyToSessionId)"
  desc: "Sets the value of ReplyToSessionId property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setSessionId(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setSessionId(String sessionId)"
  name: "setSessionId(String sessionId)"
  nameWithType: "CorrelationFilter.setSessionId(String sessionId)"
  summary: "Sets the value of Session<wbr>Id property of a message this filter matches."
  parameters:
  - description: "SessionId property value this filter matches"
    name: "sessionId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setSessionId(String sessionId)"
  desc: "Sets the value of SessionId property of a message this filter matches."
- uid: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setTo(java.lang.String)"
  fullName: "com.microsoft.azure.servicebus.rules.CorrelationFilter.setTo(String to)"
  name: "setTo(String to)"
  nameWithType: "CorrelationFilter.setTo(String to)"
  summary: "Sets the value of To property of a message this filter matches."
  parameters:
  - description: "To property value this filter matches"
    name: "to"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public void setTo(String to)"
  desc: "Sets the value of To property of a message this filter matches."
type: "class"
desc: "Represents a correlation filter expression. A correlation filter is an efficient shortcut for declarations of filters that deal only with correlation equality of message properties. A correlation filter can be created to match one or more of standard or custom properties of a message. In the service, correlation filters are implemented as hashtable lookups. So they are much faster at run time than other types of filters."
metadata: {}
package: "com.microsoft.azure.servicebus.rules"
artifact: com.microsoft.azure:azure-servicebus:3.6.7