Google Cloud Discovery Engine V1 Client - Class CreateEngineRequest (1.5.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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ parentstring

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

↳ engineEngine

Required. The Engine to create.

↳ engine_idstring

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

setParent

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

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getEngine

Required. The Engine to create.

Returns
TypeDescription
Engine|null

hasEngine

clearEngine

setEngine

Required. The Engine to create.

Parameter
NameDescription
varEngine
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
varstring
Returns
TypeDescription
$this

static::build

Parameters
NameDescription
parentstring

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

engineEngine

Required. The Engine to create.

engineIdstring

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