Gemini Enterprise for Customer Experience V1 API - Class Google::Cloud::Ces::V1::Schema (v0.1.0)

Reference documentation and code samples for the Gemini Enterprise for Customer Experience V1 API class Google::Cloud::Ces::V1::Schema.

Represents a select subset of an OpenAPI 3.0 schema object.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#additional_properties

def additional_properties() -> ::Google::Cloud::Ces::V1::Schema

Returns

• (::Google::Cloud::Ces::V1::Schema) — Optional. Can either be a boolean or an object, controls the presence of additional properties.

#additional_properties=

def additional_properties=(value) -> ::Google::Cloud::Ces::V1::Schema

Parameter

• value (::Google::Cloud::Ces::V1::Schema) — Optional. Can either be a boolean or an object, controls the presence of additional properties.

Returns

• (::Google::Cloud::Ces::V1::Schema) — Optional. Can either be a boolean or an object, controls the presence of additional properties.

#any_of

def any_of() -> ::Array<::Google::Cloud::Ces::V1::Schema>

Returns

• (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. The value should be validated against any (one or more) of the subschemas in the list.

#any_of=

def any_of=(value) -> ::Array<::Google::Cloud::Ces::V1::Schema>

Parameter

• value (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. The value should be validated against any (one or more) of the subschemas in the list.

Returns

• (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. The value should be validated against any (one or more) of the subschemas in the list.

#default

def default() -> ::Google::Protobuf::Value

Returns

• (::Google::Protobuf::Value) — Optional. Default value of the data.

#default=

def default=(value) -> ::Google::Protobuf::Value

Parameter

• value (::Google::Protobuf::Value) — Optional. Default value of the data.

Returns

• (::Google::Protobuf::Value) — Optional. Default value of the data.

#defs

def defs() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

#defs=

def defs=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. A map of definitions for use by ref. Only allowed at the root of the schema.

#description

def description() -> ::String

Returns

• (::String) — Optional. The description of the data.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — Optional. The description of the data.

Returns

• (::String) — Optional. The description of the data.

#enum

def enum() -> ::Array<::String>

Returns

• (::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"]}

#enum=

def enum=(value) -> ::Array<::String>

Parameter

• value (::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"]}

Returns

• (::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"]}

#items

def items() -> ::Google::Cloud::Ces::V1::Schema

Returns

• (::Google::Cloud::Ces::V1::Schema) — Optional. Schema of the elements of Type.ARRAY.

#items=

def items=(value) -> ::Google::Cloud::Ces::V1::Schema

Parameter

• value (::Google::Cloud::Ces::V1::Schema) — Optional. Schema of the elements of Type.ARRAY.

Returns

• (::Google::Cloud::Ces::V1::Schema) — Optional. Schema of the elements of Type.ARRAY.

#max_items

def max_items() -> ::Integer

Returns

• (::Integer) — Optional. Maximum number of the elements for Type.ARRAY.

#max_items=

def max_items=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. Maximum number of the elements for Type.ARRAY.

Returns

• (::Integer) — Optional. Maximum number of the elements for Type.ARRAY.

#maximum

def maximum() -> ::Float

Returns

• (::Float) — Optional. Maximum value for Type.INTEGER and Type.NUMBER.

#maximum=

def maximum=(value) -> ::Float

Parameter

• value (::Float) — Optional. Maximum value for Type.INTEGER and Type.NUMBER.

Returns

• (::Float) — Optional. Maximum value for Type.INTEGER and Type.NUMBER.

#min_items

def min_items() -> ::Integer

Returns

• (::Integer) — Optional. Minimum number of the elements for Type.ARRAY.

#min_items=

def min_items=(value) -> ::Integer

Parameter

• value (::Integer) — Optional. Minimum number of the elements for Type.ARRAY.

Returns

• (::Integer) — Optional. Minimum number of the elements for Type.ARRAY.

#minimum

def minimum() -> ::Float

Returns

• (::Float) — Optional. Minimum value for Type.INTEGER and Type.NUMBER.

#minimum=

def minimum=(value) -> ::Float

Parameter

• value (::Float) — Optional. Minimum value for Type.INTEGER and Type.NUMBER.

Returns

• (::Float) — Optional. Minimum value for Type.INTEGER and Type.NUMBER.

#nullable

def nullable() -> ::Boolean

Returns

• (::Boolean) — Optional. Indicates if the value may be null.

#nullable=

def nullable=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Indicates if the value may be null.

Returns

• (::Boolean) — Optional. Indicates if the value may be null.

#prefix_items

def prefix_items() -> ::Array<::Google::Cloud::Ces::V1::Schema>

Returns

• (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. Schemas of initial elements of Type.ARRAY.

#prefix_items=

def prefix_items=(value) -> ::Array<::Google::Cloud::Ces::V1::Schema>

Parameter

• value (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. Schemas of initial elements of Type.ARRAY.

Returns

• (::Array<::Google::Cloud::Ces::V1::Schema>) — Optional. Schemas of initial elements of Type.ARRAY.

#properties

def properties() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. Properties of Type.OBJECT.

#properties=

def properties=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. Properties of Type.OBJECT.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Ces::V1::Schema}) — Optional. Properties of Type.OBJECT.

#ref

def ref() -> ::String

Returns

• (::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.

#ref=

def ref=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#required

def required() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. Required properties of Type.OBJECT.

#required=

def required=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. Required properties of Type.OBJECT.

Returns

• (::Array<::String>) — Optional. Required properties of Type.OBJECT.

#title

def title() -> ::String

Returns

• (::String) — Optional. The title of the schema.

#title=

def title=(value) -> ::String

Parameter

• value (::String) — Optional. The title of the schema.

Returns

• (::String) — Optional. The title of the schema.

#type

def type() -> ::Google::Cloud::Ces::V1::Schema::Type

Returns

• (::Google::Cloud::Ces::V1::Schema::Type) — Required. The type of the data.

#type=

def type=(value) -> ::Google::Cloud::Ces::V1::Schema::Type

Parameter

• value (::Google::Cloud::Ces::V1::Schema::Type) — Required. The type of the data.

Returns

• (::Google::Cloud::Ces::V1::Schema::Type) — Required. The type of the data.

#unique_items

def unique_items() -> ::Boolean

Returns

• (::Boolean) — Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

#unique_items=

def unique_items=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.

Returns

• (::Boolean) — Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.