Google Cloud Discovery Engine V1beta Client - Class PauseEngineRequest (0.11.3)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class PauseEngineRequest.

Request for pausing training of an engine.

Generated from protobuf message google.cloud.discoveryengine.v1beta.PauseEngineRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the engine to pause. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}

getName

Required. The name of the engine to pause.

Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}

Returns
Type Description
string

setName

Required. The name of the engine to pause.

Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. The name of the engine to pause. Format: projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id} Please see Google\Cloud\DiscoveryEngine\V1beta\EngineServiceClient::engineName() for help formatting this field.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1beta\PauseEngineRequest