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

Required. The Engine to create.
↳ 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
Engine|null

hasEngine

clearEngine

setEngine

Required. The Engine to create.

Parameter
Name Description
var Engine
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 EngineServiceClient::collectionName() for help formatting this field.
engine Engine

Required. The Engine to create.
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.
Returns
Type Description
CreateEngineRequest