SchemaOrBuilder (proto-google-cloud-aiplatform-v1 3.44.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Schema, Schema.Builder
```
public interface SchemaOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsProperties(String key)` Optional.
`com.google.protobuf.Value`	`getDefault()` Optional.
`com.google.protobuf.ValueOrBuilder`	`getDefaultOrBuilder()` Optional.
`String`	`getDescription()` Optional.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` Optional.
`String`	`getEnum(int index)` Optional.
`com.google.protobuf.ByteString`	`getEnumBytes(int index)` Optional.
`int`	`getEnumCount()` Optional.
`List<String>`	`getEnumList()` Optional.
`com.google.protobuf.Value`	`getExample()` Optional.
`com.google.protobuf.ValueOrBuilder`	`getExampleOrBuilder()` Optional.
`String`	`getFormat()` Optional.
`com.google.protobuf.ByteString`	`getFormatBytes()` Optional.
`Schema`	`getItems()` Optional.
`SchemaOrBuilder`	`getItemsOrBuilder()` Optional.
`double`	`getMaximum()` Optional.
`long`	`getMaxItems()` Optional.
`long`	`getMaxLength()` Optional.
`long`	`getMaxProperties()` Optional.
`double`	`getMinimum()` Optional.
`long`	`getMinItems()` Optional.
`long`	`getMinLength()` Optional.
`long`	`getMinProperties()` Optional.
`boolean`	`getNullable()` Optional.
`String`	`getPattern()` Optional.
`com.google.protobuf.ByteString`	`getPatternBytes()` Optional.
`Map<String,Schema>`	`getProperties()` Deprecated.
`int`	`getPropertiesCount()` Optional.
`Map<String,Schema>`	`getPropertiesMap()` Optional.
`Schema`	`getPropertiesOrDefault(String key, Schema defaultValue)` Optional.
`Schema`	`getPropertiesOrThrow(String key)` Optional.
`String`	`getRequired(int index)` Optional.
`com.google.protobuf.ByteString`	`getRequiredBytes(int index)` Optional.
`int`	`getRequiredCount()` Optional.
`List<String>`	`getRequiredList()` Optional.
`String`	`getTitle()` Optional.
`com.google.protobuf.ByteString`	`getTitleBytes()` Optional.
`Type`	`getType()` Optional.
`int`	`getTypeValue()` Optional.
`boolean`	`hasDefault()` Optional.
`boolean`	`hasExample()` Optional.
`boolean`	`hasItems()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - getTypeValue
```
int getTypeValue()
```
```
 Optional. The type of the data.
 
```
    .google.cloud.aiplatform.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The enum numeric value on the wire for type.
  - getType
```
Type getType()
```
```
 Optional. The type of the data.
 
```
    .google.cloud.aiplatform.v1.Type type = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The type.
  - getFormat
```
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:
    
    The format.
  - getFormatBytes
```
com.google.protobuf.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:
    
    The bytes for format.
  - getTitle
```
String getTitle()
```
```
 Optional. The title of the Schema.
 
```
    string title = 24 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The title.
  - getTitleBytes
```
com.google.protobuf.ByteString getTitleBytes()
```
```
 Optional. The title of the Schema.
 
```
    string title = 24 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The bytes for title.
  - getDescription
```
String getDescription()
```
```
 Optional. The description of the data.
 
```
    string description = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The description.
  - getDescriptionBytes
```
com.google.protobuf.ByteString getDescriptionBytes()
```
```
 Optional. The description of the data.
 
```
    string description = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The bytes for description.
  - getNullable
```
boolean getNullable()
```
```
 Optional. Indicates if the value may be null.
 
```
    bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The nullable.
  - hasDefault
```
boolean hasDefault()
```
```
 Optional. Default value of the data.
 
```
    .google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the default field is set.
  - getDefault
```
com.google.protobuf.Value getDefault()
```
```
 Optional. Default value of the data.
 
```
    .google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The default.
  - getDefaultOrBuilder
```
com.google.protobuf.ValueOrBuilder getDefaultOrBuilder()
```
```
 Optional. Default value of the data.
 
```
    .google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
  - hasItems
```
boolean hasItems()
```
```
 Optional. SCHEMA FIELDS FOR TYPE ARRAY
 Schema of the elements of Type.ARRAY.
 
```
    .google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the items field is set.
  - getItems
```
Schema getItems()
```
```
 Optional. SCHEMA FIELDS FOR TYPE ARRAY
 Schema of the elements of Type.ARRAY.
 
```
    .google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The items.
  - getItemsOrBuilder
```
SchemaOrBuilder getItemsOrBuilder()
```
```
 Optional. SCHEMA FIELDS FOR TYPE ARRAY
 Schema of the elements of Type.ARRAY.
 
```
    .google.cloud.aiplatform.v1.Schema items = 2 [(.google.api.field_behavior) = OPTIONAL];
  - getMinItems
```
long getMinItems()
```
```
 Optional. Minimum number of the elements for Type.ARRAY.
 
```
    int64 min_items = 21 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The minItems.
  - getMaxItems
```
long getMaxItems()
```
```
 Optional. Maximum number of the elements for Type.ARRAY.
 
```
    int64 max_items = 22 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The maxItems.
  - getEnumList
```
List<String> 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:
    
    A list containing the enum.
  - getEnumCount
```
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:
    
    The count of enum.
  - getEnum
```
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];
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The enum at the given index.
  - getEnumBytes
```
com.google.protobuf.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];
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the enum at the given index.
  - getPropertiesCount
