Cloud AI Platform v1 API - Class OpenApiSchema (2.23.0)

Version 2.23.0

• 3.10.0 (latest)
• 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 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

IMessageOpenApiSchema, IEquatableOpenApiSchema, IDeepCloneableOpenApiSchema, 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