Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSchema

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

Overview

Defines the structure and layout of a type of document data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSchema

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSchema.



2573
2574
2575
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2573

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

Instance Attribute Details

#field_configs ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFieldConfig>

Output only. Configurations for fields of the schema. Corresponds to the JSON property fieldConfigs

Returns:



2553
2554
2555
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2553

def field_configs
  @field_configs
end

#json_schema ⇒ String

The JSON representation of the schema. Corresponds to the JSON property jsonSchema

Returns:

  • (String) 


2558
2559
2560
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2558

def json_schema
  @json_schema
end

#name ⇒ String

Immutable. The full resource name of the schema, in the format of projects/ project/locations/location/collections/collection/dataStores/data_store/ schemas/schema`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Corresponds to the JSON propertyname`

Returns:

  • (String) 


2566
2567
2568
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2566

def name
  @name
end

#struct_schema ⇒ Hash<String,Object>

The structured representation of the schema. Corresponds to the JSON property structSchema

Returns:

  • (Hash<String,Object>) 


2571
2572
2573
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2571

def struct_schema
  @struct_schema
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2578
2579
2580
2581
2582
2583
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2578

def update!(**args)
  @field_configs = args[:field_configs] if args.key?(:field_configs)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @name = args[:name] if args.key?(:name)
  @struct_schema = args[:struct_schema] if args.key?(:struct_schema)
end