Google Cloud Discovery Engine V1 Client - Class CreateEngineRequest (1.2.0)

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

Request for EngineService.CreateEngine method.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection} .

↳ engine
↳ engine_id
string

Required. The ID to use for the Engine , which will become the final component of the Engine 's resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

getParent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection} .

Returns
Type
Description
string

setParent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection} .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEngine

Required. The Engine to create.

Returns
Type
Description

hasEngine

clearEngine

setEngine

Required. The Engine to create.

Parameter
Name
Description
Returns
Type
Description
$this

getEngineId

Required. The ID to use for the Engine , which will become the final component of the Engine 's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type
Description
string

setEngineId

Required. The ID to use for the Engine , which will become the final component of the Engine 's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameters
Name
Description
parent
string

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection} . Please see Google\Cloud\DiscoveryEngine\V1\EngineServiceClient::collectionName() for help formatting this field.

engine
engineId
string

Required. The ID to use for the Engine , which will become the final component of the Engine 's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Design a Mobile Site
View Site in Mobile | Classic
Share by: