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.



21509
21510
21511
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21509

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

Instance Attribute Details

#default ⇒ Object

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

Returns:

  • (Object) 


21402
21403
21404
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21402

def default
  @default
end

#description ⇒ String

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

Returns:

  • (String) 


21407
21408
21409
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21407

def description
  @description
end

#enum ⇒ Array<String>

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

Returns:

  • (Array<String>) 


21414
21415
21416
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21414

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) 


21420
21421
21422
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21420

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) 


21427
21428
21429
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21427

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:



21434
21435
21436
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21434

def items
  @items
end

#max_items ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21439
21440
21441
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21439

def max_items
  @max_items
end

#max_length ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21444
21445
21446
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21444

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) 


21449
21450
21451
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21449

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) 


21454
21455
21456
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21454

def maximum
  @maximum
end

#min_items ⇒ Fixnum

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

Returns:

  • (Fixnum) 


21459
21460
21461
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21459

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) 


21464
21465
21466
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21464

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) 


21469
21470
21471
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21469

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) 


21475
21476
21477
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21475

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) 


21480
21481
21482
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21480

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) 


21487
21488
21489
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21487

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:



21492
21493
21494
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21492

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


21497
21498
21499
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21497

def required
  @required
end

#title ⇒ String

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

Returns:

  • (String) 


21502
21503
21504
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21502

def title
  @title
end

#type ⇒ String

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

Returns:

  • (String) 


21507
21508
21509
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21507

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 21514

def update!(**args)
  @default = args[:default] if args.key?(:default)
  @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)
  @required = args[:required] if args.key?(:required)
  @title = args[:title] if args.key?(:title)
  @type = args[:type] if args.key?(:type)
end