Required. Standard field mask for the set of fields to be updated.
↳ migrate_traffic
bool
Set totrueto gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for bothwarmup requestsandautomatic scaling. You must specify theshardByfield in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, seeMigrating and Splitting Traffic.
getName
Name of the resource to update. Example:apps/myapp/services/default.
Returns
Type
Description
string
setName
Name of the resource to update. Example:apps/myapp/services/default.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getService
A Service resource containing the updated service. Only fields set in the
field mask will be updated.
Set totrueto gradually shift traffic to one or more versions that you
specify. By default, traffic is shifted immediately.
For gradual traffic migration, the target versions
must be located within instances that are configured for bothwarmup requestsandautomatic scaling.
You must specify theshardByfield in the Service resource. Gradual traffic migration is not
supported in the App Engine flexible environment. For examples, seeMigrating and Splitting Traffic.
Returns
Type
Description
bool
setMigrateTraffic
Set totrueto gradually shift traffic to one or more versions that you
specify. By default, traffic is shifted immediately.
For gradual traffic migration, the target versions
must be located within instances that are configured for bothwarmup requestsandautomatic scaling.
You must specify theshardByfield in the Service resource. Gradual traffic migration is not
supported in the App Engine flexible environment. For examples, seeMigrating and Splitting Traffic.
[[["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 Appengine Admin V1 Client - Class UpdateServiceRequest (2.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.4 (latest)](/php/docs/reference/cloud-appengine-admin/latest/V1.UpdateServiceRequest)\n- [2.0.3](/php/docs/reference/cloud-appengine-admin/2.0.3/V1.UpdateServiceRequest)\n- [1.3.5](/php/docs/reference/cloud-appengine-admin/1.3.5/V1.UpdateServiceRequest)\n- [1.2.2](/php/docs/reference/cloud-appengine-admin/1.2.2/V1.UpdateServiceRequest)\n- [1.1.1](/php/docs/reference/cloud-appengine-admin/1.1.1/V1.UpdateServiceRequest)\n- [1.0.6](/php/docs/reference/cloud-appengine-admin/1.0.6/V1.UpdateServiceRequest) \nReference documentation and code samples for the Google Cloud Appengine Admin V1 Client class UpdateServiceRequest.\n\nRequest message for `Services.UpdateService`.\n\nGenerated from protobuf message `google.appengine.v1.UpdateServiceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AppEngine \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nName of the resource to update. Example: `apps/myapp/services/default`.\n\n### setName\n\nName of the resource to update. Example: `apps/myapp/services/default`.\n\n### getService\n\nA Service resource containing the updated service. Only fields set in the\nfield mask will be updated.\n\n### hasService\n\n### clearService\n\n### setService\n\nA Service resource containing the updated service. Only fields set in the\nfield mask will be updated.\n\n### getUpdateMask\n\nRequired. Standard field mask for the set of fields to be updated.\n\n### hasUpdateMask\n\n### clearUpdateMask\n\n### setUpdateMask\n\nRequired. Standard field mask for the set of fields to be updated.\n\n### getMigrateTraffic\n\nSet to `true` to gradually shift traffic to one or more versions that you\nspecify. By default, traffic is shifted immediately.\n\nFor gradual traffic migration, the target versions\nmust be located within instances that are configured for both\n[warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)\nand\n[automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).\nYou must specify the\n[`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)\nfield in the Service resource. Gradual traffic migration is not\nsupported in the App Engine flexible environment. For examples, see\n[Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).\n\n### setMigrateTraffic\n\nSet to `true` to gradually shift traffic to one or more versions that you\nspecify. By default, traffic is shifted immediately.\n\nFor gradual traffic migration, the target versions\nmust be located within instances that are configured for both\n[warmup requests](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#InboundServiceType)\nand\n[automatic scaling](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#AutomaticScaling).\nYou must specify the\n[`shardBy`](https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#ShardBy)\nfield in the Service resource. Gradual traffic migration is not\nsupported in the App Engine flexible environment. For examples, see\n[Migrating and Splitting Traffic](https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic)."]]
