Google Cloud Discovery Engine V1 Client - Class CreateSchemaRequest (1.0.0)

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

Request message for SchemaService.CreateSchema method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

↳ schemaGoogle\Cloud\DiscoveryEngine\V1\Schema

Required. The Schema to create.

↳ schema_idstring

Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to RFC-1034 standard with a length limit of 63 characters.

getParent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Returns
TypeDescription
string

setParent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getSchema

Required. The Schema to create.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\Schema|null

hasSchema

clearSchema

setSchema

Required. The Schema to create.

Parameter
NameDescription
varGoogle\Cloud\DiscoveryEngine\V1\Schema
Returns
TypeDescription
$this

getSchemaId

Required. The ID to use for the Schema, which becomes the final component of the Schema.name.

This field should conform to RFC-1034 standard with a length limit of 63 characters.

Returns
TypeDescription
string

setSchemaId

Required. The ID to use for the Schema, which becomes the final component of the Schema.name.

This field should conform to RFC-1034 standard with a length limit of 63 characters.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. Please see Google\Cloud\DiscoveryEngine\V1\SchemaServiceClient::dataStoreName() for help formatting this field.

schemaGoogle\Cloud\DiscoveryEngine\V1\Schema

Required. The Schema to create.

schemaIdstring

Required. The ID to use for the Schema, which becomes the final component of the Schema.name.

This field should conform to RFC-1034 standard with a length limit of 63 characters.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\CreateSchemaRequest