Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CustomTuningModel.
Metadata that describes a custom tuned model.
Generated from protobuf messagegoogle.cloud.discoveryengine.v1.CustomTuningModel
Namespace
Google \ Cloud \ DiscoveryEngine \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ name
string
Required. The fully qualified resource name of the model. Format:projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}. Model must be an alpha-numerical string with limit of 40 characters.
↳ display_name
string
The display name of the model.
↳ model_version
int|string
The version of the model.
↳ model_state
int
The state that the model is in (e.g.TRAININGorTRAINING_FAILED).
Currently this is only populated if the model state isINPUT_VALIDATION_FAILED.
getName
Required. The fully qualified resource name of the model.
Format:projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
Returns
Type
Description
string
setName
Required. The fully qualified resource name of the model.
Format:projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}.
Model must be an alpha-numerical string with limit of 40 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDisplayName
The display name of the model.
Returns
Type
Description
string
setDisplayName
The display name of the model.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getModelVersion
The version of the model.
Returns
Type
Description
int|string
setModelVersion
The version of the model.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getModelState
The state that the model is in (e.g.TRAININGorTRAINING_FAILED).
Returns
Type
Description
int
setModelState
The state that the model is in (e.g.TRAININGorTRAINING_FAILED).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Discovery Engine V1 Client - Class CustomTuningModel (1.7.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.7.0 (latest)](/php/docs/reference/cloud-discoveryengine/latest/V1.CustomTuningModel)\n- [1.6.1](/php/docs/reference/cloud-discoveryengine/1.6.1/V1.CustomTuningModel)\n- [1.5.1](/php/docs/reference/cloud-discoveryengine/1.5.1/V1.CustomTuningModel)\n- [1.4.0](/php/docs/reference/cloud-discoveryengine/1.4.0/V1.CustomTuningModel)\n- [1.3.3](/php/docs/reference/cloud-discoveryengine/1.3.3/V1.CustomTuningModel)\n- [1.2.0](/php/docs/reference/cloud-discoveryengine/1.2.0/V1.CustomTuningModel)\n- [1.1.0](/php/docs/reference/cloud-discoveryengine/1.1.0/V1.CustomTuningModel)\n- [1.0.0](/php/docs/reference/cloud-discoveryengine/1.0.0/V1.CustomTuningModel)\n- [0.11.3](/php/docs/reference/cloud-discoveryengine/0.11.3/V1.CustomTuningModel)\n- [0.8.0](/php/docs/reference/cloud-discoveryengine/0.8.0/V1.CustomTuningModel)\n- [0.7.1](/php/docs/reference/cloud-discoveryengine/0.7.1/V1.CustomTuningModel)\n- [0.6.0](/php/docs/reference/cloud-discoveryengine/0.6.0/V1.CustomTuningModel)\n- [0.5.0](/php/docs/reference/cloud-discoveryengine/0.5.0/V1.CustomTuningModel)\n- [0.4.0](/php/docs/reference/cloud-discoveryengine/0.4.0/V1.CustomTuningModel)\n- [0.3.0](/php/docs/reference/cloud-discoveryengine/0.3.0/V1.CustomTuningModel)\n- [0.2.0](/php/docs/reference/cloud-discoveryengine/0.2.0/V1.CustomTuningModel)\n- [0.1.1](/php/docs/reference/cloud-discoveryengine/0.1.1/V1.CustomTuningModel) \nReference documentation and code samples for the Google Cloud Discovery Engine V1 Client class CustomTuningModel.\n\nMetadata that describes a custom tuned model.\n\nGenerated from protobuf message `google.cloud.discoveryengine.v1.CustomTuningModel`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ DiscoveryEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The fully qualified resource name of the model.\n\nFormat:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.\nModel must be an alpha-numerical string with limit of 40 characters.\n\n### setName\n\nRequired. The fully qualified resource name of the model.\n\nFormat:\n`projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`.\nModel must be an alpha-numerical string with limit of 40 characters.\n\n### getDisplayName\n\nThe display name of the model.\n\n### setDisplayName\n\nThe display name of the model.\n\n### getModelVersion\n\nThe version of the model.\n\n### setModelVersion\n\nThe version of the model.\n\n### getModelState\n\nThe state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).\n\n### setModelState\n\nThe state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).\n\n### getCreateTime\n\nDeprecated: Timestamp the Model was created at.\n\n### hasCreateTime\n\n### clearCreateTime\n\n### setCreateTime\n\nDeprecated: Timestamp the Model was created at.\n\n### getTrainingStartTime\n\nTimestamp the model training was initiated.\n\n### hasTrainingStartTime\n\n### clearTrainingStartTime\n\n### setTrainingStartTime\n\nTimestamp the model training was initiated.\n\n### getMetrics\n\nThe metrics of the trained model.\n\n### setMetrics\n\nThe metrics of the trained model.\n\n### getErrorMessage\n\nCurrently this is only populated if the model state is\n`INPUT_VALIDATION_FAILED`.\n\n### setErrorMessage\n\nCurrently this is only populated if the model state is\n`INPUT_VALIDATION_FAILED`."]]
