- 3.79.0 (latest)
- 3.77.0
- 3.76.0
- 3.75.0
- 3.74.0
- 3.73.0
- 3.71.0
- 3.69.0
- 3.68.0
- 3.65.0
- 3.64.0
- 3.63.0
- 3.61.0
- 3.60.0
- 3.59.0
- 3.58.0
- 3.57.0
- 3.56.0
- 3.55.0
- 3.54.0
- 3.53.0
- 3.52.0
- 3.50.0
- 3.49.0
- 3.48.0
- 3.47.0
- 3.46.0
- 3.45.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.33.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.21.0
- 3.20.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.5.0
- 3.4.2
- 3.3.0
- 3.2.0
- 3.0.0
- 2.9.8
- 2.8.9
- 2.7.4
- 2.5.3
- 2.4.0
public final class Schema extends GeneratedMessageV3 implements SchemaOrBuilderSchema 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.v1beta1.Schema
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > SchemaImplements
SchemaOrBuilderStatic Fields
ADDITIONAL_PROPERTIES_FIELD_NUMBER
public static final int ADDITIONAL_PROPERTIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ANY_OF_FIELD_NUMBER
public static final int ANY_OF_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DEFAULT_FIELD_NUMBER
public static final int DEFAULT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DEFS_FIELD_NUMBER
public static final int DEFS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ENUM_FIELD_NUMBER
public static final int ENUM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXAMPLE_FIELD_NUMBER
public static final int EXAMPLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
FORMAT_FIELD_NUMBER
public static final int FORMAT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
ITEMS_FIELD_NUMBER
public static final int ITEMS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAXIMUM_FIELD_NUMBER
public static final int MAXIMUM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAX_ITEMS_FIELD_NUMBER
public static final int MAX_ITEMS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAX_LENGTH_FIELD_NUMBER
public static final int MAX_LENGTH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MAX_PROPERTIES_FIELD_NUMBER
public static final int MAX_PROPERTIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MINIMUM_FIELD_NUMBER
public static final int MINIMUM_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MIN_ITEMS_FIELD_NUMBER
public static final int MIN_ITEMS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MIN_LENGTH_FIELD_NUMBER
public static final int MIN_LENGTH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MIN_PROPERTIES_FIELD_NUMBER
public static final int MIN_PROPERTIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
NULLABLE_FIELD_NUMBER
public static final int NULLABLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PATTERN_FIELD_NUMBER
public static final int PATTERN_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROPERTIES_FIELD_NUMBER
public static final int PROPERTIES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
PROPERTY_ORDERING_FIELD_NUMBER
public static final int PROPERTY_ORDERING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REF_FIELD_NUMBER
public static final int REF_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
REQUIRED_FIELD_NUMBER
public static final int REQUIRED_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TITLE_FIELD_NUMBER
public static final int TITLE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static Schema getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static Schema.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newBuilder(Schema prototype)
public static Schema.Builder newBuilder(Schema prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
Schema |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
parseDelimitedFrom(InputStream input)
public static Schema parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static Schema parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static Schema parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static Schema parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static Schema parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static Schema parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Schema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<Schema> parser()| Returns | |
|---|---|
| Type | Description |
Parser<Schema> |
|
Methods
containsDefs(String key)
public boolean containsDefs(String key) Optional. A map of definitions for use by ref
Only allowed at the root of the schema.
map<string, .google.cloud.aiplatform.v1beta1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsProperties(String key)
public boolean containsProperties(String key)Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAdditionalProperties()
public Value getAdditionalProperties()Optional. Can either be a boolean or an object; controls the presence of additional properties.
.google.protobuf.Value additional_properties = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Value |
The additionalProperties. |
getAdditionalPropertiesOrBuilder()
public ValueOrBuilder getAdditionalPropertiesOrBuilder()Optional. Can either be a boolean or an object; controls the presence of additional properties.
.google.protobuf.Value additional_properties = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getAnyOf(int index)
public Schema getAnyOf(int index)Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.aiplatform.v1beta1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getAnyOfCount()
public int getAnyOfCount()Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.aiplatform.v1beta1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAnyOfList()
public List<Schema> getAnyOfList()Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.aiplatform.v1beta1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<Schema> |
|
getAnyOfOrBuilder(int index)
public SchemaOrBuilder getAnyOfOrBuilder(int index)Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.aiplatform.v1beta1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
getAnyOfOrBuilderList()
public List<? extends SchemaOrBuilder> getAnyOfOrBuilderList()Optional. The value should be validated against any (one or more) of the subschemas in the list.
repeated .google.cloud.aiplatform.v1beta1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.aiplatform.v1beta1.SchemaOrBuilder> |
|
getDefault()
public Value getDefault()Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Value |
The default. |
getDefaultInstanceForType()
public Schema getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDefaultOrBuilder()
public ValueOrBuilder getDefaultOrBuilder()Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getDefs() (deprecated)
public Map<String,Schema> getDefs()Use #getDefsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Schema> |
|
getDefsCount()
public int getDefsCount() Optional. A map of definitions for use by ref
Only allowed at the root of the schema.
map<string, .google.cloud.aiplatform.v1beta1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getDefsMap()
public Map<String,Schema> getDefsMap() Optional. A map of definitions for use by ref
Only allowed at the root of the schema.
map<string, .google.cloud.aiplatform.v1beta1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,Schema> |
|
getDefsOrDefault(String key, Schema defaultValue)
public Schema getDefsOrDefault(String key, Schema defaultValue) Optional. A map of definitions for use by ref
Only allowed at the root of the schema.
map<string, .google.cloud.aiplatform.v1beta1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
Schema |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDefsOrThrow(String key)
public Schema getDefsOrThrow(String key) Optional. A map of definitions for use by ref
Only allowed at the root of the schema.
map<string, .google.cloud.aiplatform.v1beta1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getDescription()
public String getDescription()Optional. The description of the data.
string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
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. |
getEnum(int index)
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 |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The enum at the given index. |
getEnumBytes(int 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the enum at the given index. |
getEnumCount()
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. |
getEnumList()
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];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the enum. |
getExample()
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. |
getExampleOrBuilder()
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];
| Returns | |
|---|---|
| Type | Description |
ValueOrBuilder |
|
getFormat()
public String getFormat()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];
| Returns | |
|---|---|
| Type | Description |
String |
The format. |
getFormatBytes()
public ByteString getFormatBytes()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];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for format. |
getItems()
public Schema getItems()Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Schema |
The items. |
getItemsOrBuilder()
public SchemaOrBuilder getItemsOrBuilder()Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SchemaOrBuilder |
|
getMaxItems()
public long getMaxItems()Optional. Maximum number of the elements for Type.ARRAY.
int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The maxItems. |
getMaxLength()
public long getMaxLength()Optional. Maximum length of the Type.STRING
int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The maxLength. |
getMaxProperties()
public long getMaxProperties()Optional. Maximum number of the properties for Type.OBJECT.
int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The maxProperties. |
getMaximum()
public double getMaximum()Optional. Maximum value of the Type.INTEGER and Type.NUMBER
double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
double |
The maximum. |
getMinItems()
public long getMinItems()Optional. Minimum number of the elements for Type.ARRAY.
int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The minItems. |
getMinLength()
public long getMinLength()Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING
int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The minLength. |
getMinProperties()
public long getMinProperties()Optional. Minimum number of the properties for Type.OBJECT.
int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
long |
The minProperties. |
getMinimum()
public double getMinimum()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];
| Returns | |
|---|---|
| Type | Description |
double |
The minimum. |
getNullable()
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. |
getParserForType()
public Parser<Schema> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<Schema> |
|
getPattern()
public String getPattern()Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pattern. |
getPatternBytes()
public ByteString getPatternBytes()Optional. Pattern of the Type.STRING to restrict a string to a regular expression.
string pattern = 20 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pattern. |
getProperties() (deprecated)
public Map<String,Schema> getProperties()Use #getPropertiesMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,Schema> |
|
getPropertiesCount()
public int getPropertiesCount()Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getPropertiesMap()
public Map<String,Schema> getPropertiesMap()Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,Schema> |
|
getPropertiesOrDefault(String key, Schema defaultValue)
public Schema getPropertiesOrDefault(String key, Schema defaultValue)Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
Schema |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getPropertiesOrThrow(String key)
public Schema getPropertiesOrThrow(String key)Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT.
map<string, .google.cloud.aiplatform.v1beta1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
Schema |
|
getPropertyOrdering(int index)
public String getPropertyOrdering(int index)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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The propertyOrdering at the given index. |
getPropertyOrderingBytes(int index)
public ByteString getPropertyOrderingBytes(int index)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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the propertyOrdering at the given index. |
getPropertyOrderingCount()
public int getPropertyOrderingCount()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];
| Returns | |
|---|---|
| Type | Description |
int |
The count of propertyOrdering. |
getPropertyOrderingList()
public ProtocolStringList getPropertyOrderingList()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];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the propertyOrdering. |
getRef()
public String getRef() Optional. Allows indirect references between schema nodes. The value should
be a valid reference to a child of the root defs.
For example, the following schema defines a reference to a schema node named "Pet":
type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string
The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
string ref = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The ref. |
getRefBytes()
public ByteString getRefBytes() Optional. Allows indirect references between schema nodes. The value should
be a valid reference to a child of the root defs.
For example, the following schema defines a reference to a schema node named "Pet":
type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string
The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring
string ref = 27 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for ref. |
getRequired(int index)
public String getRequired(int index)Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The required at the given index. |
getRequiredBytes(int 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 |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the required at the given index. |
getRequiredCount()
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. |
getRequiredList()
public ProtocolStringList getRequiredList()Optional. Required properties of Type.OBJECT.
repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the required. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
getTitle()
public String getTitle()Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public ByteString getTitleBytes()Optional. The title of the Schema.
string title = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getType()
public Type getType()Optional. The type of the data.
.google.cloud.aiplatform.v1beta1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Type |
The type. |
getTypeValue()
public int getTypeValue()Optional. The type of the data.
.google.cloud.aiplatform.v1beta1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for type. |
hasAdditionalProperties()
public boolean hasAdditionalProperties()Optional. Can either be a boolean or an object; controls the presence of additional properties.
.google.protobuf.Value additional_properties = 26 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the additionalProperties field is set. |
hasDefault()
public boolean hasDefault()Optional. Default value of the data.
.google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the default field is set. |
hasExample()
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. |
hasItems()
public boolean hasItems()Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY.
.google.cloud.aiplatform.v1beta1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the items field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public Schema.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Schema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused |
UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object |
|
toBuilder()
public Schema.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
Schema.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|