Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Schema

Returns a new instance of GoogleCloudAiplatformV1Schema.



27945
27946
27947
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27945

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_properties ⇒ Object

Optional. Can either be a boolean or an object; controls the presence of additional properties. Corresponds to the JSON property additionalProperties

Returns:

  • (Object) 


27803
27804
27805
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27803

def additional_properties
  @additional_properties
end

#any_of ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema>

Optional. The value should be validated against any (one or more) of the subschemas in the list. Corresponds to the JSON property anyOf

Returns:



27809
27810
27811
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27809

def any_of
  @any_of
end

#default ⇒ Object

Optional. Default value of the data. Corresponds to the JSON property default

Returns:

  • (Object) 


27814
27815
27816
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27814

def default
  @default
end

#defs ⇒ Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema>

Optional. A map of definitions for use by ref Only allowed at the root of the schema. Corresponds to the JSON property defs

Returns:



27820
27821
27822
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27820

def defs
  @defs
end

#description ⇒ String

Optional. The description of the data. Corresponds to the JSON property description

Returns:

  • (String) 


27825
27826
27827
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27825

def description
  @description
end

#enum ⇒ Array<String>

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"] Corresponds to the JSON property enum

Returns:

  • (Array<String>) 


27833
27834
27835
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27833

def enum
  @enum
end

#example ⇒ Object

Optional. Example of the object. Will only populated when the object is the root. Corresponds to the JSON property example

Returns:

  • (Object) 


27839
27840
27841
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27839

def example
  @example
end

#format ⇒ String

Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc Corresponds to the JSON property format

Returns:

  • (String) 


27846
27847
27848
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27846

def format
  @format
end

#items ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema

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. Corresponds to the JSON property items

Returns:



27853
27854
27855
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27853

def items
  @items
end

#max_items ⇒ Fixnum

Optional. Maximum number of the elements for Type.ARRAY. Corresponds to the JSON property maxItems

Returns:

  • (Fixnum) 


27858
27859
27860
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27858

def max_items
  @max_items
end

#max_length ⇒ Fixnum

Optional. Maximum length of the Type.STRING Corresponds to the JSON property maxLength

Returns:

  • (Fixnum) 


27863
27864
27865
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27863

def max_length
  @max_length
end

#max_properties ⇒ Fixnum

Optional. Maximum number of the properties for Type.OBJECT. Corresponds to the JSON property maxProperties

Returns:

  • (Fixnum) 


27868
27869
27870
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27868

def max_properties
  @max_properties
end

#maximum ⇒ Float

Optional. Maximum value of the Type.INTEGER and Type.NUMBER Corresponds to the JSON property maximum

Returns:

  • (Float) 


27873
27874
27875
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27873

def maximum
  @maximum
end

#min_items ⇒ Fixnum

Optional. Minimum number of the elements for Type.ARRAY. Corresponds to the JSON property minItems

Returns:

  • (Fixnum) 


27878
27879
27880
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27878

def min_items
  @min_items
end

#min_length ⇒ Fixnum

Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING Corresponds to the JSON property minLength

Returns:

  • (Fixnum) 


27883
27884
27885
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27883

def min_length
  @min_length
end

#min_properties ⇒ Fixnum

Optional. Minimum number of the properties for Type.OBJECT. Corresponds to the JSON property minProperties

Returns:

  • (Fixnum) 


27888
27889
27890
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27888

def min_properties
  @min_properties
end

#minimum ⇒ Float

Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type. INTEGER and Type.NUMBER Corresponds to the JSON property minimum

Returns:

  • (Float) 


27894
27895
27896
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27894

def minimum
  @minimum
end

#nullable ⇒ Boolean Also known as: nullable?

Optional. Indicates if the value may be null. Corresponds to the JSON property nullable

Returns:

  • (Boolean) 


27899
27900
27901
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27899

def nullable
  @nullable
end

#pattern ⇒ String

Optional. Pattern of the Type.STRING to restrict a string to a regular expression. Corresponds to the JSON property pattern

Returns:

  • (String) 


27906
27907
27908
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27906

def pattern
  @pattern
end

#properties ⇒ Hash<String,Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schema>

Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. Corresponds to the JSON property properties

Returns:



27911
27912
27913
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27911

def properties
  @properties
end

#property_ordering ⇒ Array<String>

Optional. The order of the properties. Not a standard field in open api spec. Only used to support the order of the properties. Corresponds to the JSON property propertyOrdering

Returns:

  • (Array<String>) 


27917
27918
27919
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27917

def property_ordering
  @property_ordering
end

#ref ⇒ String

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 Corresponds to the JSON property ref

Returns:

  • (String) 


27928
27929
27930
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27928

def ref
  @ref
end

#required ⇒ Array<String>

Optional. Required properties of Type.OBJECT. Corresponds to the JSON property required

Returns:

  • (Array<String>) 


27933
27934
27935
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27933

def required
  @required
end

#title ⇒ String

Optional. The title of the Schema. Corresponds to the JSON property title

Returns:

  • (String) 


27938
27939
27940
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27938

def title
  @title
end

#type ⇒ String

Optional. The type of the data. Corresponds to the JSON property type

Returns:

  • (String) 


27943
27944
27945
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27943

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27950
27951
27952
27953
27954
27955
27956
27957
27958
27959
27960
27961
27962
27963
27964
27965
27966
27967
27968
27969
27970
27971
27972
27973
27974
27975
27976
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 27950

def update!(**args)
  @additional_properties = args[:additional_properties] if args.key?(:additional_properties)
  @any_of = args[:any_of] if args.key?(:any_of)
  @default = args[:default] if args.key?(:default)
  @defs = args[:defs] if args.key?(:defs)
  @description = args[:description] if args.key?(:description)
  @enum = args[:enum] if args.key?(:enum)
  @example = args[:example] if args.key?(:example)
  @format = args[:format] if args.key?(:format)
  @items = args[:items] if args.key?(:items)
  @max_items = args[:max_items] if args.key?(:max_items)
  @max_length = args[:max_length] if args.key?(:max_length)
  @max_properties = args[:max_properties] if args.key?(:max_properties)
  @maximum = args[:maximum] if args.key?(:maximum)
  @min_items = args[:min_items] if args.key?(:min_items)
  @min_length = args[:min_length] if args.key?(:min_length)
  @min_properties = args[:min_properties] if args.key?(:min_properties)
  @minimum = args[:minimum] if args.key?(:minimum)
  @nullable = args[:nullable] if args.key?(:nullable)
  @pattern = args[:pattern] if args.key?(:pattern)
  @properties = args[:properties] if args.key?(:properties)
  @property_ordering = args[:property_ordering] if args.key?(:property_ordering)
  @ref = args[:ref] if args.key?(:ref)
  @required = args[:required] if args.key?(:required)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end