Add missing optIn declarations to reduce compilation noise #6713
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
Part of the serialization API we use requires optIn, and without the correct declarations we get warnings printed when compiling the code.
Javadoc Changes:--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html 2025-02-24 18:15:45.911104887 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/vertexai/type/FinishReason.html 2025-02-24 18:13:38.616309183 +0000
@@ -46,70 +46,70 @@
</thead>
<tbody class="list">
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></code></div>
<p>Token generation stopped because the content contains forbidden terms.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></code></div>
<p>The function call generated by the model is invalid.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></code></div>
<p>Model hit the token limit.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a></code></div>
<p>Model stopped for another reason.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></code></div>
<p>Token generation stopped for potentially containing prohibited content.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></code></div>
<p>The token generation was stopped because the response was flagged for unauthorized citations.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a></code></div>
<p><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></code></div>
<p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></code></div>
<p>Model finished successfully and stopped.</p>
</td>
</tr>
<tr>
- <td><code>static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
+ <td><code>final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a></code></td>
<td>
<div><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a></code></div>
<p>A new and not yet supported value.</p>
@@ -136,52 +136,52 @@
<h2>Public fields</h2>
<div class="api-item"><a name="getBLOCKLIST()"></a><a name="setBLOCKLIST()"></a><a name="getBLOCKLIST--"></a><a name="setBLOCKLIST--"></a>
<h3 class="api-name" id="BLOCKLIST()">BLOCKLIST</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#BLOCKLIST()">BLOCKLIST</a></pre>
<p>Token generation stopped because the content contains forbidden terms.</p>
</div>
<div class="api-item"><a name="getMALFORMED_FUNCTION_CALL()"></a><a name="setMALFORMED_FUNCTION_CALL()"></a><a name="getMALFORMED_FUNCTION_CALL--"></a><a name="setMALFORMED_FUNCTION_CALL--"></a>
<h3 class="api-name" id="MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MALFORMED_FUNCTION_CALL()">MALFORMED_FUNCTION_CALL</a></pre>
<p>The function call generated by the model is invalid.</p>
</div>
<div class="api-item"><a name="getMAX_TOKENS()"></a><a name="setMAX_TOKENS()"></a><a name="getMAX_TOKENS--"></a><a name="setMAX_TOKENS--"></a>
<h3 class="api-name" id="MAX_TOKENS()">MAX_TOKENS</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#MAX_TOKENS()">MAX_TOKENS</a></pre>
<p>Model hit the token limit.</p>
</div>
<div class="api-item"><a name="getOTHER()"></a><a name="setOTHER()"></a><a name="getOTHER--"></a><a name="setOTHER--"></a>
<h3 class="api-name" id="OTHER()">OTHER</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#OTHER()">OTHER</a></pre>
<p>Model stopped for another reason.</p>
</div>
<div class="api-item"><a name="getPROHIBITED_CONTENT()"></a><a name="setPROHIBITED_CONTENT()"></a><a name="getPROHIBITED_CONTENT--"></a><a name="setPROHIBITED_CONTENT--"></a>
<h3 class="api-name" id="PROHIBITED_CONTENT()">PROHIBITED_CONTENT</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#PROHIBITED_CONTENT()">PROHIBITED_CONTENT</a></pre>
<p>Token generation stopped for potentially containing prohibited content.</p>
</div>
<div class="api-item"><a name="getRECITATION()"></a><a name="setRECITATION()"></a><a name="getRECITATION--"></a><a name="setRECITATION--"></a>
<h3 class="api-name" id="RECITATION()">RECITATION</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#RECITATION()">RECITATION</a></pre>
<p>The token generation was stopped because the response was flagged for unauthorized citations.</p>
</div>
<div class="api-item"><a name="getSAFETY()"></a><a name="setSAFETY()"></a><a name="getSAFETY--"></a><a name="setSAFETY--"></a>
<h3 class="api-name" id="SAFETY()">SAFETY</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SAFETY()">SAFETY</a></pre>
<p><code><a href="/docs/reference/android/com/google/firebase/vertexai/type/SafetySetting.html">SafetySetting</a></code> prevented the model from outputting content.</p>
</div>
<div class="api-item"><a name="getSPII()"></a><a name="setSPII()"></a><a name="getSPII--"></a><a name="setSPII--"></a>
<h3 class="api-name" id="SPII()">SPII</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#SPII()">SPII</a></pre>
<p>Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).</p>
</div>
<div class="api-item"><a name="getSTOP()"></a><a name="setSTOP()"></a><a name="getSTOP--"></a><a name="setSTOP--"></a>
<h3 class="api-name" id="STOP()">STOP</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#STOP()">STOP</a></pre>
<p>Model finished successfully and stopped.</p>
</div>
<div class="api-item"><a name="getUNKNOWN()"></a><a name="setUNKNOWN()"></a><a name="getUNKNOWN--"></a><a name="setUNKNOWN--"></a>
<h3 class="api-name" id="UNKNOWN()">UNKNOWN</h3>
- <pre class="api-signature no-pretty-print">public static final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
+ <pre class="api-signature no-pretty-print">public final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.html">FinishReason</a> <a href="/docs/reference/android/com/google/firebase/vertexai/type/FinishReason.Companion.html#UNKNOWN()">UNKNOWN</a></pre>
<p>A new and not yet supported value.</p>
</div>
<div class="api-item"><a name="getName()"></a><a name="setName()"></a><a name="getName--"></a><a name="setName--"></a> |
Size Report 1Affected Products
Test Logs |
daymxn
approved these changes
Feb 24, 2025
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.
Part of the serialization API we use requires optIn, and without the correct declarations we get warnings printed when compiling the code.