spotbugs-exclude.xml

<?xml version="1.0" encoding="UTF-8"?>

<FindBugsFilter>
  <!-- These existing KeyVault Attribute APIs return their super class rather than the actual type. -->
  <Match>
    <Class name="~com\.microsoft\.azure\.keyvault\.requests\.\w+Request"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- These keyvault models are already publicly released APIs with name matching the simple name of superclass -->
  <Match>
    <Class
      name="~com\.microsoft\.azure\.keyvault\.models\.(CertificateBundle|CertificateOperation|IssuerBundle|KeyBundle|SecretBundle)"/>
    <Bug pattern="NM_SAME_SIMPLE_NAME_AS_SUPERCLASS"/>
  </Match>

  <!-- Cryptographic algorithms are publicly released APIs with incorrect name casing. -->
  <Match>
    <Or>
      <Class name="~com\.microsoft\.azure\.keyvault\.cryptography\.algorithms\.(Aes|Rsa)(.+)"/>
      <Class name="~com\.microsoft\.azure\.keyvault\.cryptography\.(.+)Algorithm"/>
    </Or>
    <Method name="~(CreateDecryptor|CreateEncryptor)"/>
    <Bug pattern="NM_METHOD_NAMING_CONVENTION"/>
  </Match>

  <!-- KeyVaultKey.DecryptResultTransform and SignResultTransform were not created with the
  intention that a null could be passed in. In the original code, it would have thrown a
  NullReferenceException. -->
  <Match>
    <Class name="~com\.microsoft\.azure\.keyvault\.extensions\.KeyVaultKey\$[\w]+"/>
    <Bug pattern="NP_PARAMETER_MUST_BE_NONNULL_BUT_MARKED_AS_NULLABLE"/>
  </Match>

  <!-- Ignoring dropped exception and catch Exception because it existed in current SDK when migrated. -->
  <Match>
    <Class name="~com\.microsoft\.azure\.keyvault\.extensions\.CachingKeyResolver\$[0-9]+"/>
    <Method name="run"/>
    <Bug pattern="DE_MIGHT_IGNORE"/>
  </Match>

  <!-- Protected field already exists in the public API surface area even though it is unused. -->
  <Match>
    <Class name="com.microsoft.azure.keyvault.cryptography.EcKey"/>
    <Field name="defaultEncryptionAlgorithm"/>
    <Bug pattern="UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Defines native api, doesn't follow java style.-->
  <Match>
    <Class name="~com\.azure\.identity\.implementation\.WindowsCredentialApi(.+)"/>
    <Bug pattern="UUF_UNUSED_PUBLIC_OR_PROTECTED_FIELD,
      UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD,
      NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Internal implementation details, not at risk.-->
  <Match>
    <Class name="~com\.azure\.identity\.implementation\.intellij\.IntelliJKdbxMetadata"/>
    <Bug pattern="EI_EXPOSE_REP,
      EI_EXPOSE_REP2"/>
  </Match>

  <Match>
    <Class name="~com\.azure\.identity\.implementation\.intellij\.IntelliJKdbxDatabase"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH"/>
  </Match>

  <!-- Third party source code files, kept as it is.-->
  <Match>
    <Class name="~com\.azure\.identity\.implementation\.intellij\.LittleEndianDataInputStream"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <Match>
    <Class name="~com\.azure\.identity\.implementation\.intellij\.Salsa20"/>
    <Bug pattern="DM_DEFAULT_ENCODING"/>
  </Match>

  <!-- Exception needs to be caught here.-->
  <Match>
    <Class name="~com\.azure\.identity\.implementation\.VisualStudioCacheAccessor"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Exception needs to be caught here.-->
  <Match>
    <Class name="~com\.azure\.identity\.IntelliJCredential"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Accesses native api, doesn't follow java style.-->
  <Match>
    <Class name="~com\.azure\.identity\.implementation\.LinuxKeyRingAccessor(.+)"/>
    <Bug pattern="UWF_UNWRITTEN_FIELD"/>
  </Match>

  <!-- Accesses native api, doesn't follow java style.-->
  <Match>
    <Class name="com.azure.identity.implementation.WindowsCredentialAccessor"/>
    <Bug pattern="NP_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Public field already exists in the public API surface. -->
  <Match>
    <Class name="com.microsoft.azure.batch.auth.BatchUserTokenCredentials"/>
    <Method name="username"/>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- These KeyVault classes are publicly released APIs that intentionally return null rather than an empty array. -->
  <Match>
    <Class name="~com\.microsoft\.azure\.keyvault\.(cryptography|models|webkey)\.[\w]+"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Cases where null arrays should return null instead of empty arrays -->
  <Match>
    <Or>
      <Class name="com.azure.core.util.Base64Url"/>
      <Class name="com.azure.core.util.CoreUtils"/>
      <Class name="com.azure.core.implementation.serializer.HttpResponseDecodeData"/>
      <Class name="com.azure.core.util.serializer.JacksonAdapter"/>
      <And>
        <Class name="com.microsoft.azure.servicebus.Utils"/>
        <Method name="getDataFromMessageBody"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.keys.implementation.Base64UrlJsonDeserializer"/>
        <Method name="deserialize"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.keys.implementation.ByteExtensions"/>
        <Method name="clone"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.keys.models.KeyProperties"/>
        <Method name="decode"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.certificates.models.webkey.Base64UrlJsonDeserializer"/>
        <Method name="deserialize"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.certificates.models.webkey.ByteExtensions"/>
        <Method name="clone"/>
      </And>
      <And>
        <Class name="com.azure.security.keyvault.certificates.models.CertificateProperties"/>
        <Method name="getX509Thumbprint"/>
      </And>
    </Or>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

 <!--False positive: https://github.com/spotbugs/spotbugs/issues/1219-->
  <Match>
    <Class name="com.azure.core.implementation.jackson.ObjectMapperShim"/>
    <Method name="createJsonMapper"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- Suppress non-null warning in the case that we change the code and it is possible for
  KeyVaultCredentials.getAuthenticationCredentials to return null. -->
  <Match>
    <Or>
      <Class name="com.azure.core.util.CoreUtils"/> <!-- false positive -->
      <Class name="com.microsoft.azure.keyvault.authentication.KeyVaultCredentials"/>
      <Class name="com.azure.storage.blob.FileTransferExample"/>
    </Or>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <!-- Suppress Redundant nullcheck error for JreCertificates$JREKeyStore.loadKeyStore(KeyStore). -->
  <Match>
    <Or>
      <Class name="com.azure.security.keyvault.jca.implementation.JREKeyStoreFactory"/> <!-- false positive -->
    </Or>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>


  <Match>
    <Or>
      <Class name="com.azure.core.util.CoreUtils"/> <!-- false positive -->
    </Or>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <!-- These KeyVaultClientBase methods are made synchronous by blocking and waiting for a result. They do not return
  anything, so it can be ignored. -->
  <Match>
    <Class name="com.microsoft.azure.keyvault.implementation.KeyVaultClientBaseImpl"/>
    <Method name="~(purgeDeletedCertificate|purgeDeletedKey|purgeDeletedSecret|purgeDeletedStorageAccount)"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!-- These autorest generated APIs for existing Azure SDK components supports Java 7. Suppressing error for using
  anonymous inner classes. -->
  <Match>
    <Class name="~com\.microsoft\.azure\.(.+)Impl"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <!-- KeyVaultCredential values manipulated do not need to be localised. They are base64 encoded or URL encoded.-->
  <Match>
    <Class name="com.microsoft.azure.keyvault.authentication.KeyVaultCredentials"/>
    <Method name="~(extractChallenge|isValidChallenge|supportsMessageProtection)"/>
    <Bug pattern="DM_CONVERT_CASE"/>
  </Match>

  <!-- HTTP header, "content-type" is not localised. -->
  <Match>
    <Class name="com.microsoft.azure.keyvault.messagesecurity.HttpMessageSecurity"/>
    <Method name="unprotectResponse"/>
    <Bug pattern="DM_CONVERT_CASE"/>
  </Match>

  <!-- HTTP header, "ocp-date" is not localised. -->
  <Match>
    <Class name="com.microsoft.azure.batch.auth.BatchSharedKeyCredentialsInterceptor"/>
    <Method name="signHeader"/>
    <Bug pattern="DM_CONVERT_CASE"/>
  </Match>

  <!-- Known issue in autorest where it will generate a variable with a value of null.
  https://github.com/Azure/autorest.java/issues/324 -->
  <Match>
    <Or>
      <Class name="~com\.microsoft\.azure\.(.+)Impl"/>
      <Class name="~com\.azure\.(.+)Impl"/>
      <Class name="com.azure.core.util.CoreUtils"/>
    </Or>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE"/>
  </Match>

  <!-- Public field already exists in the public API surface area even though no writes were seen to this public field.
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/BatchOptions.java#L50
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/BatchOptions.java#L57 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.BatchOptions"/>
    <Field name="~(maxMessageSize|partitionKey)"/>
    <Bug pattern="UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Public method already exists in the public API surface area even though it has confusing name.
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/MessageReceiver.java#L247
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/MessageReceiver.java#L251
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/MessagingFactory.java#L146 -->
  <Match>
    <Class name="~com\.microsoft\.azure\.eventhubs\.impl\.(MessageReceiver|MessagingFactory)"/>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubRuntimeInformation.java#L62 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.EventHubRuntimeInformation"/>
    <Method name="~(getPartitionIds|onConnectionInit)"/>
    <Bug pattern="EI_EXPOSE_REP,EI_EXPOSE_REP2"/>
  </Match>

  <!-- EventHubRuntimeInformation is populated by the service. There is no user input. Copying partitionId contents is
    not necessary.
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/EventHubRuntimeInformation.java#L27 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.EventHubRuntimeInformation"/>
    <Field name="partitionIds"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Public field already exists in the public API surface area even though it should be final.
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/EventHubClientImpl.java#L41 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.impl.EventHubClientImpl"/>
    <Field name="USER_AGENT"/>
    <Bug pattern="MS_SHOULD_BE_FINAL,UWF_NULL_FIELD"/>
  </Match>

  <!-- Values are initialized at runtime
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/EventHubClientImpl.java#L47 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.impl.EventHubClientImpl"/>
    <Field name="~(sender|timer|underlyingFactory)"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/ReplayableWorkItem.java#L35 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.impl.ReplayableWorkItem"/>
    <Field name="amqpMessage"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Return value is fine to not check, if add, it will be a redundant step
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/FaultTolerantObject.java#L80
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/FaultTolerantObject.java#L123 -->
  <Match>
    <Class name="~com\.microsoft\.azure\.eventhubs\.impl\.FaultTolerantObject(\$(1|2))?"/>
    <Method name="~(onEvent|runOnOpenedObject|close)"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE"/>
  </Match>

  <!-- Bytes array are designed to return null if it is null
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/EventDataImpl.java#L150
    https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/PartitionReceiverImpl.java#L278 -->
  <Match>
    <Class name="~com\.microsoft\.azure\.eventhubs\.impl\.(EventDataImpl|PartitionReceiverImpl)"/>
    <Method name="~(getBytes|getDesiredCapabilities)"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- EventHubClientImpl.USER_AGENT is public and can be set by consumers of the SDK to not be null.
  https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/eventhubs/microsoft-azure-eventhubs/src/main/java/com/microsoft/azure/eventhubs/impl/ConnectionHandler.java#L88 -->
  <Match>
    <Class name="com.microsoft.azure.eventhubs.impl.ConnectionHandler"/>
    <Method name="onConnectionInit"/>
    <Bug pattern="UWF_NULL_FIELD"/>
  </Match>

  <!-- Unchecked cast already exists as inner class of a public class but they are logically correct so it can be ignored.
    https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/PartitionManager.java#L323 -->
  <Match>
    <Class name="com.microsoft.azure.eventprocessorhost.PartitionManager$FinalException"/>
    <Method name="getInner"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- Even though volatile reference to an array exists in protected API surface area changing it will cause another public API surface to change.
    https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/PartitionManager.java#L29 -->
  <Match>
    <Class name="com.microsoft.azure.eventprocessorhost.PartitionManager"/>
    <Field name="partitionIds"/>
    <Bug pattern="VO_VOLATILE_REFERENCE_TO_ARRAY"/>
  </Match>

  <!-- Unchecked cast already exists in the public API surface area, they are logically right, so it can be ignored.
    At AzureStorageCheckpointLeaseManager.java:[line 180,430,446,542,574]
      https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/AzureStorageCheckpointLeaseManager.java#L180
    At InMemoryLeaseManager.java:[line 148,155,209,241,268]
      https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/InMemoryLeaseManager.java#L155 -->
  <Match>
    <Class
      name="~com\.microsoft\.azure\.eventprocessorhost\.(AzureStorageCheckpointLeaseManager|InMemoryLeaseManager)"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>

  <!-- Public inner class already exists in the public API surface area even though it should be static.
    At EventProcessorOptions.java:[lines 234-237]
      https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/EventProcessorOptions.java#L234 -->
  <Match>
    <Class
      name="~com\.microsoft.azure\.eventprocessorhost\.EventProcessorOptions\$(EndOfStreamInitialPositionProvider|StartOfStreamInitialPositionProvider)"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC"/>
  </Match>

  <!-- EventProcessorHost and ExceptionReceivedEventArgs are shipped with method in its public surface area.
    https://github.com/Azure/azure-sdk-for-java/blob/master/eventhubs/data-plane/azure-eventhubs-eph/src/main/java/com/microsoft/azure/eventprocessorhost/EventProcessorHost.java#L346 -->
  <Match>
    <Class name="com.microsoft.azure.eventprocessorhost.EventProcessorHost"/>
    <Method name="getHostName"/>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- Known issue in autorest where it will generate a variable with a value of null then use it in a not null check.
  https://github.com/Azure/autorest.java/issues/328 -->
  <Match>
    <Or>
      <Class name="~com\.microsoft\.azure\.batch\.protocol\.implementation\.[\w]+Impl"/>
    </Or>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <Match>
    <Class name="com.microsoft.azure.batch.CreateTasksErrorException"/>
    <Or>
      <Field name="failureTaskList"/>
      <Field name="pendingTaskList"/>
    </Or>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- No need to implements cloneable. -->
  <Match>
    <Or>
      <Class name="com.azure.core.http.HttpPipelineNextPolicy"/>
      <Class name="com.azure.core.http.HttpRequest"/>
    </Or>
    <Bug pattern="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE"/>
  </Match>

  <!-- Uninitialized subscription property will be initialized on onSubscribe(). Spotbugs is unaware of reactor execution orders. -->
  <Match>
    <Or>
      <Class name="com.azure.core.util.FluxUtil"/>
      <Class name="com.azure.core.util.FluxUtil$1"/>
      <Class name="com.azure.core.implementation.FileWriteSubscriber"/>
    </Or>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- There is no need to make serializer or deserializer classes serializable. Suppress bugs related to these classes.
  -->
  <Match>
    <Class
      name="~com\.azure\.core\.implementation\.serializer\.jackson\.(AdditionalPropertiesDeserializer|AdditionalPropertiesSerializer|FlatteningDeserializer|FlatteningSerializer)"/>
    <Bug pattern="SE_NO_SERIALVERSIONID"/>
  </Match>

  <!-- The casting problems do not exist in Azure use cases -->
  <Match>
    <Class name="com.azure.core.implementation.TypeUtil"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>

  <!-- The fields are checked for null in the build method and throw exceptions if values for fields are not specified. -->
  <Match>
    <Class name="com.azure.identity.InteractiveBrowserCredentialBuilder"/>
    <Field name="port"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- The major fields of poll strategy data subclass are non-serializable, and there is another design for serializing
  the class proposed. Suppress the warning for current design. -->
  <Match>
    <Class
      name="~com\.azure\.core\.management\.(CompletedPollStrategy\$CompletedPollStrategyData|ProvisioningStatePollStrategy\$ProvisioningStatePollStrategyData)"/>
    <Bug pattern="SE_NO_SERIALVERSIONID"/>
  </Match>

  <!-- The major fields of poll strategy data subclass are non-serializable, and there is another design for serializing
  the class proposed. Suppress the warning for current design. -->
  <Match>
    <Class
      name="~com\.azure\.core\.management\.implementation\.(CompletedPollStrategy\$CompletedPollStrategyData|ProvisioningStatePollStrategy\$ProvisioningStatePollStrategyData)"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- The checked field is always not null. -->
  <Match>
    <Class name="com.azure.core.management.implementation.AzureProxy"/>
    <Bug pattern="NP_NULL_PARAM_DEREF"/>
  </Match>

  <!-- The switch cases are encoded version of all SAS query parameters, which will further be appended to a request URL it seems like. A default case wouldn't make sense -->
  <Match>
    <Class name="com.microsoft.azure.storage.blob.SASQueryParameters"/>
    <Bug pattern="SF_SWITCH_NO_DEFAULT"/>
  </Match>

  <!-- The field is used in public Constructor. -->
  <Match>
    <Class name="com.microsoft.azure.storage.blob.RequestIDFactory$RequestIDPolicy"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Exclude the files generated by auto rest -->
  <Match>
    <Package name="~com\.microsoft\.azure\.storage\.blob\.model(.+)"/>
  </Match>

  <!-- Exclude the confusing name bugs as it is designed to name the same as autorest. -->
  <Match>
    <Or>
      <Class name="com.azure.storage.blob.HttpGetterInfo"/>
      <Class name="com.azure.storage.blob.BlobProperties"/>
      <Class name="com.azure.storage.blob.BlobContainerProperties"/>
      <Class name="com.azure.storage.file.share.implementation.models.DirectoryCreateHeaders"/>
      <Class name="com.azure.storage.blob.implementation.models.BlobDownloadHeaders"/>
      <Class name="com.azure.storage.blob.models.BlobQueryHeaders"/>
    </Or>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- The public field already exists in the public API surface area -->
  <Match>
    <Class name="~com\.microsoft\.azure\.servicebus\.(TransactionContext|management\.ManagementClientConstants)"/>
    <Field name="~(MAX_DURATION|NULL_TXN)"/>
    <Bug pattern="MS_SHOULD_BE_FINAL"/>
  </Match>

  <!-- The HttpRequest fields are serializable. Flux<T> and HttpHeaders are able to serialize and deserialize. -->
  <Match>
    <Class name="com.azure.core.http.HttpRequest"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Storing HttpResponseError as the Object value is not required to be serializable or transient -->
  <Match>
    <Class name="com.azure.core.exception.HttpResponseException"/>
    <Bug pattern="SE_BAD_FIELD_STORE"/>
  </Match>

  <!-- The two values can still change in the future. Change it will be a breaking code change.-->
  <Match>
    <Class name="com.microsoft.azure.servicebus.MessageReceiver"/>
    <Bug pattern="DB_DUPLICATE_BRANCHES"/>
  </Match>

  <!-- The return value is ignored for purpose -->
  <Match>
    <Class name="~com\.microsoft\.azure\.servicebus\.primitives\.(AsyncUtil|RequestResponseLink\$InternalReceiver)"/>
    <Method name="~(completeFuture|completeFutureExceptionally|run|onReceiveComplete)"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE"/>
  </Match>

  <!-- Unreachable Path -->
  <Match>
    <Class name="com.microsoft.azure.servicebus.primitives.RequestResponseLink$InternalSender"/>
    <Local name="encodedPair"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_EXCEPTION"/>
  </Match>

  <!-- The casting is correct, it is beyond the SpotBugs's ability to determine the correctness -->
  <Match>
    <Class name="com.microsoft.azure.servicebus.primitives.RequestResponseUtils"/>
    <Method name="encodeRuleDescriptionToMap"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- Unstable implementation. It is in Service team's to-do-list -->
  <Match>
    <Class name="com.microsoft.azure.servicebus.primitives.CoreMessageReceiver"/>
    <Method name="onReceiveComplete"/>
    <Bug pattern="AT_OPERATION_SEQUENCE_ON_CONCURRENT_ABSTRACTION"/>
  </Match>

  <!-- Incorrect flagging, the surrounding hasValue() checks that get() isn't null -->
  <Match>
    <Class name="com.azure.core.http.rest.RestProxy"/>
    <Method name="endTracingSpan"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, error will be thrown if value is null -->
  <Match>
    <Class name="com.azure.endtoend.identity.WebJobsIdentityTest"/>
    <Or>
      <Method name="testMSIEndpointWithSystemAssigned"/>
      <Method name="testMSIEndpointWithUserAssigned"/>
    </Or>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, if the response is null a StorageException would have been thrown -->
  <Match>
    <Or>
      <Class name="com.azure.storage.blob.specialized.BlobInputStream"/>
      <Class name="com.azure.storage.file.share.StorageFileInputStream"/>
      <Class name="com.azure.storage.blob.specialized.BlobOutputStream$AppendBlobOutputStream"/>
      <Class name="com.azure.storage.queue.QueueServiceClient"/>
    </Or>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, all the optional values can be null -->
  <Match>
    <Class name="com.azure.storage.blob.BlobClient"/>
    <Method name="downloadToFile"/>
    <Bug pattern="NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS"/>
  </Match>

  <!-- Super doesn't need to be cloned since it is Object -->
  <Match>
    <Class name="com.azure.core.util.Configuration"/>
    <Bug pattern="CN_IDIOM_NO_SUPER_CALL"/>
  </Match>

  <!-- Jackson property setter method is private -->
  <Match>
    <Or>
      <Class name="com.azure.security.keyvault.secrets.models.DeletedSecret"/>
      <Class name="com.azure.security.keyvault.secrets.models.KeyVaultSecret"/>
      <Class name="com.azure.security.keyvault.secrets.models.SecretProperties"/>
      <Class name="com.azure.security.keyvault.keys.models.DeletedKey"/>
      <Class name="com.azure.security.keyvault.keys.cryptography.SecretKey"/>
      <Class name="com.azure.security.keyvault.keys.models.KeyVaultKey"/>
      <Class name="com.azure.security.keyvault.keys.models.KeyProperties"/>
      <Class name="com.azure.security.keyvault.certificates.models.DeletedCertificate"/>
      <Class name="com.azure.security.keyvault.certificates.models.Certificate"/>
      <Class name="com.azure.security.keyvault.certificates.models.CertificateProperties"/>
      <Class name="com.azure.security.keyvault.certificates.models.IssuerProperties"/>
      <Class name="com.azure.security.keyvault.certificates.models.CertificateIssuer"/>
      <Class name="com.azure.security.keyvault.certificates.models.CertificatePolicy"/>
      <Class name="com.azure.security.keyvault.certificates.models.LifetimeAction"/>
      <Class name="com.azure.security.keyvault.certificates.models.CertificateOperation"/>
    </Or>
    <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.azure.core.util.polling.PollResponseJavaDocCodeSnippets"/>
      <Class name="com.azure.core.util.polling.PollerJavaDocCodeSnippets"/>
    </Or>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE,NP_ALWAYS_NULL,UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>

  <!-- Field initialized by jackson property annotation -->
  <Match>
    <Class name="com.azure.security.keyvault.keys.models.webkey.JsonWebKey"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- It is fine to have un-used variables, unread fields, anonymous static inner classes in javadoc code samples. -->
  <Match>
    <Or>
      <Class name="~.*JavaDoc(CodeSnippets|CodeSamples|Samples)"/>
      <Class name="~.*ReadmeSamples"/>
      <Class name="com.azure.storage.blob.batch.ReadmeCodeSamples"/>
      <Class name="com.azure.storage.file.datalake.GetSetAccessControlExample"/>
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE,
                  URF_UNREAD_FIELD,
                  SIC_INNER_SHOULD_BE_STATIC_ANON,
                  DLS_DEAD_LOCAL_STORE_SHADOWS_FIELD,
                  NP_NULL_PARAM_DEREF_ALL_TARGETS_DANGEROUS,
                  NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- These methods are called, SpotBugs just can't see through the specific lambda and static class code -->
  <Match>
    <Or>
      <Class
        name="com.azure.data.appconfiguration.credentials.ConfigurationClientCredentials$AuthorizationHeaderProvider"/>
      <Class name="com.azure.messaging.eventhubs.EventData$SystemProperties"/>
      <Class name="com.azure.messaging.eventhubs.implementation.ReactorSender$WeightedDeliveryTag"/>
    </Or>
    <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>

  <!-- This is a false positive. Exception is thrown and caught to map to a different type of exception-->
  <Match>
    <Or>
      <Class name="com.azure.messaging.eventhubs.PartitionPumpManager"/>
    </Or>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Names defined in the service. -->
  <Match>
    <Class name="com.azure.data.appconfiguration.models.ConfigurationSetting"/>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- This is a false positive, it is possible for usingUserDelegation to be false. -->
  <Match>
    <Class name="com.azure.storage.blob.specialized.BlobServiceSasSignatureValues"/>
    <Bug pattern="UC_USELESS_CONDITION"/>
  </Match>

  <!-- Retry thus does not throw.
    SharedTokenCacheCredential needs to catch any catch exception that gets thrown.-->
  <Match>
    <Or>
      <Class name="com.azure.identity.SharedTokenCacheCredential"/>
      <Class name="com.azure.identity.implementation.msalextensions.CacheLock"/>
    </Or>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>
  <!-- Return value not needed -->
  <Match>
    <Class name="com.azure.identity.implementation.msalextensions.cachepersister.windows.WindowsDPAPICacheProtector"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_BAD_PRACTICE"/>
  </Match>

  <!-- Serializers define non-transient non-serializable instance field -->
  <Match>
    <Or>
      <Class name="com.azure.core.implementation.jackson.FlatteningSerializer"/>
      <Class name="com.azure.core.implementation.jackson.FlatteningDeserializer"/>
      <Class name="com.azure.core.implementation.jackson.AdditionalPropertiesSerializer"/>
      <Class name="com.azure.core.implementation.jackson.AdditionalPropertiesDeserializer"/>
    </Or>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- FIXME: spotbugs issues in core test packages -->
  <Match>
    <Or>
      <Package name="com.azure.core.test"/>
      <Package name="com.azure.core.test.implementation"/>
      <Package name="com.azure.core.test.http"/>
    </Or>
    <Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING,
                  DM_CONVERT_CASE,
                  EC_UNRELATED_TYPES,
                  REC_CATCH_EXCEPTION,
                  DM_DEFAULT_ENCODING,
                  NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE,
                  RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE,
                  UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>


  <!-- The field is read by parent class StorageOutputStream methods. -->
  <Match>
    <Class name="com.azure.storage.file.share.StorageFileOutputStream"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Initial implementation of Storage Blob Batch is using an inline class -->
  <Match>
    <Class name="com.azure.storage.blob.batch.BlobBatchAsyncClient"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <!-- Implementation name confusing with public API name and non-public API -->
  <Match>
    <Or>
      <Class name="com.azure.core.implementation.http.UrlBuilder"/>
      <Class name="com.azure.storage.blob.implementation.models.AppendBlobAppendBlockFromUrlHeaders"/>
      <Class name="com.azure.storage.file.share.implementation.models.FileGetPropertiesHeaders"/>
      <Class name="com.azure.storage.file.datalake.implementation.models.PathAppendDataHeaders"/>
    </Or>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- Incorrect flagging, there is already switchIfEmpty operator applied in the upstream to throw error on empty -->
  <Match>
    <Class name="com.azure.core.util.polling.DefaultSyncPoller"/>
    <Method name="getFinalResult"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, there is already switchIfEmpty operator applied in the upstream to throw error on empty -->
  <Match>
    <Class name="com.azure.core.util.polling.DefaultSyncPoller"/>
    <Method name="poll"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, there is already switchIfEmpty operator applied in the upstream to throw error on empty -->
  <Match>
    <Class name="com.azure.core.util.polling.DefaultSyncPoller"/>
    <Method name="waitForCompletion"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, there is already switchIfEmpty operator applied in the upstream to throw error on empty -->
  <Match>
    <Class name="com.azure.core.util.polling.DefaultSyncPoller"/>
    <Method name="waitUntil"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Incorrect flagging, there is already switchIfEmpty operator applied in the upstream to throw error on empty -->
  <Match>
    <Class name="com.azure.core.util.polling.PollingContext"/>
    <Method name="clone"/>
    <Bug pattern="CN_IMPLEMENTS_CLONE_BUT_NOT_CLONEABLE"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.azure.core.util.paging.PagedFluxCoreJavaDocCodeSnippets"/>
    </Or>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE,
    SIC_INNER_SHOULD_BE_STATIC_ANON,
    UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS,
    NP_BOOLEAN_RETURN_NULL"/>
  </Match>

  <!-- Disable some spotbugs rules on perf-tests -->
  <Match>
    <Or>
      <Package name="com.azure.storage.blob.perf"/>
      <Package name="com.azure.storage.blob.perf.core"/>
      <Package name="com.azure.storage.file.datalake.perf"/>
      <Package name="com.azure.storage.file.datalake.perf.core"/>
      <Package name="com.azure.storage.file.share.perf"/>
      <Package name="com.azure.storage.file.share.perf.core"/>
    </Or>
    <Bug pattern="BC_UNCONFIRMED_CAST, DM_EXIT, RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
  </Match>

  <Match>
    <Package name="com.azure.sdk.template.perf"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!-- StringUtils.strip can return NULL so the NULL check is required -->
  <Match>
    <Class name="com.azure.cosmos.implementation.PathsHelper"/>
    <Method name="parsePathSegments"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.AeadAes256CbcHmac256Algorithm"/>
    <Method name="decryptData"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.AeadAes256CbcHmac256Algorithm"/>
    <Method name="encryptData"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.BaseAuthorizationTokenProvider"/>
    <Method name="reInitializeIfPossible"/>
    <Bug pattern="ES_COMPARING_STRINGS_WITH_EQ"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.SecurityUtility"/>
    <Method name="getSHA256Hash"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <!-- Suppress false positive, there is no null in the flagged code -->
  <Match>
    <Class name="com.azure.cosmos.implementation.TestConfigurations"/>
    <Method name="loadFromPathIfExists"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE,REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- ClassLoader::getResourceAsStream can return null, ref: https://docs.oracle.com/javase/8/docs/technotes/guides/lang/resources.html -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.RntbdTransportClient$Options$Builder"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <!-- Tracking work-item: https://github.com/Azure/azure-sdk-for-java/issues/9037 -->
  <Match>
    <Or>
      <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics"/>
      <Class name="com.azure.cosmos.models.CosmosItemResponse"/>
    </Or>
    <Bug pattern="IS2_INCONSISTENT_SYNC"/>
  </Match>

  <!-- The following two suggestion for _static_ inner class is suppressed,
       first method is 1 line and second one is ~4 lines, doesn't worth a dedicated class.
    -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.LocationCache"/>
    <Method name="markEndpointUnavailable"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.DatabaseAccount"/>
    <Method name="getQueryEngineConfiguration"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <!-- This code smells, created an issue: https://github.com/Azure/azure-sdk-for-java/issues/9039 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GoneAndRetryWithRetryPolicy"/>
    <Method name="shouldRetry"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.KeyVaultAccessClient"/>
    <Method name="unwrapKeyAsync"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.KeyVaultAccessClient"/>
    <Method name="wrapKeyAsync"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.AzureKeyVaultKeyWrapProvider"/>
    <Method name="unwrapKey"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.AzureKeyVaultKeyWrapProvider"/>
    <Method name="wrapKey"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- DB is retrieved synchronously (Flux::block()) after creating it, so no chance of null  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.DatabaseForTest"/>
    <Method name="create"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Issue: https://github.com/Azure/azure-sdk-for-java/issues/9041 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxGatewayStoreModel"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH"/>
  </Match>

  <!-- Issue: https://github.com/Azure/azure-sdk-for-java/issues/9044 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxGatewayStoreModel"/>
    <Method name="validateOrThrow"/>
    <Bug pattern="DM_DEFAULT_ENCODING"/>
  </Match>

  <!-- The in-memory map is not serializable, given value is of type IServerIdentity which is not serializable -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.InMemoryCollectionRoutingMap$MinPartitionKeyPairComparator"/>
    <Bug pattern="SE_COMPARATOR_SHOULD_BE_SERIALIZABLE"/>
  </Match>

  <!-- The following 3 suppression are valid, the types uses default value if parse fails  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.Configs"/>
    <Method name="getIntValue"/>
    <Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.Integers"/>
    <Method name="tryParse"/>
    <Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.Longs"/>
    <Method name="tryParse"/>
    <Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING"/>
  </Match>

  <!-- Issue: https://github.com/Azure/azure-sdk-for-java/issues/9048 -->
  <Match>
    <Class name="com.azure.cosmos.models.ModelBridgeInternal"/>
    <Method name="toDatabaseAccount"/>
    <Bug pattern="DM_BOXED_PRIMITIVE_FOR_PARSING"/>
  </Match>


  <!-- Extra null check is for assertion -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.AddressResolver"/>
    <Method name="~(.*)\$(resolveAddressesAndIdentityAsync|null)\$(.*)"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <!-- Issue: https://github.com/Azure/azure-sdk-for-java/issues/9050 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdClientChannelPool"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <!-- Code is doing DCL, this needs to be evaluated
   https://www.cs.umd.edu/~pugh/java/memoryModel/DoubleCheckedLocking.html
   Issue: https://github.com/Azure/azure-sdk-for-java/issues/9054
   -->
  <Match>
    <Class name="com.azure.cosmos.models.CosmosItemResponse"/>
    <Method name="getItem"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <!-- Fallthrough is by design -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.MurmurHash3_32"/>
    <Method name="hash"/>
    <Bug pattern="SF_SWITCH_FALLTHROUGH"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$AddressResolutionStatistics"/>
    <Field name="endTimeUTC"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$AddressResolutionStatistics"/>
    <Field name="startTimeUTC"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$AddressResolutionStatistics"/>
    <Field name="targetEndpoint"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$AddressResolutionStatistics"/>
    <Field name="errorMessage"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$AddressResolutionStatistics"/>
    <Field name="inflightRequest"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the fields are read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$StoreResponseStatistics"/>
    <Field name="requestResourceType"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$StoreResponseStatistics"/>
    <Field name="requestResponseTimeUTC"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$StoreResponseStatistics"/>
    <Field name="storeResult"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RequestTimeline$Event"/>
    <Field name="durationInMicroSec"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- The entire class is unused. Bug: https://github.com/Azure/azure-sdk-for-java/issues/9075 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.implementation.RemainingWorkEstimatorImpl"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- serviceConfigReader type is not used, but comment seems this is be used in future updates -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GlobalAddressResolver"/>
    <Field name="serviceConfigReader"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- gatewayAddressCache also seems associated with serviceConfigReader suppressed previously -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GlobalAddressResolver"/>
    <Field name="gatewayAddressCache"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- addressResolver also seems associated with serviceConfigReader suppressed previously -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GlobalAddressResolver"/>
    <Field name="addressResolver"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9076 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreClientFactory"/>
    <Field name="maxConcurrentConnectionOpenRequests"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9076 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreClientFactory"/>
    <Field name="requestTimeout"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9076 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreClientFactory"/>
    <Field name="enableTransportClientSharing"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponseHeaders"/>
    <Field name="indexTermsGenerated"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponseHeaders"/>
    <Field name="queriesPerformed"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponseHeaders"/>
    <Field name="readsPerformed"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponseHeaders"/>
    <Field name="scriptsExecuted"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Suppress URF_UNREAD_FIELD, the field is read but during serialization -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponseHeaders"/>
    <Field name="writesPerformed"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- This field is set to false as of today, looks like the field it left for future enhancement -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.DefaultDocumentQueryExecutionContext"/>
    <Field name="isContinuationExpected"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9077 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.PipelinedDocumentQueryExecutionContext"/>
    <Field name="correlatedActivityId"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9078 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestHeaders"/>
    <Method name="addResourceIdOrPathHeaders"/>
    <Bug pattern="SF_SWITCH_NO_DEFAULT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9078 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.MurmurHash3_32"/>
    <Method name="hash"/>
    <Bug pattern="SF_SWITCH_NO_DEFAULT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9078 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.PartitionKeyInternal"/>
    <Method name="fromObjectArray"/>
    <Bug pattern="SF_SWITCH_NO_DEFAULT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.ServiceItemLease"/>
    <Field name="ContinuationToken"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.ServiceItemLease"/>
    <Field name="LeaseToken"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.ServiceItemLease"/>
    <Field name="Owner"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.LocationCache$LocationUnavailabilityInfo"/>
    <Field name="LastUnavailabilityCheckTimeStamp"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.LocationCache$LocationUnavailabilityInfo"/>
    <Field name="UnavailableOperations"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9082 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Field name="UseGatewayMode"/>
    <Bug pattern="NM_FIELD_NAMING_CONVENTION"/>
  </Match>

  <!-- The static field sharedGatewayHttpClient is cleared using synchronized ref count mechanism -->
  <Match>
    <Class name="com.azure.cosmos.implementation.http.SharedGatewayHttpClient"/>
    <Field name="sharedGatewayHttpClient"/>
    <Bug pattern="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9087 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RetryPolicyWithDiagnostics"/>
    <Field name="retriesCountForDiagnostics"/>
    <Bug pattern="VO_VOLATILE_INCREMENT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9087 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.implementation.AutoCheckpointer"/>
    <Field name="processedDocCount"/>
    <Bug pattern="VO_VOLATILE_INCREMENT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9087 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.DefaultDocumentQueryExecutionContext"/>
    <Field name="retries"/>
    <Bug pattern="VO_VOLATILE_INCREMENT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9054 -->
  <Match>
    <Class name="com.azure.cosmos.models.CosmosItemResponse"/>
    <Field name="item"/>
    <Bug pattern="DC_DOUBLECHECK"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.CosmosException"/>
    <Field name="cosmosError"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.CosmosException"/>
    <Field name="cosmosDiagnostics"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.CosmosException"/>
    <Field name="requestTimeline"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.CosmosException"/>
    <Field name="requestUri"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.CosmosException"/>
    <Field name="channelAcquisitionTimeline"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdContextException"/>
    <Field name="cosmosError"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9088 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdContextException"/>
    <Field name="status"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- DocumentModelOperationException fields re serializable -->
  <Match>
    <Class name="com.azure.ai.formrecognizer.models.DocumentModelOperationException"/>
    <Field name="documentModelOperationError"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- TextAnalyticsException fields re serializable -->
  <Match>
    <Class name="com.azure.ai.textanalytics.models.TextAnalyticsException"/>
    <Field name="errors"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Exception is required to catch, ref: code comment in the OrderbyRowComparer::compare() method  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.orderbyquery.OrderbyRowComparer"/>
    <Method name="compare"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Exception is required to handle null location names, malformed endpoint, ref: code comment  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.LocationCache"/>
    <Method name="getEndpointByLocation"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Code has a TODO to handle Exception case  -->
  <Match>
    <Class name="~com\.azure\.cosmos\.implementation\.directconnectivity\.StoreReader(.*)"/>
    <Method name="~(.*)\$(readFromReplicas|null)\$(.*)"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Exception is required to handle when parsing system information  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$ClientSideRequestStatisticsSerializer"/>
    <Method name="serialize"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

    <!-- Exception is required to handle when getting java version  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.Utils"/>
    <Method name="getJavaVersion"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Exception is required to handle and fallback to default pair  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceId"/>
    <Method name="tryParse"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- This is a false positive. Exception is getting caught in init method-->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentClientImpl"/>
    <Method name="init"/>
    <Bug pattern="REC_CATCH_EXCEPTION"/>
  </Match>
  
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionCosmosAsyncContainer"/>
    <Method name="decryptResponseAsync"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9089 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.PathsHelper"/>
    <Method name="getResourcePathArray"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9089 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Method name="toByteArray"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9089 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.Utils"/>
    <Method name="getUTF8BytesOrNull"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9089 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdResponse"/>
    <Method name="toByteArray"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9090 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.ServiceConfig"/>
    <Field name="systemReplicationPolicy"/>
    <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9090 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.ServiceConfig"/>
    <Field name="userReplicationPolicy"/>
    <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9090 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.ParallelDocumentQueryExecutionContextBase"/>
    <Field name="pageSize"/>
    <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>


  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9090 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.ParallelDocumentQueryExecutionContextBase"/>
    <Field name="partitionKeyRanges"/>
    <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9090 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.QueryMetrics"/>
    <Field name="ZERO"/>
    <Bug pattern="URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9091 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.orderbyquery.OrderbyRowComparer"/>
    <Method name="compare"/>
    <Bug pattern="DC_PARTIALLY_CONSTRUCTED"/>
  </Match>

  <!--  ChannelHandlerContext::fireUserEventTriggered is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdContextDecoder"/>
    <Method name="decode"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::channelRead is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdContextRequestDecoder"/>
    <Method name="channelRead"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelActive is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelActive"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelInactive is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelInactive"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelReadComplete"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelRegistered is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelRegistered"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelUnregistered is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelUnregistered"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelWritabilityChanged is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="channelWritabilityChanged"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::flush is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="flush"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::read is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="read"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::flush is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="removeContextNegotiatorAndFlushPendingWrites"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireUserEventTriggered is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="userEventTriggered"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!--  ChannelHandlerContext::fireChannelRead is fluent method and return ref can be ignored -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestDecoder"/>
    <Method name="channelRead"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT"/>
  </Match>

  <!-- CompletableFuture.getNow(null) is valid (null param), suppressing false positive
        https://github.com/spotbugs/spotbugs/issues/1001 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="hasRequestedRntbdContext"/>
    <Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
  </Match>

  <!-- CompletableFuture.getNow(null) is valid (null param), suppressing false positive
      https://github.com/spotbugs/spotbugs/issues/1001 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="hasRntbdContext"/>
    <Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
  </Match>

  <!-- CompletableFuture.getNow(null) is valid (null param), suppressing false positive
      https://github.com/spotbugs/spotbugs/issues/1001 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="messageReceived"/>
    <Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
  </Match>

  <!-- CompletableFuture.getNow(null) is valid (null param), suppressing false positive
      https://github.com/spotbugs/spotbugs/issues/1001 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="rntbdContext"/>
    <Bug pattern="NP_NONNULL_PARAM_VIOLATION"/>
  </Match>

  <!-- Exception is needed to catch a SslException masked as a RuntimeException by Netty -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdRequestManager"/>
    <Method name="close"/>
    <Bug pattern="BC_IMPOSSIBLE_INSTANCEOF"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9092 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.OrderByUtils$PageToItemTransformer"/>
    <Method name="~(.*)\$(apply|null)\$(.*)"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_INFERRED"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9092 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.AggregateDocumentQueryExecutionContext"/>
    <Method name="~(.*)\$(drainAsync|null)\$(.*)"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_INFERRED"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9092 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.QueryMetrics"/>
    <Method name="mergeQueryMetricsMap"/>
    <Bug pattern="RV_RETURN_VALUE_IGNORED_INFERRED"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.PathsHelper"/>
    <Method name="tryParsePathSegments"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE_OF_NULL"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.AeadAes256CbcHmac256Algorithm"/>
    <Method name="encryptData"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.QueryMetrics"/>
    <Method name="createFromDelimitedString"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ReplicationPolicy"/>
    <Method name="setMaxReplicaSetSize"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceThrottleRetryPolicy"/>
    <Method name="shouldRetry"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceTokenAuthorizationHelper"/>
    <Method name="getAuthorizationTokenUsingResourceTokens"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GoneAndRetryWithRetryPolicy"/>
    <Method name="shouldRetry"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreReader"/>
    <Method name="readFromStoreAsync"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.LocationCache"/>
    <Method name="anyEndpointsAvailable"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9093 -->
  <Match>
    <Class name="com.azure.cosmos.models.JsonSerializable"/>
    <Method name="getObjectByPath"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9094 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.caches.AsyncCache"/>
    <Method name="getAsync"/>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9050 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.rntbd.RntbdClientChannelPool"/>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE"/>
  </Match>

  <!-- The static field sharedTransportClient is cleared using synchronized ref count mechanism -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.SharedTransportClient"/>
    <Field name="sharedTransportClient"/>
    <Bug pattern="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9095 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Field name="resourceFullName"/>
    <Bug pattern="UUF_UNUSED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9095 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.AddressResolver$RefreshState"/>
    <Field name="resolutionResult"/>
    <Bug pattern="UUF_UNUSED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9095 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GlobalAddressResolver"/>
    <Field name="addressResolver"/>
    <Bug pattern="UUF_UNUSED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9095 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GlobalAddressResolver"/>
    <Field name="gatewayAddressCache"/>
    <Bug pattern="UUF_UNUSED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9096 -->
  <Match>
    <Class name="com.azure.cosmos.models.SqlParameterList"/>
    <Method name="listIterator"/>
    <Bug pattern="IL_INFINITE_RECURSIVE_LOOP"/>
  </Match>

  <!-- False positive, IPartitionKeyComponent does not extend from Comparable -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.IPartitionKeyComponent"/>
    <Bug pattern="CO_ABSTRACT_SELF"/>
  </Match>

  <!--Bug: https://github.com/Azure/azure-sdk-for-java/issues/9097 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.ConsistencyReader"/>
    <Method name="readAsync"/>
    <Bug pattern="DB_DUPLICATE_SWITCH_CLAUSES"/>
  </Match>

  <!--Bug: https://github.com/Azure/azure-sdk-for-java/issues/9097 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.HttpTransportClient"/>
    <Method name="prepareHttpMessage"/>
    <Bug pattern="DB_DUPLICATE_SWITCH_CLAUSES"/>
  </Match>

  <!-- Field is not initialized in Ctr but is set using setters -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.ProcessorSettings"/>
    <Field name="maxItemCount"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>


  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9098 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.AddressResolver"/>
    <Method name="~(.*)\$(resolveAddressesAndIdentityAsync|null)\$(.*)"/>
    <Bug pattern="ES_COMPARING_STRINGS_WITH_EQ"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9099 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Field name="entityId"/>
    <Bug pattern="UWF_UNWRITTEN_PUBLIC_OR_PROTECTED_FIELD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9100 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.caches.RxPartitionKeyRangeCache"/>
    <Method name="~(.*)\$(tryGetRangeByPartitionKeyRangeId|null)\$(.*)"/>
    <Bug pattern="NP_NULL_PARAM_DEREF"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9100 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.GatewayAddressCache"/>
    <Method name="getServerAddressesViaGatewayAsync"/>
    <Bug pattern="NP_NULL_PARAM_DEREF"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Method name="getContentAsByteArray"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreResponse"/>
    <Method name="getResponseBody"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreResponse"/>
    <Method name="getResponseHeaderNames"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreResponse"/>
    <Method name="getResponseHeaderValues"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyUnwrapResult"/>
    <Method name="getDataEncryptionKey"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyUnwrapResult"/>
    <Method name="getWrappedDataEncryptionKey"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.DecryptionResult"/>
    <Method name="getEncryptedContent"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.EncryptionProperties"/>
    <Method name="getEncryptedData"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.EncryptionProperties"/>
    <Method name="&lt;init&gt;"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyUnwrapResult"/>
    <Method name="&lt;init&gt;"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.StoreResponse"/>
    <Method name="&lt;init&gt;"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyWrapResult"/>
    <Method name="getWrappedDataEncryptionKey"/>
    <Bug pattern="EI_EXPOSE_REP2,EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyWrapResult"/>
    <Method name="getEncryptionKeyWrapMetadata"/>
    <Bug pattern="EI_EXPOSE_REP2,EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.encryption.EncryptionKeyWrapResult"/>
    <Method name="&lt;init&gt;"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Method name="setContentBytes"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientEncryptionKey"/>
    <Method name="getWrappedDataEncryptionKey"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientEncryptionKey"/>
    <Method name="setWrappedDataEncryptionKey"/>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- https://github.com/Azure/azure-sdk-for-java/issues/9102 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ItemOperations"/>
    <Method name="readManyAsync"/>
    <Bug pattern="UC_USELESS_OBJECT"/>
  </Match>

  <!-- https://github.com/Azure/azure-sdk-for-java/issues/9102 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentClientImpl"/>
    <Method name="~(.*)\$(readMany|null)\$(.*)"/>
    <Bug pattern="UC_USELESS_OBJECT"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9103 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.ServiceConfig"/>
    <Method name="&lt;init&gt;"/>
    <Bug pattern="ISC_INSTANTIATE_STATIC_CLASS"/>
  </Match>

  <!-- Super doesn't need to be cloned since it is Object -->
  <Match>
    <Class name="com.azure.cosmos.implementation.DocumentServiceRequestContext"/>
    <Bug pattern="CN_IDIOM_NO_SUPER_CALL"/>
  </Match>

  <!-- Super doesn't need to be cloned since it is Object -->
  <Match>
    <Class name="com.azure.cosmos.implementation.RxDocumentServiceRequest"/>
    <Bug pattern="CN_IDIOM_NO_SUPER_CALL"/>
  </Match>

  <!-- Exception is ignored by design which indicate that error while evaluating system information -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ClientSideRequestStatistics$ClientSideRequestStatisticsSerializer"/>
    <Method name="serialize"/>
    <Bug pattern="DE_MIGHT_IGNORE"/>
  </Match>

  <!-- Exception in AutoCloseable.close is ignored -->
  <Match>
    <Class name="com.azure.core.tracing.opentelemetry.OpenTelemetryHttpPolicy$ScalarPropagatingMono"/>
    <Method name="subscribe"/>
    <Bug pattern="DE_MIGHT_IGNORE"/>
  </Match>
  <Match>
    <Class name="com.azure.cosmos.implementation.TracerProvider"/>
    <Method name="subscribe"/>
    <Bug pattern="DE_MIGHT_IGNORE"/>
  </Match>
  
  <!-- Exception is ignored by design which indicate that non-parsable id -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceId"/>
    <Method name="verify"/>
    <Bug pattern="DE_MIGHT_IGNORE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9104 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.StringPartitionKeyComponent"/>
    <Method name="writeForBinaryEncoding"/>
    <Bug pattern="INT_BAD_COMPARISON_WITH_SIGNED_BYTE"/>
  </Match>

  <!-- The Bug was reported because StringPartitionKeyComponent's hashCode() implementation is
        based only on the hashCode() method of it's member variable 'value'.
        This is valid since the StringPartitionKeyComponent has only one member variable so
        delegating to that member variable's hashCode is fine -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.StringPartitionKeyComponent"/>
    <Bug pattern="HE_HASHCODE_USE_OBJECT_EQUALS"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9046 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceId"/>
    <Method name="equals"/>
    <Bug pattern="HE_EQUALS_USE_HASHCODE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9105 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.ResourceId"/>
    <Method name="tryParse"/>
    <Bug pattern="BIT_SIGNED_CHECK"/>
  </Match>


  <!-- False positive, equals method is implemented correctly by using equality of member variables  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.VectorSessionToken"/>
    <Method name="equals"/>
    <Bug pattern="EQ_UNUSUAL"/>
  </Match>

  <!-- False positive, equals method is implemented correctly by using equality of member variables  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.PartitionKeyInternal"/>
    <Method name="equals"/>
    <Bug pattern="EQ_UNUSUAL"/>
  </Match>

  <!-- False positive, equals method is implemented correctly by using equality of member variables  -->
  <Match>
    <Class name="com.azure.cosmos.implementation.clienttelemetry.ReportPayload"/>
    <Method name="equals"/>
    <Bug pattern="EQ_UNUSUAL"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9106 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.PathsHelper"/>
    <Method name="generatePathForNameBased"/>
    <Bug pattern="BC_VACUOUS_INSTANCEOF,SIO_SUPERFLUOUS_INSTANCEOF"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9107 -->
  <Match>
    <Class name="com.azure.cosmos.ConnectionPolicy"/>
    <Field name="defaultPolicy"/>
    <Bug pattern="LI_LAZY_INIT_STATIC"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9108 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.changefeed.CancellationTokenSource"/>
    <Method name="close"/>
    <Bug pattern="UC_USELESS_VOID_METHOD"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9109 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.orderbyquery.OrderbyRowComparer"/>
    <Method name="compare"/>
    <Bug pattern="RV_NEGATING_RESULT_OF_COMPARETO"/>
  </Match>


  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9110 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.directconnectivity.Address"/>
    <Method name="isPrimary"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9110 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.OrderByContinuationToken"/>
    <Method name="getInclusive"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9110 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.query.QueryInfo"/>
    <Method name="hasSelectValue"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9110 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.Range"/>
    <Method name="isMaxInclusive"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- Bug: https://github.com/Azure/azure-sdk-for-java/issues/9110 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.Range"/>
    <Method name="isMinInclusive"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.implementation.encryption.CosmosDataEncryptionKeyProvider"/>
    <Method name="initialize"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <!-- https://github.com/Azure/azure-sdk-for-java/issues/9179 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.SessionContainer"/>
    <Method name="setSessionToken"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
  </Match>

  <!-- https://github.com/Azure/azure-sdk-for-java/issues/9179 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.SessionContainer"/>
    <Method name="shouldUpdateSessionToken"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
  </Match>

  <!-- https://github.com/Azure/azure-sdk-for-java/issues/9179 -->
  <Match>
    <Class name="com.azure.cosmos.implementation.routing.MurmurHash3_128"/>
    <Method name="rotateLeft32"/>
    <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>


  <Match>
    <Class name="com.azure.cosmos.implementation.routing.UInt128"/>
    <Method name="compareTo"/>
    <Bug pattern="SA_FIELD_SELF_COMPARISON"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.implementation.EncryptionProcessor"/>
    <Method name="decryptAndSerializeProperty"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>

  <Match>
    <Class name="com.azure.cosmos.encryption.implementation.EncryptionProcessor"/>
    <Method name="encryptAndSerializeProperty"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>
  <!-- Serializing a null value should return null to allow client to handle null cases
    consistently instead of injecting null payload behavior from the payload. -->
  <Match>
    <Class name="com.azure.data.schemaregistry.avro.SchemaRegistryAvroSerializer"/>
    <Method name="serialize"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Exclude spotbug from non-shipping modules -->
  <Match>
    <Or>
      <Package name="com.azure.cosmos.benchmark"/>
      <Package name="com.azure.cosmos.examples"/>
      <Package name="com.azure.cosmos.examples.ChangeFeed"/>
      <Package name="com.azure.cosmos.rx.examples.multimaster"/>
      <Package name="com.azure.cosmos.rx.examples.multimaster.samples"/>
    </Or>
    <Bug pattern="JLM_JSR166_UTILCONCURRENT_MONITORENTER,
    NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE,
    NO_NOTIFY_NOT_NOTIFYALL,
    UC_USELESS_OBJECT,
    SIC_INNER_SHOULD_BE_STATIC,
    SIC_INNER_SHOULD_BE_STATIC_ANON,
    UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR,
    NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE,
    BX_UNBOXING_IMMEDIATELY_REBOXED,
    MS_SHOULD_BE_FINAL,
    REC_CATCH_EXCEPTION,
    WA_NOT_IN_LOOP,
    MS_SHOULD_BE_FINAL,
    BC_UNCONFIRMED_CAST_OF_RETURN_VALUE,
    DLS_DEAD_LOCAL_STORE,
    IM_BAD_CHECK_FOR_ODD,
    RC_REF_COMPARISON,
    REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- Exclude vendor-ed apache-commons types from spotbug -->
  <Match>
    <Class name="~com\.azure\.cosmos\.implementation\.apachecommons(.+)"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE,
    IS2_INCONSISTENT_SYNC,
    BC_UNCONFIRMED_CAST_OF_RETURN_VALUE,
    SE_BAD_FIELD,
    SE_TRANSIENT_FIELD_NOT_RESTORED,
    ES_COMPARING_PARAMETER_STRING_WITH_EQ,
    PZLA_PREFER_ZERO_LENGTH_ARRAYS,
    DM_CONVERT_CASE"/>
  </Match>

  <!-- Exclude vendor-ed guava25 types from spotbug -->
  <Match>
    <Class name="~com\.azure\.cosmos\.implementation\.guava25(.+)"/>
    <Bug pattern="BC_BAD_CAST_TO_ABSTRACT_COLLECTION,
    BC_UNCONFIRMED_CAST,
    BC_UNCONFIRMED_CAST_OF_RETURN_VALUE,
    DLS_DEAD_LOCAL_STORE,
    DLS_DEAD_LOCAL_STORE_IN_RETURN,
    DMI_NONSERIALIZABLE_OBJECT_WRITTEN,
    DP_CREATE_CLASSLOADER_INSIDE_DO_PRIVILEGED,
    EQ_DOESNT_OVERRIDE_EQUALS,
    HE_EQUALS_NO_HASHCODE,
    HE_EQUALS_USE_HASHCODE,
    HE_HASHCODE_NO_EQUALS,
    HE_INHERITS_EQUALS_USE_HASHCODE,
    IA_AMBIGUOUS_INVOCATION_OF_INHERITED_OR_OUTER_METHOD,
    IS2_INCONSISTENT_SYNC,
    IT_NO_SUCH_ELEMENT,
    NM_SAME_SIMPLE_NAME_AS_INTERFACE,
    NP_LOAD_OF_KNOWN_NULL_VALUE,
    NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE,
    NS_NON_SHORT_CIRCUIT,
    PZLA_PREFER_ZERO_LENGTH_ARRAYS,
    RI_REDUNDANT_INTERFACES,
    RV_RETURN_VALUE_IGNORED_NO_SIDE_EFFECT,
    SA_FIELD_SELF_ASSIGNMENT,
    SE_BAD_FIELD,
    SE_COMPARATOR_SHOULD_BE_SERIALIZABLE,
    SE_INNER_CLASS,
    SE_NO_SERIALVERSIONID,
    SE_TRANSIENT_FIELD_NOT_RESTORED,
    SF_SWITCH_FALLTHROUGH,
    UC_USELESS_CONDITION,
    UMAC_UNCALLABLE_METHOD_OF_ANONYMOUS_CLASS,
    UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR,
    UWF_UNWRITTEN_FIELD"/>
  </Match>

  <!-- Exclude vendor-ed com.fasterxml.uuid:java-uuid-generator types from spotbug -->
  <Match>
    <Class name="~com\.azure\.cosmos\.implementation\.uuid(.+)"/>
    <Bug pattern="CN_IDIOM_NO_SUPER_CALL,
    MS_PKGPROTECT,
    DM_CONVERT_CASE,
    MS_MUTABLE_COLLECTION_PKGPROTECT,
    RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE,
    SF_SWITCH_NO_DEFAULT,
    UCF_USELESS_CONTROL_FLOW,
    SE_COMPARATOR_SHOULD_BE_SERIALIZABLE,
    CI_CONFUSED_INHERITANCE,
    MS_SHOULD_BE_FINAL"/>
  </Match>

  <!-- Empty byte array is returned as null to reactor. Reactor transform null from Callable to downstream onComplete  -->
  <Match>
    <Class name="~com\.azure\.core\.http\.okhttp\.implementation\.OkHttpAsyncResponse(.*)"/>
    <Method name="~(.*)\$(getBodyAsByteArray|null)\$(.*)"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- Internal Avro Parser does read the blockCount field. Seems to be a false positive.  -->
  <Match>
    <Or>
      <Class name="com.azure.storage.internal.avro.implementation.schema.complex.AvroArraySchema"/>
      <Class name="com.azure.storage.internal.avro.implementation.schema.complex.AvroMapSchema"/>
      <Class name="com.azure.storage.internal.avro.implementation.schema.file.AvroBlockSchema"/>
    </Or>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Internal Avro Parser does check the types before casting. Seems to be a false positive.  -->
  <Match>
    <Class name="com.azure.storage.internal.avro.implementation.schema.AvroSchema"/>
    <Method name="getSchema"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>

  <!-- FluxInputStream definitely throws an IOException since this.lastError is an IOException. -->
  <Match>
    <Class name="com.azure.storage.common.implementation.FluxInputStream"/>
    <Method name="read"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- This dead store is due to a deficiency in the Customization class. We need to reference the original return type but we have no use for it so we just comment it out -->
  <Match>
    <Class name="com.azure.storage.blob.models.Block"/>
    <Method name="getSize"/>
    <Bug pattern="DLS_DEAD_LOCAL_STORE"/>
  </Match>

  <!-- Exclude REC_CATCH_EXCEPTION and false positive error for management samples. All samples in management catch Exception instead of throw it. -->
  <Match>
    <Package name="~com\.azure\.resourcemanager(\.[^.]+)*\.samples(\.[^.]+)*"/>
    <Bug pattern="REC_CATCH_EXCEPTION,
                  RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE,
                  RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>

  <!-- Exclude BC_UNCONFIRMED_CAST_OF_RETURN_VALUE as false positive -->
  <Match>
    <Or>
      <Class name="com.azure.resourcemanager.resources.fluentcore.dag.TaskGroup"/>
      <Class name="com.azure.resourcemanager.resources.fluentcore.dag.TaskGroup$ProxyTaskGroupWrapper"/>
    </Or>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <!-- Exclude NM_CLASS_NOT_EXCEPTION for all resource manager due to it is just naming -->
  <Match>
    <Class name="~com\.azure\.resourcemanager(\.[^.]+)*"/>
    <Bug pattern="NM_CLASS_NOT_EXCEPTION"/>
  </Match>

  <!-- Exclude for Resource Manager generated code -->
  <!-- NP_LOAD_OF_KNOWN_NULL_VALUE - Known issue in autorest of setting parameters when calling REST API -->
  <!-- SIC_INNER_SHOULD_BE_STATIC_ANON - Known issue in autorest of inner Enumeration for InputStream response -->
  <!-- UPM_UNCALLED_PRIVATE_METHOD - Known issue in autorest to generate method that might not be called -->
  <!-- SKIPPED_CLASS_TOO_BIG - Nothing we can do about this -->
  <!-- PZLA_PREFER_ZERO_LENGTH_ARRAYS - byte array will return null by generator -->
  <Match>
    <Or>
      <Class name="~com\.azure\.resourcemanager(\.[^.]+)*\.fluent\.([^.]+)Client"/>
      <Class name="~com\.azure\.resourcemanager(\.[^.]+)*\.implementation\.([^.]+)ClientImpl"/>
    </Or>
    <Bug pattern="NP_LOAD_OF_KNOWN_NULL_VALUE,SKIPPED_CLASS_TOO_BIG,UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>
  <Match>
    <Class name="~com\.azure\.resourcemanager(\.[^.]+)*\.fluent(\.[^.]+)*"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>
  <Match>
    <Class name="~com\.azure\.resourcemanager(\.[^.]+)*\.implementation\.([^.]+)ClientImpl([^.]*)"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>
  <Match>
    <And>
      <Class name="~com\.azure\.resourcemanager(\.[^.]+)*\.implementation\.([^.]+)Impl"/>
      <Or>
        <Method name="manager"/>
        <Method name="serviceClient"/>
      </Or>
    </And>
    <Bug pattern="UPM_UNCALLED_PRIVATE_METHOD"/>
  </Match>

  <!-- Exclude from spring related classes -->
  <Match>
    <And>
      <Or>
        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureKeyCredentialResolver"/>
        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureNamedKeyCredentialResolver"/>
        <Class name="com.azure.spring.core.implementation.credential.resolver.AzureSasCredentialResolver"/>
        <Class name="com.azure.spring.service.implementation.storage.credential.StorageSharedKeyCredentialResolver" />
      </Or>
      <Method name="resolve"/>
    </And>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>
  
  <Match>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE,
                  NP_LOAD_OF_KNOWN_NULL_VALUE,
                  RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE,
                  RCN_REDUNDANT_NULLCHECK_OF_NULL_VALUE"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.azure.spring.integration.servicebus.queue.ServiceBusQueueTemplate$QueueMessageHandler"/> <!-- false positive -->
      <Class name="com.azure.spring.servicebus.core.topic.ServiceBusTopicTemplate$TopicMessageHandler"/> <!-- false positive -->
    </Or>
    <Method name="OnCloseSessionAsync"/>
    <Bug pattern="NM_METHOD_NAMING_CONVENTION"/>
  </Match>
  <!-- Generated implementation of SubscriptionPropertiesSupplier is using an inline class -->
  <Match>
    <Class name="com.azure.spring.servicebus.core.processor.DefaultServiceBusNamespaceProcessorFactory"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <Match>
    <Class name="com.azure.spring.messaging.config.AzureListenerEndpointRegistrar"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH"/>
  </Match>

  <Match>
    <Class name="com.azure.spring.integration.servicebus.com.azure.spring.eventhubs.support.converter.converter.ServiceBusMessageConverter"/>
    <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="com.azure.spring.cloud.autoconfigure.jms.properties.AzureServiceBusJmsProperties"/>
    <Field name="pricingTier"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <Match>
    <Class name="com.azure.spring.cloud.autoconfigure.keyvault.env.KeyVaultOperation" />
    <Field name="timer" />
    <Bug pattern="ST_WRITE_TO_STATIC_FROM_INSTANCE_METHOD"/>
  </Match>

  <Match>
    <Class name="com.azure.spring.cloud.autoconfigure.context.AzureDefaultTokenCredentialAutoConfiguration$AzureServiceClientBuilderFactoryPostProcessor"/>
    <Field name="beanFactory"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- Referring to https://sourceforge.net/p/findbugs/bugs/1385/, the @Nullable gives a false positive on equals() method -->
  <Match>
    <Class name="com.azure.spring.messaging.ConsumerIdentifier"/>
    <Method name="equals"/>
    <Bug pattern="NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION"/>
  </Match>

  <!-- The transient fields are not used if deserialization happens. -->
  <Match>
    <Class name="com.azure.identity.implementation.MsalAuthenticationAccount"/>
    <Field name="authenticationRecord"/>
    <Bug pattern="SE_TRANSIENT_FIELD_NOT_RESTORED"/>
  </Match>

  <!-- These fields are designed to be not written. They are for deserializing. -->
  <Match>
    <Class name="com.azure.identity.implementation.LinuxKeyRingAccessor$GError"/>
    <Bug pattern="UWF_UNWRITTEN_FIELD"/>
  </Match>

  <!-- These fields use File Reader with default encoding, java 8 doesn't support passing in encoding type. -->
  <Match>
    <Class name="com.azure.identity.implementation.IntelliJCacheAccessor"/>
    <Or>
      <Method name="getIntellijServicePrincipalDetails"/>
      <Method name="getKdbxPassword"/>
      <Method name="getCredentialFromKdbx"/>
    </Or>
    <Bug pattern="DM_DEFAULT_ENCODING,
    REC_CATCH_EXCEPTION"/>
  </Match>

  <!-- The field is designed to be unread and for serialization purpose. -->
  <Match>
    <Class name="~com\.azure\.search\.documents\.indexes\.models\.(EdgeNGramTokenFilter|KeywordTokenizer|LuceneStandardTokenizer|NGramTokenFilter|SynonymMap)"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Use static final ObjectMapper property to save the cost of ObjectMapper initialization. -->
  <Match>
    <Class name="com.azure.search.documents.SearchAsyncClient"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <Match>
    <Class name="com.azure.core.experimental.serializer.JsonSerializer"/>
    <Bug pattern="NM_SAME_SIMPLE_NAME_AS_INTERFACE"/>
  </Match>

  <!-- Use the property to take the custom serializer from SearchClient. -->
  <Match>
    <Class name="~com\.azure\.search\.documents\.models\.(SearchResult|SuggestResult)"/>
    <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
  </Match>

  <!-- Use abstract TypeReference class for serialize and deserialize API. -->
  <Match>
    <Class name="~com\.azure\.search\.documents\.models\.(SearchResult|SuggestResult)"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.azure.core.serializer.json.jackson.JacksonJsonSerializer"/>
      <Class name="com.azure.core.serializer.json.gson.GsonJsonSerializer"/>
    </Or>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>
  <!-- Setup in Identity Test classes, required for the tests to work properly.-->
  <Match>
    <Class name="com.azure.identity.ClientCertificateCredentialTest"/>
    <Bug pattern="DMI_HARDCODED_ABSOLUTE_FILENAME"/>
  </Match>

  <Match>
    <Or>
      <Class name="com.azure.identity.implementation.IdentityClientTests"/>
      <Class name="com.azure.identity.implementation.SynchronizedAccessorTests"/>
    </Or>
    <Or>
      <Bug pattern="NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE"/> <!-- false positive -->
      <Bug pattern="UI_INHERITANCE_UNSAFE_GETRESOURCE"/>
    </Or>
  </Match>

  <Match>
    <Bug pattern="EI_EXPOSE_REP"/>
    <Class name="com.azure.core.implementation.AccessibleByteArrayOutputStream"/>
  </Match>

  <!-- EventGrid swagger naming -->
  <Match>
    <Or>
      <Class name="com.azure.messaging.eventgrid.implementation.models.CloudEvent"/>
      <Class name="com.azure.messaging.eventgrid.systemevents.AppConfigurationKeyValueDeletedEventData"/>
    </Or>
  </Match>
  <Bug pattern="NM_CONFUSING"/>

  <Match>
    <Class name="com.azure.ai.metricsadvisor.implementation.models.InfluxDBParameter"/>
    <Method name="getUserName"/>
    <Bug pattern="NM_CONFUSING"/>
  </Match>

  <!-- Disabling false positives in azure-core -->
  <!-- This Issue has been resolved as per spotbugs's recommended solution but the static checker still flags it, its a known issue with this rule. -->
  <Match>
    <Class name="com.azure.core.util.logging.ClientLogger"/>
    <Bug pattern="CRLF_INJECTION_LOGS"/>
  </Match>
  <Match>
    <Class name="com.azure.core.util.logging.LoggingEventBuilder"/>
    <Bug pattern="CRLF_INJECTION_LOGS"/>
  </Match>

  <!-- The predictable randomness doesn't expose any crucial detail in this case. -->
  <Match>
    <Class name="com.azure.core.http.policy.ExponentialBackoff"/>
    <Bug pattern="PREDICTABLE_RANDOM"/>
  </Match>

  <!-- In the default log level azure-core will not print the stack trace, but when the user opt-in for the lowest level log (DEBUG) we'll print it, which is expected. -->
  <Match>
    <Class name="com.azure.core.implementation.logging.DefaultLogger"/>
    <Bug pattern="INFORMATION_EXPOSURE_THROUGH_AN_ERROR_MESSAGE"/>
  </Match>

  <!-- False positives -->
  <Match>
    <Class name="com.azure.security.keyvault.jca.KeyVaultKeyStore"/>
    <Method name="getFilenames"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
  </Match>
  <Match>
    <Class name="com.azure.security.keyvault.jca.implementation.utils.HttpUtil"/>
    <Method name="~(get|post)"/>
    <Bug pattern="RCN_REDUNDANT_NULLCHECK_WOULD_HAVE_BEEN_A_NPE"/>
  </Match>
  <Match>
    <Class name="com.azure.security.keyvault.jca.implementation.KeyVaultPrivateKey"/>
    <Bug pattern="SE_BAD_FIELD"/>
  </Match>

  <!-- Returning a new copy of the object is not necessary for queuing system use cases.
  Client do not change content of message once message is created. Array copy would degrade the performance.
  https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core-amqp/src/main/java/com/azure/core/amqp/models/AmqpMessageBody.java#L115 -->
  <Match>
    <Class name="com.azure.core.amqp.models.AmqpMessageBody"/>
    <Field name="data"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>

   <!-- For BinaryData, copying array contents degrades performance. The data returned as byte array from BinaryData is expected to be copied by the call if mutability is desired. -->
  <Match>
    <Class name="com.azure.core.implementation.util.ByteArrayContent"/>
    <Field name="content"/>
    <Bug pattern="EI_EXPOSE_REP"/>
  </Match>


  <!-- Buffered responses are only used when we know the response body will be deserialized into a POJO. -->
  <!-- Given that we don't want to waste resources copying the array when we return it. -->
  <!-- Additionally, we don't need to copy the array when receiving it as the process to convert the response into an array -->
  <!-- it will be deeply copied. -->
  <Match>
    <Or>
      <Class name="com.azure.core.http.netty.implementation.NettyAsyncHttpBufferedResponse"/>
      <Class name="com.azure.core.http.okhttp.implementation.OkHttpAsyncBufferedResponse"/>
    </Or>
    <Bug pattern="EI_EXPOSE_REP2"/>
  </Match>

  <!-- Machine generated classes for MAA service generate spotBugs errors -->
  <Match>
    <Or>
      <Class name="~com.azure.security.attestation.implementation.models.*"/>
      <Class name="~com.azure.security.attestation.models.*+"/>
    </Or>
    <Or>
      <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
      <Bug pattern="UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR"/>
    </Or>
  </Match>

  <!-- Generated implementation of Anomaly Detector is using an inline class -->
  <Match>
    <Class name="com.azure.ai.anomalydetector.implementation.AnomalyDetectorClientImpl"/>
    <Bug pattern="SIC_INNER_SHOULD_BE_STATIC_ANON"/>
  </Match>

  <!-- Some generated base clients in Purview Catalog do not send api-version -->
  <Match>
    <Class name="~com\.azure\.analytics\.purview\.catalog\.\w+BaseClient"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- Two clients in Confidential Ledger share the same builder resulting unused field in each  -->
  <Match>
    <Class name="~com\.azure\.security\.confidentialledger\.\w+BaseClient"/>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>

  <!-- This is a false positive. The type of TOptions is known because it is set
       in the constructor of the concrete class. -->
  <Match>
    <Class name="~com\.azure\.messaging\.eventhubs\.perf\.[\w]+Test"/>
    <Bug pattern="BC_UNCONFIRMED_CAST"/>
  </Match>

  <!-- We shouldn't return a zero-length array if null is provided to serialization/deserialization and clone methods. -->
  <Match>
    <Class name="com.azure.security.keyvault.keys.models.Base64UrlJsonDeserializer"/>
    <Method name="deserialize"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>
  <Match>
    <Class name="com.azure.security.keyvault.keys.models.ByteExtensions"/>
    <Method name="clone"/>
    <Bug pattern="PZLA_PREFER_ZERO_LENGTH_ARRAYS"/>
  </Match>

  <!-- If the ServiceVersion type doesn't implement Enum it would have already thrown an exception. -->
  <Match>
    <Class name="com.azure.core.test.implementation.AzureMethodSourceArgumentsProvider"/>
    <Method name="getServiceVersions"/>
    <Bug pattern="BC_UNCONFIRMED_CAST_OF_RETURN_VALUE"/>
  </Match>

  <Match>
    <Class name="~com\.azure\.search.*"/>
    <Or>
      <Field name="odataType"/>
      <Field name="type"/>
    </Or>
    <Bug pattern="URF_UNREAD_FIELD"/>
  </Match>
</FindBugsFilter>