ObjectSchemaRequest interface
Stay organized with collections
Save and categorize content based on your preferences.
Interface for JSON parameters in a schema of SchemaType "object" when not using the Schema.object() helper.
Signature:
export interface ObjectSchemaRequest extends SchemaRequest
Extends: SchemaRequest
Properties
| Property |
Type |
Description |
| optionalProperties |
never |
This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the Schema.object() helper method. Populating this property will cause response errors if the object is not wrapped with Schema.object(). |
| type |
'object' |
|
ObjectSchemaRequest.optionalProperties
This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the Schema.object() helper method. Populating this property will cause response errors if the object is not wrapped with Schema.object().
Signature:
optionalProperties?: never;
ObjectSchemaRequest.type
Signature:
type: 'object';
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-07 UTC.
[null,null,["Last updated 2025-08-07 UTC."],[],[],null,["Interface for JSON parameters in a schema of \"object\" when not using the `Schema.object()` helper.\n\n**Signature:** \n\n export interface ObjectSchemaRequest extends SchemaRequest \n\n**Extends:** [SchemaRequest](./ai.schemarequest.md#schemarequest_interface)\n\nProperties\n\n| Property | Type | Description |\n|-----------------------------------------------------------------------------------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [optionalProperties](./ai.objectschemarequest.md#objectschemarequestoptionalproperties) | never | This is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the `Schema.object()` helper method. Populating this property will cause response errors if the object is not wrapped with `Schema.object()`. |\n| [type](./ai.objectschemarequest.md#objectschemarequesttype) | 'object' | |\n\nObjectSchemaRequest.optionalProperties\n\nThis is not a property accepted in the final request to the backend, but is a client-side convenience property that is only usable by constructing a schema through the `Schema.object()` helper method. Populating this property will cause response errors if the object is not wrapped with `Schema.object()`.\n\n**Signature:** \n\n optionalProperties?: never;\n\nObjectSchemaRequest.type\n\n**Signature:** \n\n type: 'object';"]]
