- 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 interface SchemaOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsProperties(String key)
public abstract 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 | 
        |
getDefault()
public abstract Value getDefault()Optional. Default value of the data.
 .google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
Value | 
        The default.  | 
      
getDefaultOrBuilder()
public abstract ValueOrBuilder getDefaultOrBuilder()Optional. Default value of the data.
 .google.protobuf.Value default = 23 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
ValueOrBuilder | 
        |
getDescription()
public abstract String getDescription()Optional. The description of the data.
 string description = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The description.  | 
      
getDescriptionBytes()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 | |
|---|---|
| Type | Description | 
List<String> | 
        A list containing the enum.  | 
      
getExample()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean getNullable()Optional. Indicates if the value may be null.
 bool nullable = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        The nullable.  | 
      
getPattern()
public abstract 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 abstract 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 abstract Map<String,Schema> getProperties()Use #getPropertiesMap() instead.
| Returns | |
|---|---|
| Type | Description | 
Map<String,Schema> | 
        |
getPropertiesCount()
public abstract 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 abstract 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 abstract 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 abstract 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 | 
        |
getRequired(int index)
public abstract 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 abstract 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 abstract 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 abstract List<String> getRequiredList()Optional. Required properties of Type.OBJECT.
 repeated string required = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
List<String> | 
        A list containing the required.  | 
      
getTitle()
public abstract String getTitle()Optional. The title of the Schema.
 string title = 24 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The title.  | 
      
getTitleBytes()
public abstract 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 abstract 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 abstract 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.  | 
      
hasDefault()
public abstract 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 abstract 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 abstract 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.  |