public final class Schema extends GeneratedMessageV3 implements SchemaOrBuilder
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.aiplatform.v1.Schema
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ENUM_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int EXAMPLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int FORMAT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int ITEMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int NULLABLE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int PROPERTIES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int REQUIRED_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
public static Schema getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static Schema.Builder newBuilder()
public static Schema.Builder newBuilder(Schema prototype)
| Parameter |
|---|
| Name | Description |
prototype | Schema
|
public static Schema parseDelimitedFrom(InputStream input)
public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteString data)
public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(CodedInputStream input)
public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(InputStream input)
public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteBuffer data)
public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<Schema> parser()
Methods
public boolean containsProperties(String key)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public Schema getDefaultInstanceForType()
public String getDescription()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The description.
|
public ByteString getDescriptionBytes()
Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
public String getEnum(int index)
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"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The enum at the given index.
|
public ByteString getEnumBytes(int index)
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"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the enum at the given index.
|
public int getEnumCount()
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"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The count of enum.
|
public ProtocolStringList getEnumList()
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"]}
repeated string enum = 9 [(.google.api.field_behavior) = OPTIONAL];
public Value getExample()
Optional. Example of the object. Will only populated when the object is the
root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Value | The example.
|
public ValueOrBuilder getExampleOrBuilder()
Optional. Example of the object. Will only populated when the object is the
root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];
public String getFormat()
Optional. The format of the data.
Supported formats:
for NUMBER type: float, double
for INTEGER type: int32, int64
string format = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
String | The format.
|
public ByteString getFormatBytes()
Optional. The format of the data.
Supported formats:
for NUMBER type: float, double
for INTEGER type: int32, int64
string format = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for format.
|
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Schema | The items.
|
public SchemaOrBuilder getItemsOrBuilder()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
public boolean getNullable()
Optional. Indicates if the value may be null.
bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | The nullable.
|
public Parser<Schema> getParserForType()
Overrides
public Map<String,Schema> getProperties()
public int getPropertiesCount()
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | |
public Map<String,Schema> getPropertiesMap()
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
public Schema getPropertiesOrDefault(String key, Schema defaultValue)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
public Schema getPropertiesOrThrow(String key)
Optional. Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
key | String
|
public String getRequired(int index)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
String | The required at the given index.
|
public ByteString getRequiredBytes(int index)
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
ByteString | The bytes of the required at the given index.
|
public int getRequiredCount()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The count of required.
|
public ProtocolStringList getRequiredList()
Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
Optional. The type of the data.
.google.cloud.aiplatform.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
Type | The type.
|
public int getTypeValue()
Optional. The type of the data.
.google.cloud.aiplatform.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
public boolean hasExample()
Optional. Example of the object. Will only populated when the object is the
root.
.google.protobuf.Value example = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the example field is set.
|
public boolean hasItems()
Optional. Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
|---|
| Type | Description |
boolean | Whether the items field is set.
|
| Returns |
|---|
| Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
public final boolean isInitialized()
Overrides
public Schema.Builder newBuilderForType()
protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public Schema.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
