Skip to content

wip: Schema.fromEnum() #6968

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

wip: Schema.fromEnum() #6968

wants to merge 2 commits into from

Conversation

thatfiredev
Copy link
Member

No description provided.

Copy link
Contributor

github-actions bot commented May 19, 2025

Javadoc Changes:
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/Schema.Companion.html	2025-05-19 16:47:23.452391102 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/Schema.Companion.html	2025-05-19 16:43:43.222745074 +0000
@@ -48,6 +48,20 @@
           <tr>
             <td><code>static&nbsp;final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
             <td>
+              <div><code>&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,&nbsp;boolean&nbsp;nullable)</code></div>
+              <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Kotlin Enum.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code>static&nbsp;final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
+            <td>
+              <div><code>&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;nullable<br>)</code></div>
+              <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code>static&nbsp;final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#numDouble(kotlin.String,kotlin.Boolean)">numDouble</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,&nbsp;boolean&nbsp;nullable)</code></div>
               <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for a double-precision floating-point number.</p>
             </td>
@@ -187,6 +201,80 @@
                 </td>
               </tr>
               <tr>
+                <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description</code></td>
+                <td>
+                  <p>The description of what the parameter should contain or represent</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>boolean&nbsp;nullable</code></td>
+                <td>
+                  <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="fromEnum(kotlin.String, kotlin.Boolean)"></a><a name="fromEnum-kotlin.String-kotlin.Boolean-"></a><a name="fromenum"></a>
+        <h3 class="api-name" id="fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a>&nbsp;&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,&nbsp;boolean&nbsp;nullable)</pre>
+        <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Kotlin Enum.</p>
+        <p>For example, the cardinal directions can be represented as:</p>
+        <pre class="prettyprint">enum class CardinalDirection { NORTH, EAST, SOUTH, WEST }<br><br>Schema.fromEnum&lt;CardinalDirection&gt;()</pre>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description</code></td>
+                <td>
+                  <p>The description of what the parameter should contain or represent</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>boolean&nbsp;nullable</code></td>
+                <td>
+                  <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="fromEnum(java.lang.Class, kotlin.String, kotlin.Boolean)"></a><a name="fromEnum-java.lang.Class-kotlin.String-kotlin.Boolean-"></a><a name="fromenum"></a>
+        <h3 class="api-name" id="fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a>&nbsp;&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;nullable<br>)</pre>
+        <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+        <p>For example, the cardinal directions can be represented as:</p>
+        <pre class="prettyprint">enum CardinalDirection { NORTH, EAST, SOUTH, WEST }<br><br>Schema.fromEnum(CardinalDirection.class);</pre>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass</code></td>
+                <td>
+                  <p>The Enum's Java class.</p>
+                </td>
+              </tr>
+              <tr>
                 <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description</code></td>
                 <td>
                   <p>The description of what the parameter should contain or represent</p>
--- /home/runner/diff/original/firebase-kotlindoc/android/com/google/firebase/ai/type/Schema.html	2025-05-19 16:47:23.441391122 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/android/com/google/firebase/ai/type/Schema.html	2025-05-19 16:43:43.208745096 +0000
@@ -148,6 +148,13 @@
           <tr>
             <td><code>static&nbsp;final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
             <td>
+              <div><code>&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;nullable<br>)</code></div>
+              <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code>static&nbsp;final @<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
+            <td>
               <div><code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,&nbsp;boolean&nbsp;nullable)</code></div>
               <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for a 32-bit signed integer number.</p>
             </td>
@@ -379,6 +386,46 @@
                 </td>
               </tr>
               <tr>
