Skip to content

Commit

Permalink
chore!: add clirr-ignored-differences.xml
Browse files Browse the repository at this point in the history
BREAKING CHANGE: various renames due to generator changes

Renamed data model properties
* Usage of collectionId replaced with collection
* Usage of fieldId replaced with field
* Usage of indexId replaced with index
* Usage of ParentName replaced with CollectionGroupName
* Usage of AnyPathName replaced with String

Long running operation renames:
* FirestoreAdminClient#createIndex -> FirestoreAdminClient#createIndexAsync
* FirestoreAdminClient#exportDocuments -> FirestoreAdminClient#exportDocumentsAsync
* FirestoreAdminClient#importDocuments -> FirestoreAdminClient#importDocumentsAsync
* FirestoreAdminClient#updateField -> FirestoreAdminClient#updateFieldAsync
  • Loading branch information
BenWhitehead committed Jul 21, 2020
1 parent b395153 commit 570072f
Show file tree
Hide file tree
Showing 2 changed files with 189 additions and 0 deletions.
98 changes: 98 additions & 0 deletions google-cloud-firestore/clirr-ignored-differences.xml
Expand Up @@ -36,4 +36,102 @@
<method>*(com.google.cloud.firestore.FirestoreImpl, *)</method>
</difference>

<!--
createIndex -> createIndexAsync
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation createIndex(com.google.firestore.admin.v1.ParentName, com.google.firestore.admin.v1.Index)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation createIndex(java.lang.String, com.google.firestore.admin.v1.Index)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation createIndex(com.google.firestore.admin.v1.CreateIndexRequest)</method>
</difference>

<!--
exportDocuments -> exportDocumentsAsync
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation exportDocuments(com.google.firestore.admin.v1.DatabaseName)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation exportDocuments(java.lang.String)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation exportDocuments(com.google.firestore.admin.v1.ExportDocumentsRequest)</method>
</difference>
<!--
importDocuments -> importDocumentsAsync
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation importDocuments(com.google.firestore.admin.v1.DatabaseName)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation importDocuments(java.lang.String)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation importDocuments(com.google.firestore.admin.v1.ImportDocumentsRequest)</method>
</difference>
<!--
updatedField -> updateFieldAsync
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation updateField(com.google.firestore.admin.v1.Field)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation updateField(com.google.firestore.admin.v1.UpdateFieldRequest)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient</className>
<method>com.google.longrunning.Operation updateField(com.google.firestore.admin.v1.UpdateFieldRequest)</method>
</difference>

<!--
deleteDocument(AnyPathName) -> deleteDocument(String)
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreClient</className>
<method>void deleteDocument(com.google.firestore.v1.AnyPathName)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/cloud/firestore/v1beta1/FirestoreClient</className>
<method>void deleteDocument(com.google.firestore.v1beta1.AnyPathName)</method>
</difference>

<!--
ParentName -> CollectionGroupName
-->
<difference>
<differenceType>7005</differenceType>
<className>com/google/cloud/firestore/v1/FirestoreAdminClient*</className>
<method>com.google.cloud.firestore.v1.FirestoreAdminClient$List*PagedResponse list*(com.google.firestore.admin.v1.ParentName)</method>
<to>com.google.cloud.firestore.v1.FirestoreAdminClient$List*PagedResponse list*(com.google.firestore.admin.v1.CollectionGroupName)</to>
</difference>

</differences>
@@ -0,0 +1,91 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright 2020 Google LLC
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->

<!-- see http://www.mojohaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
<differences>
<!-- v2.0.0 -->
<!-- Admin field rename
* collectionId -> collection
* fieldId -> field
* indexId -> index
-->
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName</className>
<method>java.lang.String getCollectionId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName</className>
<method>java.lang.String getFieldId()</method>
</difference>

<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName$Builder</className>
<method>java.lang.String getCollectionId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName$Builder</className>
<method>java.lang.String getFieldId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName$Builder</className>
<method>com.google.firestore.admin.v1.FieldName$Builder setCollectionId(java.lang.String)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/FieldName$Builder</className>
<method>com.google.firestore.admin.v1.FieldName$Builder setFieldId(java.lang.String)</method>
</difference>

<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName</className>
<method>java.lang.String getCollectionId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName</className>
<method>java.lang.String getIndexId()</method>
</difference>

<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName$Builder</className>
<method>java.lang.String getCollectionId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName$Builder</className>
<method>java.lang.String getIndexId()</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName$Builder</className>
<method>com.google.firestore.admin.v1.IndexName$Builder setCollectionId(java.lang.String)</method>
</difference>
<difference>
<differenceType>7002</differenceType>
<className>com/google/firestore/admin/v1/IndexName$Builder</className>
<method>com.google.firestore.admin.v1.IndexName$Builder setIndexId(java.lang.String)</method>
</difference>


</differences>

0 comments on commit 570072f

Please sign in to comment.