Cloud AI Platform v1 API - Class OpenApiSchema (3.13.0)

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

Reference documentation and code samples for the Cloud AI Platform 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. More fields may be added in the future as needed.

Inheritance

object > OpenApiSchema

Implements

IMessage OpenApiSchema, IEquatable OpenApiSchema, IDeepCloneable OpenApiSchema, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

OpenApiSchema()

public OpenApiSchema()

OpenApiSchema(OpenApiSchema)

public OpenApiSchema(OpenApiSchema other)

Parameter
Name	Description
`other`	`OpenApiSchema`

Properties

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
`RepeatedFieldOpenApiSchema`

Default

public Value Default { get; set; }

Optional. Default value of the data.

Property Value
Type	Description
`Value`

Description

public string Description { get; set; }

Optional. The description of the data.

Property Value
Type	Description
`string`

Enum

public RepeatedField<string> Enum { get; }

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

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

Property Value
Type	Description
`RepeatedFieldstring`

Example

public Value Example { get; set; }

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

Property Value
Type	Description
`Value`

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
`string`

Items

public OpenApiSchema Items { get; set; }

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

Property Value
Type	Description
`OpenApiSchema`

MaxItems

public long MaxItems { get; set; }

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

Property Value
Type	Description
`long`

MaxLength

public long MaxLength { get; set; }

Optional. Maximum length of the Type.STRING

Property Value
Type	Description
`long`

MaxProperties

public long MaxProperties { get; set; }

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

Property Value
Type	Description
`long`

Maximum

public double Maximum { get; set; }

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

Property Value
Type	Description
`double`

MinItems

public long MinItems { get; set; }

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

Property Value
Type	Description
`long`

MinLength

public long MinLength { get; set; }

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

Property Value
Type	Description
`long`

MinProperties

public long MinProperties { get; set; }

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

Property Value
Type	Description
`long`

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
`double`

Nullable

public bool Nullable { get; set; }

Optional. Indicates if the value may be null.

Property Value
Type	Description
`bool`

Pattern

public string Pattern { get; set; }

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

Property Value
Type	Description
`string`

Properties

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

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

Property Value
Type	Description
`MapFieldstringOpenApiSchema`

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
`RepeatedFieldstring`

Required

public RepeatedField<string> Required { get; }

Optional. Required properties of Type.OBJECT.

Property Value
Type	Description
`RepeatedFieldstring`

Title

public string Title { get; set; }

Optional. The title of the Schema.

Property Value
Type	Description
`string`

Type

public Type Type { get; set; }

Optional. The type of the data.

Property Value
Type	Description
`Type`