+                <td><code>boolean&nbsp;nullable</code></td>
+                <td>
+                  <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="fromEnum(java.lang.Class, kotlin.String, kotlin.Boolean)"></a><a name="fromEnum-java.lang.Class-kotlin.String-kotlin.Boolean-"></a><a name="fromenum"></a>
+        <h3 class="api-name" id="fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</h3>
+        <pre class="api-signature no-pretty-print">public&nbsp;static&nbsp;final&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a>&nbsp;&lt;E&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Enum.html">Enum</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&gt; <a href="/docs/reference/android/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;nullable<br>)</pre>
+        <p>Returns a <code><a href="/docs/reference/android/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+        <p>For example, the cardinal directions can be represented as:</p>
+        <pre class="prettyprint">enum CardinalDirection { NORTH, EAST, SOUTH, WEST }<br><br>Schema.fromEnum(CardinalDirection.class);</pre>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> <a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;@<a href="https://developer.android.com/reference/kotlin/androidx/annotation/NonNull.html">NonNull</a> E&gt;&nbsp;enumClass</code></td>
+                <td>
+                  <p>The Enum's Java class.</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code><a href="https://developer.android.com/reference/kotlin/java/lang/String.html">String</a>&nbsp;description</code></td>
+                <td>
+                  <p>The description of what the parameter should contain or represent</p>
+                </td>
+              </tr>
+              <tr>
                 <td><code>boolean&nbsp;nullable</code></td>
                 <td>
                   <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
--- /home/runner/diff/original/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Schema.html	2025-05-19 16:47:23.475391059 +0000
+++ /home/runner/diff/modified/firebase-kotlindoc/kotlin/com/google/firebase/ai/type/Schema.html	2025-05-19 16:43:43.248745034 +0000
@@ -63,6 +63,20 @@
             </td>
           </tr>
           <tr>
+            <td><code>inline <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
+            <td>
+              <div><code>&lt;E&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;E&gt;&gt; <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</a>(description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,&nbsp;nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div>
+              <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Kotlin Enum.</p>
+            </td>
+          </tr>
+          <tr>
+            <td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
+            <td>
+              <div><code>&lt;E&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;E&gt;&gt; <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;enumClass:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;E&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,<br>&nbsp;&nbsp;&nbsp;&nbsp;nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><br>)</code></div>
+              <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+            </td>
+          </tr>
+          <tr>
             <td><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code></td>
             <td>
               <div><code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.Companion.html#integer(kotlin.String,kotlin.Boolean)">integer</a>(description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>?,&nbsp;nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a>)</code></div>
@@ -324,6 +338,80 @@
                 </td>
               </tr>
               <tr>
+                <td><code>nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td>
+                <td>
+                  <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="fromEnum(kotlin.String, kotlin.Boolean)"></a><a name="fromEnum-kotlin.String-kotlin.Boolean-"></a><a name="fromenum"></a>
+        <h3 class="api-name" id="fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</h3>
+        <pre class="api-signature no-pretty-print">inline&nbsp;fun&nbsp;&lt;E&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;E&gt;&gt; <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(kotlin.String,kotlin.Boolean)">fromEnum</a>(description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,&nbsp;nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></pre>
+        <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Kotlin Enum.</p>
+        <p>For example, the cardinal directions can be represented as:</p>
+        <pre class="prettyprint">enum class CardinalDirection { NORTH, EAST, SOUTH, WEST }<br><br>Schema.fromEnum&lt;CardinalDirection&gt;()</pre>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td>
+                <td>
+                  <p>The description of what the parameter should contain or represent</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td>
+                <td>
+                  <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>
+                </td>
+              </tr>
+            </tbody>
+          </table>
+        </div>
+      </div>
+      <div class="api-item"><a name="fromEnum(java.lang.Class, kotlin.String, kotlin.Boolean)"></a><a name="fromEnum-java.lang.Class-kotlin.String-kotlin.Boolean-"></a><a name="fromenum"></a>
+        <h3 class="api-name" id="fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</h3>
+        <pre class="api-signature no-pretty-print">fun&nbsp;&lt;E&nbsp;:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a>&lt;E&gt;&gt; <a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.Companion.html#fromEnum(java.lang.Class,kotlin.String,kotlin.Boolean)">fromEnum</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;enumClass:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;E&gt;,<br>&nbsp;&nbsp;&nbsp;&nbsp;description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null,<br>&nbsp;&nbsp;&nbsp;&nbsp;nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false<br>):&nbsp;<a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></pre>
+        <p>Returns a <code><a href="/docs/reference/kotlin/com/google/firebase/ai/type/Schema.html">Schema</a></code> for the given Java Enum.</p>
+        <p>For example, the cardinal directions can be represented as:</p>
+        <pre class="prettyprint">enum CardinalDirection { NORTH, EAST, SOUTH, WEST }<br><br>Schema.fromEnum(CardinalDirection.class);</pre>
+        <div class="devsite-table-wrapper">
+          <table class="responsive">
+            <colgroup>
+              <col width="40%">
+              <col>
+            </colgroup>
+            <thead>
+              <tr>
+                <th colspan="100%">Parameters</th>
+              </tr>
+            </thead>
+            <tbody class="list">
+              <tr>
+                <td><code>enumClass:&nbsp;<a href="https://developer.android.com/reference/kotlin/java/lang/Class.html">Class</a>&lt;E&gt;</code></td>
+                <td>
+                  <p>The Enum's Java class.</p>
+                </td>
+              </tr>
+              <tr>
+                <td><code>description:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a>? = null</code></td>
+                <td>
+                  <p>The description of what the parameter should contain or represent</p>
+                </td>
+              </tr>
+              <tr>
                 <td><code>nullable:&nbsp;<a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a> = false</code></td>
                 <td>
                   <p>Indicates whether the value can be <code>null</code>. Defaults to <code>false</code>.</p>

