Deprecate BatchRequest constructor #1333
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
kolea2
reviewed
Jul 1, 2019
google-api-client/src/main/java/com/google/api/client/googleapis/batch/BatchRequest.java
Outdated
Show resolved
Hide resolved
kolea2
reviewed
Jul 1, 2019
| @@ -232,6 +232,7 @@ public final BatchRequest batch() { | |||
| * @return newly created Batch request | |||
| */ | |||
| public final BatchRequest batch(HttpRequestInitializer httpRequestInitializer) { | |||
| @SuppressWarnings("deprecated") | |||
| BatchRequest batch = | |||
There was a problem hiding this comment.
This one is the method that users should be using that sets the batch path.
kolea2
reviewed
Jul 1, 2019
| * declared by the service configuration. | ||
| */ | ||
| private static final String GLOBAL_BATCH_ENDPOINT = "https://www.googleapis.com/batch"; | ||
| private static final String GLOBAL_BATCH_ENDPOINT_WARNING = "You are using the global batch " |
There was a problem hiding this comment.
Maybe we can also link to javadoc or a more verbose example?
There was a problem hiding this comment.
We would like to migrate the docs off of developers.google.com for these clients, so I migrated the batching and media upload/download docs to the main README in #1334. That will give us a place to target with this message.
There was a problem hiding this comment.
Added a link to the new docs section in the warning message.
kolea2
approved these changes
Jul 1, 2019
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
chingor13
added a commit
that referenced
this pull request
Jul 1, 2019
* Deprecate the BatchRequest public constructor * Update Javadoc sample for batch request * Log a warning if a user is using the global batch endpoint * Fix equality check for Strings * Swap equals comparison to avoid possible NPE * Add URL to visit in the warning message
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Users should obtain a
BatchRequestinstance via their client'sbatch(HttpRequestInitializer)method.