Google Cloud Discovery Engine V1 Client - Class Schema (0.5.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Schema.

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

Generated from protobuf message google.cloud.discoveryengine.v1.Schema

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ struct_schema Google\Protobuf\Struct

The structured representation of the schema.

↳ json_schema string

The JSON representation of the schema.

↳ 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.

getStructSchema

The structured representation of the schema.

Returns
TypeDescription
Google\Protobuf\Struct|null

hasStructSchema

setStructSchema

The structured representation of the schema.

Parameter
NameDescription
var Google\Protobuf\Struct
Returns
TypeDescription
$this

getJsonSchema

The JSON representation of the schema.

Returns
TypeDescription
string

hasJsonSchema

setJsonSchema

The JSON representation of the schema.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

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
TypeDescription
string

setName

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSchema

Returns
TypeDescription
string