Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Schema (v0.21.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Schema.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#json_schema

def json_schema() -> ::String
Returns
  • (::String) — The JSON representation of the schema.

    Note: The following fields are mutually exclusive: json_schema, struct_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

#json_schema=

def json_schema=(value) -> ::String
Parameter
  • value (::String) — The JSON representation of the schema.

    Note: The following fields are mutually exclusive: json_schema, struct_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::String) — The JSON representation of the schema.

    Note: The following fields are mutually exclusive: json_schema, struct_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.

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

#struct_schema

def struct_schema() -> ::Google::Protobuf::Struct
Returns
  • (::Google::Protobuf::Struct) — The structured representation of the schema.

    Note: The following fields are mutually exclusive: struct_schema, json_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

#struct_schema=

def struct_schema=(value) -> ::Google::Protobuf::Struct
Parameter
  • value (::Google::Protobuf::Struct) — The structured representation of the schema.

    Note: The following fields are mutually exclusive: struct_schema, json_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns
  • (::Google::Protobuf::Struct) — The structured representation of the schema.

    Note: The following fields are mutually exclusive: struct_schema, json_schema. If a field in that set is populated, all other fields in the set will automatically be cleared.