3.76.0 (latest) 3.75.0 3.74.0 3.73.0 3.72.0 3.71.0 3.70.0 3.69.0 3.68.0 3.67.0 3.66.0 3.65.0 3.64.0 3.63.0 3.62.0 3.61.0 3.60.0 3.59.0 3.58.0 3.57.0 3.56.0 3.55.0 3.54.0 3.53.0 3.52.0 3.51.0 3.50.0 3.49.0 3.48.0 3.47.0 3.46.0 3.45.0 3.44.0 3.43.0 3.42.0 3.41.0 3.40.0 3.39.0 3.38.0 3.37.0 3.36.0 3.35.0 3.34.0 3.33.0 3.32.0 3.31.0 3.30.0 3.29.0 3.28.0 3.27.0 3.26.0 3.25.0 3.24.0 3.23.0 3.22.0 3.21.0 3.20.0 3.19.0 3.18.0 3.17.0 3.16.0 3.15.0 3.14.0 3.13.0 3.12.0 3.11.0 3.10.0 3.9.0 3.8.0 3.7.0 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0

    public sealed class OpenApiSchema : IMessage<OpenApiSchema>, IEquatable<OpenApiSchema>, IDeepCloneable<OpenApiSchema>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1 API class OpenApiSchema.

Schema is used to define the format of input/output data. Represents a select
subset of an [OpenAPI 3.0 schema
object](https://spec.openapis.org/oas/v3.0.3#schema-object). More fields may
be added in the future as needed.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> OpenApiSchema

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[OpenApiSchema](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[OpenApiSchema](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[OpenApiSchema](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.AIPlatform.V1](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1)

## Assembly

Google.Cloud.AIPlatform.V1.dll

## Constructors

### OpenApiSchema()

    public OpenApiSchema()

### OpenApiSchema(OpenApiSchema)

    public OpenApiSchema(OpenApiSchema other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema` |

## Properties

### AdditionalProperties

    public Value AdditionalProperties { get; set; }

Optional. Can either be a boolean or an object; controls the presence of
additional properties.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Value.html` |   |

### AnyOf

    public RepeatedField<OpenApiSchema> AnyOf { get; }

Optional. The value should be validated against any (one or more) of the
subschemas in the list.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema` |   |

### Default

    public Value Default { get; set; }

Optional. Default value of the data.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Value.html` |   |

### Defs

    public MapField<string, OpenApiSchema> Defs { get; }

Optional. A map of definitions for use by `ref`
Only allowed at the root of the schema.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema` |   |

### Description

    public string Description { get; set; }

Optional. The description of the data.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Enum

    public RepeatedField<string> Enum { get; }

Optional. Possible values of the element of primitive type with enum
format. Examples:

1. We can define direction as : {type:STRING, format:enum, enum:\["EAST", NORTH", "SOUTH", "WEST"\]}
2. We can define apartment number as : {type:INTEGER, format:enum, enum:\["101", "201", "301"\]}

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Example

    public Value Example { get; set; }

Optional. Example of the object. Will only populated when the object is the
root.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.Value.html` |   |

### Format

    public string Format { get; set; }

Optional. The format of the data.
Supported formats:
for NUMBER type: "float", "double"
for INTEGER type: "int32", "int64"
for STRING type: "email", "byte", etc

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Items

    public OpenApiSchema Items { get; set; }

Optional. SCHEMA FIELDS FOR TYPE ARRAY
Schema of the elements of Type.ARRAY.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema` |   |

### MaxItems

    public long MaxItems { get; set; }

Optional. Maximum number of the elements for Type.ARRAY.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MaxLength

    public long MaxLength { get; set; }

Optional. Maximum length of the Type.STRING

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MaxProperties

    public long MaxProperties { get; set; }

Optional. Maximum number of the properties for Type.OBJECT.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### Maximum

    public double Maximum { get; set; }

Optional. Maximum value of the Type.INTEGER and Type.NUMBER

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.double` |   |

### MinItems

    public long MinItems { get; set; }

Optional. Minimum number of the elements for Type.ARRAY.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MinLength

    public long MinLength { get; set; }

Optional. SCHEMA FIELDS FOR TYPE STRING
Minimum length of the Type.STRING

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### MinProperties

    public long MinProperties { get; set; }

Optional. Minimum number of the properties for Type.OBJECT.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.int64` |   |

### Minimum

    public double Minimum { get; set; }

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER
Minimum value of the Type.INTEGER and Type.NUMBER

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.double` |   |

### Nullable

    public bool Nullable { get; set; }

Optional. Indicates if the value may be null.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### Pattern

    public string Pattern { get; set; }

Optional. Pattern of the Type.STRING to restrict a string to a regular
expression.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Properties

    public MapField<string, OpenApiSchema> Properties { get; }

Optional. SCHEMA FIELDS FOR TYPE OBJECT
Properties of Type.OBJECT.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.MapField-2.htmlhttps://learn.microsoft.com/dotnet/api/system.stringhttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.OpenApiSchema` |   |

### PropertyOrdering

    public RepeatedField<string> PropertyOrdering { get; }

Optional. The order of the properties.
Not a standard field in open api spec. Only used to support the order of
the properties.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Ref

    public string Ref { get; set; }

Optional. Allows indirect references between schema nodes. The value should
be a valid reference to a child of the root `defs`.

For example, the following schema defines a reference to a schema node
named "Pet":

type: object
properties:
pet:
ref: #/defs/Pet
defs:
Pet:
type: object
properties:
name:
type: string

The value of the "pet" property is a reference to the schema node
named "Pet".
See details in
<https://json-schema.org/understanding-json-schema/structuring>

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Required

    public RepeatedField<string> Required { get; }

Optional. Required properties of Type.OBJECT.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.Collections.RepeatedField-1.htmlhttps://learn.microsoft.com/dotnet/api/system.string` |   |

### Title

    public string Title { get; set; }

Optional. The title of the Schema.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### Type

    public Type Type { get; set; }

Optional. The type of the data.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.AIPlatform.V1/latest/Google.Cloud.AIPlatform.V1.Type` |   |