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.



18832
18833
18834
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18832

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

Instance Attribute Details

#description ⇒ String

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

Returns:

  • (String) 


18783
18784
18785
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18783

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


18790
18791
18792
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18790

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) 


18796
18797
18798
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18796

def example
  @example
end

#format ⇒ String

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

Returns:

  • (String) 


18802
18803
18804
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18802

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:



18809
18810
18811
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18809

def items
  @items
end

#nullable ⇒ Boolean Also known as: nullable?

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

Returns:

  • (Boolean) 


18814
18815
18816
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18814

def nullable
  @nullable
end

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

Optional. Properties of Type.OBJECT. Corresponds to the JSON property properties

Returns:



18820
18821
18822
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18820

def properties
  @properties
end

#required ⇒ Array<String>

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

Returns:

  • (Array<String>) 


18825
18826
18827
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18825

def required
  @required
end

#type ⇒ String

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

Returns:

  • (String) 


18830
18831
18832
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18830

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 18837

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