Package com.google.cloud.aiplatform.v1

Interface SchemaOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Schema, Schema.Builder
@Generated public interface SchemaOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • 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 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];
      Returns:
      A list containing the enum.

    • getEnumCount

      int getEnumCount()
       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];
      Returns:
      The count of enum.

    • getEnum

      String getEnum(int index)
       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];
      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 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];
      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];

    • getPropertyOrderingList

      List<String> 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:
      A list containing the propertyOrdering.

    • getPropertyOrderingCount

      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:
      The count of propertyOrdering.

    • getPropertyOrdering

      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];
      Parameters:
      index - The index of the element to return.
      Returns:
      The propertyOrdering at the given index.

    • getPropertyOrderingBytes

      com.google.protobuf.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];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the propertyOrdering at the given index.

    • 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];

    • getAnyOfList

      List<Schema> getAnyOfList()
       Optional. The value should be validated against any (one or more) of the
 subschemas in the list.
      repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getAnyOf

      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.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getAnyOfCount

      int getAnyOfCount()
       Optional. The value should be validated against any (one or more) of the
 subschemas in the list.
      repeated .google.cloud.aiplatform.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getAnyOfOrBuilderList

      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.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

    • getAnyOfOrBuilder

      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.v1.Schema any_of = 11 [(.google.api.field_behavior) = OPTIONAL];

    • hasAdditionalProperties

      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:
      Whether the additionalProperties field is set.

    • getAdditionalProperties

      com.google.protobuf.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:
      The additionalProperties.

    • getAdditionalPropertiesOrBuilder

      com.google.protobuf.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];

    • getRef

      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:
      The ref.

    • getRefBytes

      com.google.protobuf.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:
      The bytes for ref.

    • getDefsCount

      int getDefsCount()
       Optional. A map of definitions for use by `ref`
 Only allowed at the root of the schema.
      map<string, .google.cloud.aiplatform.v1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];

    • containsDefs

      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.v1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDefs

      @Deprecated Map<String,Schema> getDefs()
      Deprecated.
      Use getDefsMap() instead.

    • getDefsMap

      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.v1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDefsOrDefault

      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.v1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDefsOrThrow

      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.v1.Schema> defs = 28 [(.google.api.field_behavior) = OPTIONAL];