Reference documentation and code samples for the Google Cloud Retail V2 Client class PeriodicTuningState.
Describes whether periodic tuning is enabled for this model
or not. Periodic tuning is scheduled at most every three months. You can
start a tuning process manually by using the TuneModel
method, which starts a tuning process immediately and resets the quarterly
schedule. Enabling or disabling periodic tuning does not affect any
current tuning processes.
Protobuf type google.cloud.retail.v2.Model.PeriodicTuningState
Namespace
Google \ Cloud \ Retail \ V2 \ Model
Methods
static::name
Parameter
Name
Description
value
mixed
static::value
Parameter
Name
Description
name
mixed
Constants
PERIODIC_TUNING_STATE_UNSPECIFIED
Value: 0
Unspecified default value, should never be explicitly set.
Generated from protobuf enum PERIODIC_TUNING_STATE_UNSPECIFIED = 0;
PERIODIC_TUNING_DISABLED
Value: 1
The model has periodic tuning disabled. Tuning
can be reenabled by calling the EnableModelPeriodicTuning
method or by calling the TuneModel method.
Generated from protobuf enum PERIODIC_TUNING_DISABLED = 1;
ALL_TUNING_DISABLED
Value: 3
The model cannot be tuned with periodic tuning OR the
TuneModel method. Hide the options in customer UI and
reject any requests through the backend self serve API.
Generated from protobuf enum ALL_TUNING_DISABLED = 3;
PERIODIC_TUNING_ENABLED
Value: 2
The model has periodic tuning enabled. Tuning
can be disabled by calling the DisableModelPeriodicTuning
method.
Generated from protobuf enum PERIODIC_TUNING_ENABLED = 2;
[[["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 Retail V2 Client - Class PeriodicTuningState (2.3.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.3.1 (latest)](/php/docs/reference/cloud-retail/latest/V2.Model.PeriodicTuningState)\n- [2.3.0](/php/docs/reference/cloud-retail/2.3.0/V2.Model.PeriodicTuningState)\n- [2.2.1](/php/docs/reference/cloud-retail/2.2.1/V2.Model.PeriodicTuningState)\n- [2.1.3](/php/docs/reference/cloud-retail/2.1.3/V2.Model.PeriodicTuningState)\n- [2.0.0](/php/docs/reference/cloud-retail/2.0.0/V2.Model.PeriodicTuningState)\n- [1.7.0](/php/docs/reference/cloud-retail/1.7.0/V2.Model.PeriodicTuningState)\n- [1.6.4](/php/docs/reference/cloud-retail/1.6.4/V2.Model.PeriodicTuningState)\n- [1.5.0](/php/docs/reference/cloud-retail/1.5.0/V2.Model.PeriodicTuningState)\n- [1.4.2](/php/docs/reference/cloud-retail/1.4.2/V2.Model.PeriodicTuningState)\n- [1.3.1](/php/docs/reference/cloud-retail/1.3.1/V2.Model.PeriodicTuningState)\n- [1.2.1](/php/docs/reference/cloud-retail/1.2.1/V2.Model.PeriodicTuningState)\n- [1.1.1](/php/docs/reference/cloud-retail/1.1.1/V2.Model.PeriodicTuningState)\n- [1.0.1](/php/docs/reference/cloud-retail/1.0.1/V2.Model.PeriodicTuningState) \nReference documentation and code samples for the Google Cloud Retail V2 Client class PeriodicTuningState.\n\nDescribes whether periodic tuning is enabled for this model\nor not. Periodic tuning is scheduled at most every three months. You can\nstart a tuning process manually by using the `TuneModel`\nmethod, which starts a tuning process immediately and resets the quarterly\nschedule. Enabling or disabling periodic tuning does not affect any\ncurrent tuning processes.\n\nProtobuf type `google.cloud.retail.v2.Model.PeriodicTuningState`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Retail \\\\ V2 \\\\ Model\n\nMethods\n-------\n\n### static::name\n\n### static::value\n\nConstants\n---------\n\n### PERIODIC_TUNING_STATE_UNSPECIFIED\n\n Value: 0\n\nUnspecified default value, should never be explicitly set.\n\nGenerated from protobuf enum `PERIODIC_TUNING_STATE_UNSPECIFIED = 0;`\n\n### PERIODIC_TUNING_DISABLED\n\n Value: 1\n\nThe model has periodic tuning disabled. Tuning\ncan be reenabled by calling the `EnableModelPeriodicTuning`\nmethod or by calling the `TuneModel` method.\n\nGenerated from protobuf enum `PERIODIC_TUNING_DISABLED = 1;`\n\n### ALL_TUNING_DISABLED\n\n Value: 3\n\nThe model cannot be tuned with periodic tuning OR the\n`TuneModel` method. Hide the options in customer UI and\nreject any requests through the backend self serve API.\n\nGenerated from protobuf enum `ALL_TUNING_DISABLED = 3;`\n\n### PERIODIC_TUNING_ENABLED\n\n Value: 2\n\nThe model has periodic tuning enabled. Tuning\ncan be disabled by calling the `DisableModelPeriodicTuning`\nmethod.\n\nGenerated from protobuf enum `PERIODIC_TUNING_ENABLED = 2;`"]]