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

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) ⇒ GoogleCloudAiplatformV1Schema

Returns a new instance of GoogleCloudAiplatformV1Schema.



35439
35440
35441
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35439

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) 


35283
35284
35285
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35283

def additional_properties
  @additional_properties
end

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

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:



35289
35290
35291
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35289

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) 


35294
35295
35296
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35294

def default
  @default
end

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

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:



35300
35301
35302
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35300

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) 


35308
35309
35310
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35308

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>) 


35318
35319
35320
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35318

def enum
  @enum
end

#example ⇒ Object

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

Returns:

  • (Object) 


35323
35324
35325
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35323

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) 


35331
35332
35333
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35331

def format
  @format
end

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

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:



35337
35338
35339
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35337

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) 


35343
35344
35345
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35343

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) 


35349
35350
35351
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35349

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) 


35355
35356
35357
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35355

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) 


35361
35362
35363
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35361

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) 


35367
35368
35369
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35367

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) 


35373
35374
35375
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35373

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) 


35379
35380
35381
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35379

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) 


35385
35386
35387
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35385

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) 


35390
35391
35392
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35390

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) 


35397
35398
35399
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35397

def pattern
  @pattern
end

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

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:



35403
35404
35405
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35403

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>) 


35410
35411
35412
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35410

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) 


35421
35422
35423
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35421

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>) 


35427
35428
35429
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35427

def required
  @required
end

#title ⇒ String

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

Returns:

  • (String) 


35432
35433
35434
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35432

def title
  @title
end

#type ⇒ String

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

Returns:

  • (String) 


35437
35438
35439
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35437

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



35444
35445
35446
35447
35448
35449
35450
35451
35452
35453
35454
35455
35456
35457
35458
35459
35460
35461
35462
35463
35464
35465
35466
35467
35468
35469
35470
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 35444

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