Class Schema (1.28.0)

publicfinalclass SchemaextendsGeneratedMessageV3implementsSchemaOrBuilder

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.

Protobuf type google.cloud.vertexai.v1.Schema

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Schema

Implements

SchemaOrBuilder

Inherited Members

publicstaticfinalintANY_OF_FIELD_NUMBER

publicstaticfinalintDEFAULT_FIELD_NUMBER

publicstaticfinalintDESCRIPTION_FIELD_NUMBER

publicstaticfinalintENUM_FIELD_NUMBER

publicstaticfinalintEXAMPLE_FIELD_NUMBER

publicstaticfinalintFORMAT_FIELD_NUMBER

publicstaticfinalintITEMS_FIELD_NUMBER

publicstaticfinalintMAXIMUM_FIELD_NUMBER

publicstaticfinalintMAX_ITEMS_FIELD_NUMBER

publicstaticfinalintMAX_LENGTH_FIELD_NUMBER

publicstaticfinalintMAX_PROPERTIES_FIELD_NUMBER

publicstaticfinalintMINIMUM_FIELD_NUMBER

publicstaticfinalintMIN_ITEMS_FIELD_NUMBER

publicstaticfinalintMIN_LENGTH_FIELD_NUMBER

publicstaticfinalintMIN_PROPERTIES_FIELD_NUMBER

publicstaticfinalintNULLABLE_FIELD_NUMBER

publicstaticfinalintPATTERN_FIELD_NUMBER

publicstaticfinalintPROPERTIES_FIELD_NUMBER

publicstaticfinalintPROPERTY_ORDERING_FIELD_NUMBER

publicstaticfinalintREQUIRED_FIELD_NUMBER

publicstaticfinalintTITLE_FIELD_NUMBER

publicstaticfinalintTYPE_FIELD_NUMBER

publicstaticSchemagetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticSchema.BuildernewBuilder()

publicstaticSchema.BuildernewBuilder(Schemaprototype)

publicstaticSchemaparseDelimitedFrom(InputStreaminput)

publicstaticSchemaparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticSchemaparseFrom(byte[]data)

publicstaticSchemaparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticSchemaparseFrom(ByteStringdata)

publicstaticSchemaparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticSchemaparseFrom(CodedInputStreaminput)

publicstaticSchemaparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticSchemaparseFrom(InputStreaminput)

publicstaticSchemaparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticSchemaparseFrom(ByteBufferdata)

publicstaticSchemaparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Schema>parser()

publicbooleancontainsProperties(Stringkey)

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

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicSchemagetAnyOf(intindex)

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

repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

publicintgetAnyOfCount()

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

repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

publicList<Schema>getAnyOfList()

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

repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

publicSchemaOrBuildergetAnyOfOrBuilder(intindex)

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

repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

publicList<?extendsSchemaOrBuilder>getAnyOfOrBuilderList()

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

repeated .google.cloud.vertexai.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

publicValuegetDefault()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

publicSchemagetDefaultInstanceForType()

publicValueOrBuildergetDefaultOrBuilder()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetDescription()

Optional. The description of the data.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetDescriptionBytes()

Optional. The description of the data.

string description = 8 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetEnum(intindex)

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"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetEnumBytes(intindex)

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"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

publicintgetEnumCount()

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"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

publicProtocolStringListgetEnumList()

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"]}

repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];

publicValuegetExample()

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

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

publicValueOrBuildergetExampleOrBuilder()

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

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetFormat()

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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetFormatBytes()

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

string format = 7 [(.google.api.field_behavior) = OPTIONAL];

publicSchemagetItems()

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

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

publicSchemaOrBuildergetItemsOrBuilder()

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

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMaxItems()

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

int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMaxLength()

Optional. Maximum length of the Type.STRING

int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMaxProperties()

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

int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];

publicdoublegetMaximum()

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

double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMinItems()

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

int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMinLength()

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

int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];

publiclonggetMinProperties()

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

int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];

publicdoublegetMinimum()

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

double minimum = 16 [(.google.api.field_behavior) = OPTIONAL];

publicbooleangetNullable()

Optional. Indicates if the value may be null.

bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];

publicParser<Schema>getParserForType()

GeneratedMessageV3.getParserForType()

publicStringgetPattern()

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

string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetPatternBytes()

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

string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];

publicMap<String,Schema>getProperties()

Use #getPropertiesMap() instead.

publicintgetPropertiesCount()

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

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

publicMap<String,Schema>getPropertiesMap()

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

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

publicSchemagetPropertiesOrDefault(Stringkey,SchemadefaultValue)

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

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

publicSchemagetPropertiesOrThrow(Stringkey)

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

map<string, .google.cloud.vertexai.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetPropertyOrdering(intindex)

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

repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetPropertyOrderingBytes(intindex)

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

repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];

publicintgetPropertyOrderingCount()

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

repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];

publicProtocolStringListgetPropertyOrderingList()

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

repeated string property_ordering = 25 [(.google.api.field_behavior) = OPTIONAL];

publicStringgetRequired(intindex)

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetRequiredBytes(intindex)

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

publicintgetRequiredCount()

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

publicProtocolStringListgetRequiredList()

Optional. Required properties of Type.OBJECT.

repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicStringgetTitle()

Optional. The title of the Schema.

string title = 24 [(.google.api.field_behavior) = OPTIONAL];

publicByteStringgetTitleBytes()

Optional. The title of the Schema.

string title = 24 [(.google.api.field_behavior) = OPTIONAL];

publicTypegetType()

Optional. The type of the data.

.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];

publicintgetTypeValue()

Optional. The type of the data.

.google.cloud.vertexai.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanhasDefault()

Optional. Default value of the data.

.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanhasExample()

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

.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];

publicbooleanhasItems()

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

.google.cloud.vertexai.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicSchema.BuildernewBuilderForType()

protectedSchema.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicSchema.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)