Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema

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

Overview

Defines the schema of input and output data. This is a subset of the OpenAPI 3.0 Schema Object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1Schema

Returns a new instance of GoogleCloudAiplatformV1beta1Schema.



50524
50525
50526
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50524

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

Instance Attribute Details

#additional_properties ⇒ Object

Optional. If type is OBJECT, specifies how to handle properties not defined in properties. If it is a boolean false, no additional properties are allowed. If it is a schema, additional properties are allowed if they conform to the schema. Corresponds to the JSON property additionalProperties

Returns:

  • (Object) 


50368
50369
50370
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50368

def additional_properties
  @additional_properties
end

#any_of ⇒ Array<Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema>

Optional. The instance must be valid against any (one or more) of the subschemas listed in any_of. Corresponds to the JSON property anyOf

Returns:



50374
50375
50376
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50374

def any_of
  @any_of
end

#default ⇒ Object

Optional. Default value to use if the field is not specified. Corresponds to the JSON property default

Returns:

  • (Object) 


50379
50380
50381
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50379

def default
  @default
end

#defs ⇒ Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema>

Optional. defs provides a map of schema definitions that can be reused by ref elsewhere in the schema. Only allowed at root level of the schema. Corresponds to the JSON property defs

Returns:



50385
50386
50387
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50385

def defs
  @defs
end

#description ⇒ String

Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt. Corresponds to the JSON property description

Returns:

  • (String) 


50393
50394
50395
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50393

def description
  @description
end

#enum ⇒ Array<String>

Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set format to enum and provide the list of possible values in enum. For example: 1. To define directions: type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"] 2. To define apartment numbers: type:INTEGER, format:enum, enum:[" 101", "201", "301"] Corresponds to the JSON property enum

Returns:

  • (Array<String>) 


50403
50404
50405
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50403

def enum
  @enum
end

#example ⇒ Object

Optional. Example of an instance of this schema. Corresponds to the JSON property example

Returns:

  • (Object) 


50408
50409
50410
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50408

def example
  @example
end

#format ⇒ String

Optional. The format of the data. For NUMBER type, format can be float or double. For INTEGER type, format can be int32 or int64. For STRING type, format can be email, byte, date, date-time, password, and other formats to further refine the data type. Corresponds to the JSON property format

Returns:

  • (String) 


50416
50417
50418
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50416

def format
  @format
end

#items ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema

Defines the schema of input and output data. This is a subset of the OpenAPI 3.0 Schema Object. Corresponds to the JSON property items

Returns:



50422
50423
50424
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50422

def items
  @items
end

#max_items ⇒ Fixnum

Optional. If type is ARRAY, max_items specifies the maximum number of items in an array. Corresponds to the JSON property maxItems

Returns:

  • (Fixnum) 


50428
50429
50430
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50428

def max_items
  @max_items
end

#max_length ⇒ Fixnum

Optional. If type is STRING, max_length specifies the maximum length of the string. Corresponds to the JSON property maxLength

Returns:

  • (Fixnum) 


50434
50435
50436
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50434

def max_length
  @max_length
end

#max_properties ⇒ Fixnum

Optional. If type is OBJECT, max_properties specifies the maximum number of properties that can be provided. Corresponds to the JSON property maxProperties

Returns:

  • (Fixnum) 


50440
50441
50442
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50440

def max_properties
  @max_properties
end

#maximum ⇒ Float

Optional. If type is INTEGER or NUMBER, maximum specifies the maximum allowed value. Corresponds to the JSON property maximum

Returns:

  • (Float) 


50446
50447
50448
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50446

def maximum
  @maximum
end

#min_items ⇒ Fixnum

Optional. If type is ARRAY, min_items specifies the minimum number of items in an array. Corresponds to the JSON property minItems

Returns:

  • (Fixnum) 


50452
50453
50454
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50452

def min_items
  @min_items
end

#min_length ⇒ Fixnum

Optional. If type is STRING, min_length specifies the minimum length of the string. Corresponds to the JSON property minLength

Returns:

  • (Fixnum) 


50458
50459
50460
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50458

def min_length
  @min_length
end

#min_properties ⇒ Fixnum

Optional. If type is OBJECT, min_properties specifies the minimum number of properties that can be provided. Corresponds to the JSON property minProperties

Returns:

  • (Fixnum) 


50464
50465
50466
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50464

def min_properties
  @min_properties
end

#minimum ⇒ Float

Optional. If type is INTEGER or NUMBER, minimum specifies the minimum allowed value. Corresponds to the JSON property minimum

Returns:

  • (Float) 


50470
50471
50472
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50470

def minimum
  @minimum
end

#nullable ⇒ Boolean Also known as: nullable?

Optional. Indicates if the value of this field can be null. Corresponds to the JSON property nullable

Returns:

  • (Boolean) 


50475
50476
50477
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50475

def nullable
  @nullable
end

#pattern ⇒ String

Optional. If type is STRING, pattern specifies a regular expression that the string must match. Corresponds to the JSON property pattern

Returns:

  • (String) 


50482
50483
50484
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50482

def pattern
  @pattern
end

#properties ⇒ Hash<String,Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema>

Optional. If type is OBJECT, properties is a map of property names to schema definitions for each property of the object. Corresponds to the JSON property properties

Returns:



50488
50489
50490
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50488

def properties
  @properties
end

#property_ordering ⇒ Array<String>

Optional. Order of properties displayed or used where order matters. This is not a standard field in OpenAPI specification, but can be used to control the order of properties. Corresponds to the JSON property propertyOrdering

Returns:

  • (Array<String>) 


50495
50496
50497
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50495

def property_ordering
  @property_ordering
end

#ref ⇒ String

Optional. Allows referencing another schema definition to use in place of this schema. The value must be a valid reference to a schema in 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) 


50506
50507
50508
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50506

def ref
  @ref
end

#required ⇒ Array<String>

Optional. If type is OBJECT, required lists the names of properties that must be present. Corresponds to the JSON property required

Returns:

  • (Array<String>) 


50512
50513
50514
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50512

def required
  @required
end

#title ⇒ String

Optional. Title for the schema. Corresponds to the JSON property title

Returns:

  • (String) 


50517
50518
50519
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50517

def title
  @title
end

#type ⇒ String

Optional. Data type of the schema field. Corresponds to the JSON property type

Returns:

  • (String) 


50522
50523
50524
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50522

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



50529
50530
50531
50532
50533
50534
50535
50536
50537
50538
50539
50540
50541
50542
50543
50544
50545
50546
50547
50548
50549
50550
50551
50552
50553
50554
50555
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 50529

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