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.



2719
2720
2721
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2719

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

Instance Attribute Details

#field_configsArray<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaFieldConfig>

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



2699
2700
2701
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2699

def field_configs
  @field_configs
end

#json_schemaString

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

Returns:

  • (String)


2704
2705
2706
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2704

def json_schema
  @json_schema
end

#nameString

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)


2712
2713
2714
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2712

def name
  @name
end

#struct_schemaHash<String,Object>

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

Returns:

  • (Hash<String,Object>)


2717
2718
2719
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2717

def struct_schema
  @struct_schema
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2724
2725
2726
2727
2728
2729
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2724

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