@google-oss-bot
Copy link
Contributor

1 Warning
⚠️ Did you forget to add a changelog entry? (Add the 'no-changelog' label to the PR to silence this warning.)

Generated by 🚫 Danger

@google-oss-bot
Copy link
Contributor

Copy link
Contributor

Test Results

 22 files   -  44   22 suites   - 44   37s ⏱️ -39s
104 tests  - 448  104 ✅  - 447  0 💤  - 1  0 ❌ ±0 
208 runs   - 896  208 ✅  - 894  0 💤  - 2  0 ❌ ±0 

Results for commit 85f1ce5. ± Comparison against base commit f2257e4.

This pull request removes 552 and adds 104 tests. Note that renamed tests count towards both.
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ descriptor should have expected values
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ deserialize() should throw UnsupportedOperationException
com.google.firebase.dataconnect.AnyValueSerializerUnitTest ‑ serialize() should throw UnsupportedOperationException
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Boolean) creates an object with the expected value
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Double) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Double) creates an object with the expected value (normal cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(List) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(List) creates an object with the expected value (normal cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Map) creates an object with the expected value (edge cases)
com.google.firebase.dataconnect.AnyValueUnitTest ‑ constructor(Map) creates an object with the expected value (normal cases)
…
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ citation parsed correctly
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ image rejected
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ long reply
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ prompt blocked for safety
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ short reply
com.google.firebase.ai.DevAPIStreamingSnapshotTests ‑ stopped for recitation
com.google.firebase.ai.DevAPIUnarySnapshotTests ‑ citation returns correctly
com.google.firebase.ai.DevAPIUnarySnapshotTests ‑ invalid api key
com.google.firebase.ai.DevAPIUnarySnapshotTests ‑ long reply
com.google.firebase.ai.DevAPIUnarySnapshotTests ‑ response blocked for safety
…

@google-oss-bot
Copy link
Contributor

Size Report 1

Affected Products

  • firebase-ai

    TypeBase (f2257e4)Merge (ad6f5a7)Diff
    aar819 kB821 kB+2.15 kB (+0.3%)
    apk (aggressive)1.55 MB1.55 MB+1.22 kB (+0.1%)
    apk (release)9.52 MB9.52 MB+2.03 kB (+0.0%)

Test Logs

  1. https://storage.googleapis.com/firebase-sdk-metric-reports/cmeFULX2fm.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants