Google Cloud Appengine Admin V1 Client - Class UpdateServiceRequest (1.2.2)

Reference documentation and code samples for the Google Cloud Appengine Admin V1 Client class UpdateServiceRequest.

Request message for Services.UpdateService.

Generated from protobuf message google.appengine.v1.UpdateServiceRequest

Namespace

Google \ Cloud \ AppEngine \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Name of the resource to update. Example: `apps/myapp/services/default`.
`↳ service`	`Google\Cloud\AppEngine\V1\Service` A Service resource containing the updated service. Only fields set in the field mask will be updated.
`↳ update_mask`	`Google\Protobuf\FieldMask` Required. Standard field mask for the set of fields to be updated.
`↳ migrate_traffic`	`bool` Set to `true` to 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 both warmup requests and automatic scaling. You must specify the `shardBy` field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating 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.

Returns
Type	Description
`Google\Cloud\AppEngine\V1\Service\|null`

hasService

clearService

setService

A Service resource containing the updated service. Only fields set in the field mask will be updated.

Parameter
Name	Description
`var`	`Google\Cloud\AppEngine\V1\Service`

Returns
Type	Description
`$this`

getUpdateMask

Required. Standard field mask for the set of fields to be updated.

Returns
Type	Description
`Google\Protobuf\FieldMask\|null`

hasUpdateMask

clearUpdateMask

setUpdateMask

Required. Standard field mask for the set of fields to be updated.

Parameter
Name	Description
`var`	`Google\Protobuf\FieldMask`

Returns
Type	Description
`$this`

getMigrateTraffic

Set to true to 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 both warmup requests and automatic scaling. You must specify the shardBy field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic.

Returns
Type	Description
`bool`

setMigrateTraffic

Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`