```
int getPropertiesCount()
```
```
 Optional. SCHEMA FIELDS FOR TYPE OBJECT
 Properties of Type.OBJECT.
 
```
    map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
  - containsProperties
```
boolean containsProperties(String key)
```
```
 Optional. SCHEMA FIELDS FOR TYPE OBJECT
 Properties of Type.OBJECT.
 
```
    map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getProperties
```
@Deprecated
Map<String,Schema> getProperties()
```
    Deprecated.
    
    Use getPropertiesMap() instead.
  - getPropertiesMap
```
Map<String,Schema> getPropertiesMap()
```
```
 Optional. SCHEMA FIELDS FOR TYPE OBJECT
 Properties of Type.OBJECT.
 
```
    map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getPropertiesOrDefault
```
Schema getPropertiesOrDefault(String key,
                              Schema defaultValue)
```
```
 Optional. SCHEMA FIELDS FOR TYPE OBJECT
 Properties of Type.OBJECT.
 
```
    map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getPropertiesOrThrow
```
Schema getPropertiesOrThrow(String key)
```
```
 Optional. SCHEMA FIELDS FOR TYPE OBJECT
 Properties of Type.OBJECT.
 
```
    map<string, .google.cloud.aiplatform.v1.Schema> properties = 3 [(.google.api.field_behavior) = OPTIONAL];
  - getRequiredList
```
List<String> getRequiredList()
```
```
 Optional. Required properties of Type.OBJECT.
 
```
    repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    A list containing the required.
  - getRequiredCount
```
int getRequiredCount()
```
```
 Optional. Required properties of Type.OBJECT.
 
```
    repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The count of required.
  - getRequired
```
String getRequired(int index)
```
```
 Optional. Required properties of Type.OBJECT.
 
```
    repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The required at the given index.
  - getRequiredBytes
```
com.google.protobuf.ByteString getRequiredBytes(int index)
```
```
 Optional. Required properties of Type.OBJECT.
 
```
    repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the required at the given index.
  - getMinProperties
```
long getMinProperties()
```
```
 Optional. Minimum number of the properties for Type.OBJECT.
 
```
    int64 min_properties = 14 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The minProperties.
  - getMaxProperties
```
long getMaxProperties()
```
```
 Optional. Maximum number of the properties for Type.OBJECT.
 
```
    int64 max_properties = 15 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The maxProperties.
  - getMinimum
```
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:
    
    The minimum.
  - getMaximum
```
double getMaximum()
```
```
 Optional. Maximum value of the Type.INTEGER and Type.NUMBER
 
```
    double maximum = 17 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The maximum.
  - getMinLength
```
long getMinLength()
```
```
 Optional. SCHEMA FIELDS FOR TYPE STRING
 Minimum length of the Type.STRING
 
```
    int64 min_length = 18 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The minLength.
  - getMaxLength
```
long getMaxLength()
```
```
 Optional. Maximum length of the Type.STRING
 
```
    int64 max_length = 19 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The maxLength.
  - getPattern
```
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:
    
    The pattern.
  - getPatternBytes
```
com.google.protobuf.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:
    
    The bytes for pattern.
  - hasExample
```
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:
    
    Whether the example field is set.
  - getExample
```
com.google.protobuf.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:
    
    The example.
  - getExampleOrBuilder
```
com.google.protobuf.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];

Interface SchemaOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

getTypeValue

getType

getFormat

getFormatBytes

getTitle

getTitleBytes

getDescription

getDescriptionBytes

getNullable

hasDefault

getDefault

getDefaultOrBuilder

hasItems

getItems

getItemsOrBuilder

getMinItems

getMaxItems

getEnumList

getEnumCount

getEnum

getEnumBytes

getPropertiesCount

containsProperties

getProperties

getPropertiesMap

getPropertiesOrDefault

getPropertiesOrThrow

getRequiredList

getRequiredCount

getRequired

getRequiredBytes

getMinProperties

getMaxProperties

getMinimum

getMaximum

getMinLength

getMaxLength

getPattern

getPatternBytes

hasExample

getExample

getExampleOrBuilder