Cloud AI Platform v1 API - Class OpenApiSchema (2.25.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

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 Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]}

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

Property Value
Type	Description
`string`

Items

public OpenApiSchema Items { get; set; }

Optional. Schema of the elements of Type.ARRAY.

Property Value
Type	Description
`OpenApiSchema`

Nullable

public bool Nullable { get; set; }

Optional. Indicates if the value may be null.

Property Value
Type	Description
`bool`

Properties

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

Optional. Properties of Type.OBJECT.

Property Value
Type	Description
`MapFieldstringOpenApiSchema`

Required

public RepeatedField<string> Required { get; }

Optional. Required properties of Type.OBJECT.

Property Value
Type	Description
`RepeatedFieldstring`

Type

public Type Type { get; set; }

Optional. The type of the data.

Property Value
Type	Description
`Type`